🚀 在 VS Code 中

在容器中调试 .NET

先决条件

  1. 安装 .NET SDK,其中包括对附加到 .NET 调试器的支持。使用 .NET SDK 7 或更高版本,您可以选择在没有 Dockerfile 的情况下进行调试。

  2. 安装 Visual Studio Code C# 扩展,其中包括对使用 VS Code 附加到 .NET 调试器的支持。

  3. 仅 macOS 用户:在 Docker 首选项中添加 /usr/local/share/dotnet/sdk/NuGetFallbackFolder 作为共享文件夹。

    dockerSharedFolders

演练

  • 如果需要,使用 dotnet new 创建 .NET 项目。
  • 在 VS Code 中打开项目文件夹。
  • (可选)设置断点。

.NET SDK 与 Dockerfile 构建

有两种方法可以在容器内构建和调试您的应用程序:使用 Dockerfile,或者对于 .NET 7 及更高版本,不使用 Dockerfile。

.NET SDK 容器构建(不使用 Dockerfile 进行调试)

Web 项目支持此选项,并且当 Docker 设置为使用 Linux 容器时可用。

  1. F5 或从“运行”菜单中选择“启动调试”。(如果您在 launch.json 中有任何现有的启动配置文件,您可以使用 ⌘/(Windows、Linux Ctrl+/ 将它们注释掉)
  2. 系统会提示您选择调试器列表。选择“Docker:在容器中调试
  3. 当系统提示您选择使用 Dockerfile 构建(“使用 Dockerfile”)还是使用 .NET SDK 构建(“使用 .NET SDK”)时,选择“使用 .NET SDK”。
  4. 如果您的工作区中有多个项目文件,请选择与您要调试的项目关联的项目文件。如果构建成功,您的 .NET 应用程序将在 Docker 容器中运行,并且 Web 应用程序将在浏览器中打开。

注意:支持的 .NET SDK 版本:默认情况下,此功能适用于 .NET SDK 7.0.300 及更高版本。对于 7.0.100 到 7.0.300 之间的版本,请使用 dotnet add package Microsoft.NET.Build.Containers 启用它。您可以在 Microsoft Learn 上阅读有关 .NET SDK 容器构建的更多信息。

使用 Dockerfile 调试

  1. 等待直到出现通知,询问您是否要添加调试所需的资产。选择“

    csharpPrompt

  2. 打开命令面板(⇧⌘P(Windows、Linux Ctrl+Shift+P),然后输入“Docker:将 Docker 文件添加到工作区...”。如果您已经 Docker 化了您的应用程序,您可以改为执行“Docker:初始化 Docker 调试”。按照提示操作。

  3. 切换到“运行和调试”视图(⇧⌘D(Windows、Linux Ctrl+Shift+D)。

  4. 选择“Docker .NET Core 启动”启动配置。

  5. 开始调试!(F5

使用 SSL 支持运行和调试

要启用 SSL(使用 HTTPS 协议),您需要对配置进行一些更改。

  1. 在 Dockerfile 中,在基本部分添加一个 EXPOSE 行,以定义 HTTPS / SSL 的单独端口。为 HTTP 请求保留一个单独的 EXPOSE 行,并使用不同的端口号。

    FROM mcr.microsoft.com/dotnet/aspnet:5.0 AS base
    WORKDIR /app
    EXPOSE 5000
    EXPOSE 5001
    
  2. .vscode/tasks.json 文件中,将 configureSsl: true 添加到 netCore 部分。此外,在 docker-run: debug 任务的 dockerRun 部分中添加环境变量 ASPNETCORE_URLS,并使用您在 Dockerfile 中定义的相同端口号

    dockerRun: {
        "env": {
           "ASPNETCORE_URLS": "https://+:5001;http://+:5000"
       }
     }
     netCore: {
         "appProject": "${workspacefolder}/MyProject.csproj",
         "enableDebugging": true,
         "configureSsl": true
     }
    

有关其他自定义选项,请参阅有关 任务调试容器化应用程序 的文档。

为 .NET SDK 容器构建保存项目文件首选项

如果您有一个包含多个 .NET 项目文件的工作区文件夹,并且您只想专门调试一个特定项目(而无需在每次按 F5 时都提示您从项目文件列表中选择),您可以按照以下步骤保存您的启动配置文件

  1. 按照 .NET SDK 容器构建 中的步骤操作,并保持调试会话处于活动状态。

  2. 单击调试器视图中的 齿轮 图标。

    dockerSharedFolders

  3. 选择“Docker:在容器中调试

  4. 选择与您要调试的项目关联的项目文件

您的项目首选项已保存,您不再需要在按 F5 时选择项目文件