在 VS Code 中试用

调试容器化应用

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

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

容器工具扩展目前支持调试容器内的 Node.jsPython.NET 应用程序。

要求

将启动配置搭建或粘贴到 launch.json不足以构建和调试容器。要成功运行容器启动配置,您必须具备:

  • 一个 Dockerfile。
  • tasks.json 中有 docker-builddocker-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"
      }
    }
  ]
}

配置参考

属性 描述
containerName 用于调试的容器名称。
dockerServerReadyAction 用于向容器启动浏览器的选项。类似于 serverReadyAction,但将容器端口替换为主机端口。
removeContainerAfterDebug 调试后是否移除调试容器。
platform 应用程序的目标平台。可以是 netCorenode
netCore 在容器中调试 .NET 项目的选项。
node 在容器中调试 Node.js 项目的选项。
python 在容器中调试 Python 项目的选项。

dockerServerReadyAction 对象属性

属性 描述
action 找到模式时要执行的操作。可以是 debugWithChromeopenExternally
containerName 用于匹配主机端口的容器名称。
pattern 在调试控制台输出中查找的正则表达式模式。
uriFormat 要启动的 URI 格式。
webRoot 提供网页的根文件夹。仅当 action 设置为 debugWithChrome 时使用。

node 对象属性

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

属性 描述 默认值
port 可选。要使用的调试端口。 9229
address 可选。调试端口的 TCP/IP 地址。
sourceMaps 可选。通过将其设置为 true 来启用源映射。
outFiles 可选。用于定位生成的 JavaScript 文件的 glob 模式数组。
autoAttachChildProcesses 可选。跟踪被调试程序的所有子进程,并自动附加到以调试模式启动的子进程。
timeout 可选。重新启动会话时,在此毫秒数后放弃。
stopOnEntry 可选。程序启动时立即中断。
localRoot 可选。VS Code 的根目录。 根工作区文件夹。
remoteRoot 可选。容器中 Node 的根目录。 /usr/src/app
smartStep 可选。尝试自动跳过未映射到源文件的代码。
skipFiles 可选。自动跳过由这些 glob 模式覆盖的文件。
trace 可选。启用诊断输出。

python 对象属性

属性 描述 默认值
host 用于远程调试的主机。
port 用于远程调试的端口。 5678
pathMappings 映射本地机器和远程主机之间的项目路径。
projectType 您的 Python 项目类型,flask 用于 Flask 项目,django 用于 Django,fastapi 用于 FastAPI,其他为 general。项目类型将用于设置调试所用的端口和命令。
justMyCode 仅调试用户编写的代码。
django Django 调试。 false
jinja Jinja 模板调试(例如 Flask)。 false

netCore 对象属性

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

属性 描述
appProject 要调试的 .NET 项目(.csproj、.fsproj 等)。

后续步骤

继续阅读以了解更多关于