📼 重温 MS Build 2026 上的 VS Code Live

使用 Docker Compose

Docker Compose 提供了一种编排多个协同工作容器的方法。例如处理请求的服务和前端网站，或者使用 Redis 缓存等支持功能的服务。如果你在应用开发中使用微服务模型，可以使用 Docker Compose 将应用代码拆分为多个通过 Web 请求进行通信的独立运行服务。本文将帮助你为 Node.js、Python 或 .NET 等应用启用 Docker Compose，并指导你在 Visual Studio Code 中为这些场景配置调试。

此外，对于单容器场景，使用 Docker Compose 提供了单个 Dockerfile 所不具备的独立于工具的配置方式。诸如容器卷挂载、端口映射和环境变量等配置设置都可以在 docker-compose YML 文件中进行声明。

要在 VS Code 中使用容器工具（Container Tools）扩展来使用 Docker Compose，你应该已经熟悉 Docker Compose 的基础知识。

为项目添加 Docker Compose 支持

如果你已经有一个或多个 Dockerfile，可以通过打开命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)），并使用 Containers: Add Docker Compose Files to Workspace 命令来添加 Docker Compose 文件。按照提示操作。

你还可以在添加 Dockerfile 的同时将 Docker Compose 文件添加到工作区：打开命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）并使用 Containers: Add Docker Files to Workspace 命令。系统会询问你是否要添加 Docker Compose 文件。如果你想保留现有的 Dockerfile，请在提示是否覆盖 Dockerfile 时选择 No。

Container Tools 扩展会向你的工作区添加 docker-compose.yml 文件。此文件包含在生产环境中按预期启动容器所需的配置。在某些情况下，还会生成 docker-compose.debug.yml。该文件提供了一个启用了调试器的简化启动模式。

Screenshot of project with docker-compose files

VS Code Container Tools 扩展生成的文件开箱即用，但你也可以对其进行自定义以针对你的场景进行优化。然后，你可以使用 Containers: Compose Up 命令（右键单击 docker-compose.yml 文件，或在命令面板中查找该命令）一次性启动所有内容。你还可以在 VS Code 的命令提示符或终端窗口中使用 docker-compose up 命令来启动容器。有关如何配置 Docker Compose 行为以及有哪些命令行选项可用，请参考 Docker Compose 文档。

有了 docker-compose 文件后，你现在可以在 docker-compose 文件中指定端口映射，而不是在 .json 配置文件中。有关示例，请参阅 Docker Compose 文档。

提示：使用 Docker Compose 时，请勿指定主机端口。相反，让 Docker 选择一个随机的可用端口，以自动避免端口冲突问题。

向项目中添加新容器

如果你想添加另一个应用或服务，可以再次运行 Containers: Add Docker Compose Files to Workspace，并选择覆盖现有的 docker-compose 文件，但这会导致你丢失这些文件中的任何自定义内容。如果你想保留对 compose 文件的更改，可以手动修改 docker-compose.yml 文件以添加新服务。通常，你可以复制现有的服务部分，将其创建一个新条目，并根据新服务适当地更改名称。

你可以再次运行 Containers: Add Docker Files to Workspace 命令为新应用生成 Dockerfile。虽然每个应用或服务都有自己的 Dockerfile，但通常每个工作区只有一个 docker-compose.yml 和一个 docker-compose.debug.yml 文件。

在 Python 项目中，Dockerfile、.dockerignore、docker-compose*.yml 文件都位于工作区的根文件夹中。当你添加另一个应用或服务时，请将 Dockerfile 移动到该应用的文件夹中。

在 Node.js 项目中，Dockerfile 和 .dockerignore 文件将位于该服务的 package.json 旁边。

对于 .NET，当你创建 Docker Compose 文件时，文件夹结构已经设置为处理多个项目，.dockerignore 和 docker-compose*.yml 放置在工作区根目录中（例如，如果项目在 src/project1 中，则文件在 src 中）。因此，当你添加另一个服务时，你可以在一个文件夹（比如 project2）中创建另一个项目，并如前所述重新创建或修改 docker-compose 文件。

