调试容器化应用程序

Docker 扩展为在 Docker 容器内调试应用程序提供了更多支持，例如为将调试器附加到在容器内运行的应用程序创建 launch.json 配置。

Docker 扩展提供了一个 docker 调试配置提供程序，该提供程序管理 VS Code 如何启动应用程序和/或将调试器附加到正在运行的 Docker 容器中的应用程序。此提供程序通过 launch.json 中的条目进行配置，配置特定于提供程序支持的每个应用程序平台。

Docker 扩展当前支持在 Docker 容器内调试 Node.js、Python 和 .NET 应用程序。

需求

将启动配置构建或粘贴到 launch.json 中 **不足以** 构建和调试 Docker 容器。要成功运行 Docker 启动配置，您必须具有

• Dockerfile。
• tasks.json 中的 docker-build 和 docker-run 任务。
• 调用这些任务的启动配置。

我们建议使用 **Docker: 将 Docker 文件添加到工作区...** 命令来创建这些项，如果这些资产不存在。如果您已经有一个功能性的 Dockerfile，我们建议使用 **Docker: 初始化 Docker 调试** 命令来构建启动配置和 Docker 相关任务。

Node.js

有关在 Docker 容器内调试 Node.js 应用程序的更多信息，请参阅 在容器内调试 Node.js。

用于调试 Node.js 应用程序的 launch.json 配置示例

{
  "configurations": [
    {
      "name": "Docker Node.js Launch",
      "type": "docker",
      "request": "launch",
      "preLaunchTask": "docker-run: debug",
      "platform": "node"
    }
  ]
}

Python

有关在 Docker 容器内调试 Python 应用程序的更多信息，请参阅 在容器内调试 Python。

用于调试 Python 应用程序的 launch.json 配置示例

{
  "configurations": [
    {
      "name": "Docker: Python - Django",
      "type": "docker",
      "request": "launch",
      "preLaunchTask": "docker-run: debug",
      "python": {
        "pathMappings": [
          {
            "localRoot": "${workspaceFolder}",
            "remoteRoot": "/app"
          }
        ],
        "projectType": "django"
      }
    }
  ]
}

.NET

您可以选择两种方法在 Docker 容器内构建和调试项目

• **使用 .NET SDK**：如果您熟悉 MSBuild 或想要在没有 Dockerfile 的情况下容器化项目，这是推荐的选择。

  **注意**：此选项仅适用于 .NET SDK 7 及更高版本，并使用 dotnet publish 命令构建镜像。

• **使用 Dockerfile**：如果您更喜欢使用 Dockerfile 自定义项目，请选择此选项。

有关这两个选项的更多详细信息，请参阅 在 Docker 容器内调试 .NET。

用于调试使用 Dockerfile 的 .NET 应用程序的 launch.json 配置示例

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch .NET Core in Docker",
      "type": "docker",
      "request": "launch",
      "preLaunchTask": "Run Docker Container",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

配置参考

dockerServerReadyAction 对象属性

node 对象属性

这些属性与 VS Code 文档 中描述的用于将调试器附加到 Node.js 应用程序的属性相同。即使未在下面列出，传递到 node 对象中的所有属性都将传递到 Node.js 调试适配器。

python 对象属性

netCore 对象属性

传递给 netCore 对象的属性通常会传递给 .NET 调试适配器，即使下面没有特别列出。调试属性的完整列表可以在 OmniSharp VS Code 扩展文档 中找到。

后续步骤

继续阅读以了解有关以下内容的更多信息

• 在 Docker 容器内调试 Node.js
• 在 Docker 容器内调试 Python
• 在 Docker 容器内调试 .NET
• 使用 Docker Compose 进行调试
• 故障排除