调试容器化应用

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

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

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

要求

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

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

我们建议使用 **Containers: Add Docker Files to Workspace...** 命令来创建这些项（如果这些资产尚不存在）。如果您已有可用的 Dockerfile，我们建议使用 **Containers: Initialize for container debugging** 命令来生成启动配置和与容器相关的任务。

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