调试容器化应用

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

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

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

要求

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

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

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

Node.js

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

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

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

Python

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

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

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

.NET

您可以选择两种方式在容器内构建和调试您的项目：

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

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

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

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

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

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

配置参考

dockerServerReadyAction 对象属性

node 对象属性

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

python 对象属性

netCore 对象属性

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

后续步骤

继续阅读以了解更多信息

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