在容器中调试 .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 vs. 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 时选择项目文件