在容器中调试 .NET
先决条件
-
安装 .NET SDK,其中包含对附加到 .NET 调试器的支持。使用 .NET SDK 7 或更高版本,你可以选择无需 Dockerfile 进行调试。
-
安装 Visual Studio Code C# 扩展,其中包括通过 VS Code 附加到 .NET 调试器的支持。
-
仅限 macOS 用户:将
/usr/local/share/dotnet/sdk/NuGetFallbackFolder
添加为 Docker 首选项中的共享文件夹。
演练
- 如果需要,使用
dotnet new
创建一个 .NET 项目。 - 在 VS Code 中打开项目文件夹。
- 可选,设置一个断点。
.NET SDK 与 Dockerfile 构建
在容器中构建和调试应用程序有两种方法:使用 Dockerfile,或者(对于 .NET 7 及更高版本)不使用 Dockerfile。
.NET SDK 容器构建(无需 Dockerfile
调试)
此选项支持 Web 项目,并且当 Docker 设置为使用 Linux 容器时可用。
- 按下 F5 或从“运行”菜单中选择“启动调试”。(如果你在
launch.json
中有任何现有启动配置文件,可以使用 ⌘/ (Windows、Linux Ctrl+/) 将它们注释掉) - 系统将提示你一个调试器列表。选择“容器:在容器中调试”
- 当提示你使用
Dockerfile
构建(“使用 Dockerfile”)或使用 .NET SDK 构建(“使用 .NET SDK”)时,选择“使用 .NET SDK”。 - 如果工作区中有多个项目文件,请选择与要调试的项目关联的项目文件。如果构建成功,.NET 应用程序将在容器中运行,并且 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
调试
-
等待直到出现通知,询问你是否要添加调试所需的资产。选择“是”
-
打开命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 并输入“容器:将 Docker 文件添加到工作区...”。如果你已经将应用程序容器化,则可以改为执行“容器:初始化容器调试”。按照提示操作。
-
切换到“运行和调试”视图 (⇧⌘D (Windows, Linux Ctrl+Shift+D))。
-
选择“容器:.NET 启动”启动配置。
-
开始调试!(F5)
运行和调试支持 SSL
要启用 SSL(使用 HTTPS 协议),你需要对配置进行一些更改。
-
在 Dockerfile 中,在基本部分添加一个
EXPOSE
行,为 HTTPS / SSL 定义一个单独的端口。保留一个单独的EXPOSE
行,使用不同的端口用于 HTTP 请求。FROM mcr.microsoft.com/dotnet/aspnet:5.0 AS base WORKDIR /app EXPOSE 5000 EXPOSE 5001
-
在
.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 时都提示你从项目文件列表中进行选择),你可以通过以下步骤保存你的启动配置文件:
-
按照 .NET SDK 容器构建 中的步骤操作,并保持调试会话处于活动状态。
-
单击调试器视图中的“
齿轮
”图标。 -
选择“容器:在容器中调试”
-
选择与你要调试的项目关联的项目文件
你的项目首选项已保存,并且你不再需要在 F5 时选择项目文件。