调试容器化应用

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 调试
• 故障排除