调试

首先，请参考你的目标平台的调试文档，以了解使用 VS Code 在容器中调试的基础知识

如果你想在 Docker Compose 中进行调试，请使用上一节中所述的两个 Docker Compose 文件之一运行 Containers: Compose Up 命令，然后使用适当的 Attach 启动配置进行附加。直接使用常规启动配置启动不会使用 Docker Compose。

创建一个 Attach 启动配置。这是 launch.json 中的一个部分。这个过程大多是手动的，但在某些情况下，Container Tools 扩展可以通过添加一个预配置的启动配置来提供帮助，你可以将其用作模板进行自定义。以下各节分别介绍了每个平台（Node.js、Python 和 .NET）的具体过程。

Node.js

  1. 在调试选项卡上，选择配置下拉菜单，选择新建配置，然后选择 Containers: Attach 配置模板 Containers: Attach to Node。

  2. 在 docker-compose.debug.yml 中配置调试端口。该端口在创建文件时已设置，因此你可能不需要更改它。在下面的示例中，主机和容器上都使用端口 9229 进行调试。

     version: '3.4'

 services:
   node-hello:
     image: node-hello
     build: .
     environment:
       NODE_ENV: development
     ports:
       - 3000
       - 9229:9229
     command: node --inspect=0.0.0.0:9229 ./bin/www

  3. 如果你有多个应用，则需要更改其中某些应用的端口，以便每个应用都有一个唯一的端口。你可以在 launch.json 中指向正确的调试端口，并保存文件。如果省略此项，系统将自动选择端口。

    下面是一个显示 Node.js 启动配置（Attach）的示例

     "configurations": [
     {
         "type": "node",
         "request": "attach",
         "name": "Containers: Attach to Node",
         "remoteRoot": "/usr/src/app",
         "port": 9229 // Optional; otherwise inferred from the docker-compose.debug.yml.
     },
     // ...
 ]

  4. 完成 Attach 配置的编辑后，保存 launch.json，并选择你的新启动配置作为活动配置。在调试选项卡中，在配置下拉菜单中找到新配置。

    Screenshot of Configuration dropdown

  5. 右键单击 docker-compose.debug.yml 文件并选择 Compose Up。

  6. 当你附加到一个公开返回 HTML 的 HTTP 端点的服务时，网页浏览器不会自动打开。要在浏览器中打开应用，请在侧边栏中选择容器，右键单击并选择 Open in Browser。如果配置了多个端口，系统会要求你选择端口。

  7. 以常规方式启动调试器。在调试选项卡中，选择绿色箭头（启动按钮）或使用 F5。

Python

