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