若要使用 Docker Compose 调试 Python，请按照以下步骤操作

  1. 在调试选项卡上，选择配置下拉菜单，选择新建配置，选择 Python Debugger，然后选择 Remote Attach 配置模板。

    Screenshot of Python Remote Attach

  2. 系统会提示你选择要用于调试的主机（例如 localhost）和端口。Python 的默认调试端口是 5678。如果你有多个应用，则需要更改其中一个应用的端口，以便每个应用都有一个唯一的端口。你可以在 launch.json 中指向正确的调试端口，并保存文件。如果省略此项，系统将自动选择端口。

         "configurations": [
     {
        "name": "Python Debugger: Remote Attach",
        "type": "debugpy",
        "request": "attach",
        "port": 5678,
        "host": "localhost",
        "pathMappings": [
            {
                "localRoot": "${workspaceFolder}",
                "remoteRoot": "/app"
            }
        ]
    }

  3. 完成 Attach 配置的编辑后，保存 launch.json。导航到调试选项卡，并选择 Python Debugger: Remote Attach 作为活动配置。

  4. 如果你已经有了一个有效的 Dockerfile，我们建议运行 Containers: Add Docker Compose Files to Workspace 命令。这将会创建一个 docker-compose.yml 文件以及一个 docker-compose.debug.yml 文件，该文件会进行卷映射并在容器中启动 Python 调试器。如果你还没有 Dockerfile，我们建议运行 Containers: Add Docker Files to Workspace 并选择 Yes 以包含 Docker Compose 文件。

    注意：默认情况下，使用 Containers: Add Docker Files to Workspace 时，选择 Django 和 Flask 选项将搭建一个为 Gunicorn 配置的 Dockerfile。请遵循 Python 容器快速入门中的说明，确保在继续之前正确配置了它。

  5. 右键单击 docker-compose.debug.yml 文件（如下例所示）并选择 Compose Up。

    version: '3.4'

services:
  pythonsamplevscodedjangotutorial:
    image: pythonsamplevscodedjangotutorial
    build:
      context: .
      dockerfile: ./Dockerfile
    command: ["sh", "-c", "pip install debugpy -t /tmp && python /tmp/debugpy --wait-for-client --listen 0.0.0.0:5678 manage.py runserver 0.0.0.0:8000 --nothreading --noreload"]
    ports:
      - 8000:8000
      - 5678:5678

  6. 容器构建并运行后，在选中 Python Debugger: Remote Attach 启动配置的情况下按下 F5 来附加调试器。

    Screenshot of debugging in Python

    注意：如果你想将 Python 调试器导入到特定文件中，可以在 debugpy README 中找到更多信息。

  7. 当你附加到一个公开 HTTP 端点并返回 HTML 的服务时，网页浏览器可能不会自动打开。要在浏览器中打开应用，请在容器资源管理器中右键单击该容器并选择 Open in Browser。如果配置了多个端口，系统会要求你选择端口。

    Screenshot - Open in Browser

    你现在正在调试容器中运行的应用。

.NET

  1. 在调试选项卡上，选择配置下拉菜单，选择新建配置，然后选择 Container Attach 配置模板 Containers: .NET Attach (Preview)。

  2. VS Code 会尝试使用默认路径将 vsdbg 从主机复制到目标容器。你还可以在 Attach 配置中提供对现有 vsdbg 实例的路径。

     "netCore": {
     "debuggerPath": "/remote_debugger/vsdbg"
 }

  3. 完成 Attach 配置的编辑后，保存 launch.json，并选择你的新启动配置作为活动配置。在调试选项卡中，在配置下拉菜单中找到新配置。

  4. 右键单击 docker-compose.debug.yml 文件并选择 Compose Up。

  5. 当你附加到一个公开返回 HTML 的 HTTP 端点的服务时，网页浏览器不会自动打开。要在浏览器中打开应用，请在侧边栏中选择容器，右键单击并选择 Open in Browser。如果配置了多个端口，系统会要求你选择端口。

  6. 以常规方式启动调试器。在调试选项卡中，选择绿色箭头（启动按钮）或使用 F5。

    Screenshot of starting debugging

  7. 如果你尝试附加到在容器中运行的 .NET 应用，你会看到一个提示，要求选择你的应用所在的容器。

    Screenshot of container selection

    要跳过此步骤，请在 launch.json 中的 Attach 配置中指定容器名称

        "containerName": "Your ContainerName"

    接下来，系统会询问你是否要将调试器 (vsdbg) 复制到容器中。选择 Yes。

    Screenshot of debugger prompt

如果一切配置正确，调试器应该已经附加到你的 .NET 应用上。

Screenshot of debug session

卷挂载

默认情况下，Container Tools 扩展不会为调试组件执行任何卷挂载。对于 .NET 或 Node.js，由于所需的组件已内置到运行时中，因此不需要这样做。如果你的应用需要卷挂载，请在 docker-compose*.yml 文件中使用 volumes 标签进行指定。

volumes:
    - /host-folder-path:/container-folder-path

使用多个 Compose 文件的 Docker Compose

工作区可以有多个 docker-compose 文件来处理开发、测试和生产等不同的环境。配置内容可以拆分到多个文件中。例如，一个定义所有环境公共信息的基础 compose 文件，以及分别定义特定环境信息的覆盖文件。当这些文件作为输入传递给 docker-compose 命令时，它会将这些文件组合成单个配置。默认情况下，Containers: Compose Up 命令将单个文件作为输入传递给 compose 命令，但你可以使用命令自定义来自定义 compose up 命令以传入多个文件。或者，你可以使用自定义任务带有所需参数来调用 docker-compose 命令。

注意：如果你的工作区拥有 docker-compose.yml 和 docker-compose.override.yml 且没有其他 compose 文件，那么调用 docker-compose 命令时将不带输入文件，并且它会隐式使用这些文件。在这种情况下，无需进行自定义。

命令自定义

命令自定义提供了多种根据你的需求自定义 compose up 命令的方法。以下是针对 compose up 命令的一些命令自定义示例。

基础文件和覆盖文件

假设你的工作区有一个基础 compose 文件（docker-compose.yml）以及针对每个环境的覆盖文件（docker-compose.dev.yml、docker-compose.test.yml 和 docker-compose.prod.yml），并且你总是通过基础文件和一个覆盖文件来运行 docker compose up。在这种情况下，可以按照以下示例自定义 compose up 命令。当调用 compose up 命令时，${configurationFile} 将被替换为所选的文件。

"docker.commands.composeUp": [
    {
        "label": "override",
        "template": "docker-compose -f docker-compose.yml ${configurationFile}  up -d --build",
    }
]

模板匹配

假设你为每个环境配备了不同的输入文件集。你可以定义多个带有正则表达式匹配的模板，并且所选的文件名将与此 match 属性进行匹配，然后将使用对应的模板。

"containers.commands.composeUp": [
    {
        "label": "dev-match",
        "template": "docker-compose -f docker-compose.yml -f docker-compose.debug.yml -f docker-compose.dev.yml up -d --build",
        "match": "dev"
    },
    {
        "label": "test-match",
        "template": "docker-compose -f docker-compose.yml -f docker-compose.debug.yml -f docker-compose.test.yml up -d --build",
        "match": "test"
    },
    {
        "label": "prod-match",
        "template": "docker-compose -f docker-compose.yml -f docker-compose.release.yml -f docker-compose.prod.yml up -d --build",
        "match": "prod"
    }
]

在调用命令时挑选模板

如果你从命令模板中省略了 match 属性，则每次调用 compose up 命令时，系统都会询问你使用哪个模板。例如

"containers.commands.composeUp": [
    {
        "label": "dev",
        "template": "docker-compose -f docker-compose.yml -f docker-compose.common.dev.yml ${configurationFile} up -d --build"
    },
    {
        "label": "test",
        "template": "docker-compose -f docker-compose.yml -f docker-compose.common.test.yml ${configurationFile} up -d --build"
    },
    {
        "label": "prod",
        "template": "docker-compose -f docker-compose.yml -f docker-compose.common.prod.yml ${configurationFile} up -d --build"
    },
],

自定义任务

除了使用命令自定义之外，你还可以定义如下任务来调用 docker-compose 命令。有关此选项的更多详细信息，请参考自定义任务。

{
  "type": "shell",
  "label": "compose-up-dev",
  "command": "docker-compose -f docker-compose.yml -f docker-compose.Common.yml -f docker-compose.dev.yml up -d --build",
  "presentation": {
    "reveal": "always",
    "panel": "new"
  }
}

下一步计划

12/21/2022
English 한국어 中文(简体) 中文(繁體)
© . This website operates independently and is not affiliated with or endorsed by Microsoft. All brand names, logos, and trademarks are the property of their respective owners.