现已发布！阅读 10 月份的新功能和修复。

使用 Docker Compose

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

此外，对于单容器场景，使用 Docker Compose 以与工具无关的方式提供配置，而单个 Dockerfile 则不能。诸如容器的卷挂载、端口映射和环境变量之类的配置设置可以在 docker-compose YML 文件中声明。

要在 VS Code 中使用 Docker 扩展使用 Docker Compose，您应该已经熟悉 Docker Compose 的基础知识。

向项目添加 Docker Compose 支持

如果您已经有一个或多个 Dockerfile，可以通过打开 **命令面板** (⇧⌘P (Windows、Linux Ctrl+Shift+P))，并使用 **Docker: 将 Docker Compose 文件添加到工作区** 命令来添加 Docker Compose 文件。按照提示操作。

您可以在添加 Dockerfile 的同时将 Docker Compose 文件添加到您的工作区，方法是打开 **命令面板** (⇧⌘P (Windows、Linux Ctrl+Shift+P))，并使用 **Docker: 将 Docker 文件添加到工作区** 命令。系统会询问您是否要添加 Docker Compose 文件。如果您要保留现有的 Dockerfile，则在提示您覆盖 Dockerfile 时选择 **否**。

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

Screenshot of project with docker-compose files

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

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

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

向项目添加新的容器

如果要添加另一个应用程序或服务，可以再次运行 **将 Docker Compose 文件添加到工作区**，并选择覆盖现有的 docker-compose 文件，但这样做会导致这些文件中任何自定义内容丢失。如果您想保留对 compose 文件的更改，则可以手动修改 docker-compose.yml 文件以添加新服务。通常，您可以复制现有服务部分，将其粘贴以创建一个新的条目，然后更改名称以适合新的服务。

您可以再次运行 **将 Docker 文件添加到工作区** 命令以生成新应用程序的 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 文件之一运行 **Docker Compose Up** 命令，然后使用相应的 **附加** 启动配置进行附加。直接使用普通启动配置不会使用 Docker Compose。

创建一个 **附加** 启动配置。这是 launch.json 中的一个部分。该过程主要为手动操作，但在某些情况下，Docker 扩展可以通过添加一个预配置的启动配置来提供帮助，您可以将其用作模板并进行自定义。每个平台（Node.js、Python 和 .NET）的过程将在以下部分中介绍。

Node.js

  1. 在 **调试** 选项卡上，选择 **配置** 下拉菜单，选择 **新建配置**，然后选择 Docker Attach 配置模板 **Node.js Docker Attach (预览)**。

  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 启动配置 - 附加

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

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

    Screenshot of Configuration dropdown

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

  6. 当您附加到暴露返回 HTML 的 HTTP 端点的服务时，Web 浏览器不会自动打开。要在浏览器中打开应用程序，请在侧边栏中选择容器，右键单击并选择在浏览器中打开。如果配置了多个端口，系统将提示您选择端口。

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

Python

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

  1. 在调试选项卡中，选择配置下拉菜单，选择新建配置，选择Python 调试器，然后选择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. 完成编辑附加配置后，保存launch.json。导航到调试选项卡，然后选择Python 调试器：远程附加作为活动配置。

  4. 如果您已经拥有有效的 Dockerfile，我们建议运行命令Docker：将 Docker Compose 文件添加到工作区。这将创建一个docker-compose.yml文件以及一个docker-compose.debug.yml，该文件将卷映射并启动容器中的 Python 调试器。如果您还没有 Dockerfile，我们建议运行Docker：将 Docker 文件添加到工作区，然后选择是以包含 Docker Compose 文件。

    注意：默认情况下，当使用Docker：将 Docker 文件添加到工作区时，选择 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. 容器构建并运行后，通过按F5（选择Python 调试器：远程附加启动配置）来附加调试器。

    Screenshot of debugging in Python

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

  7. 当您附加到公开 HTTP 端点并返回 HTML 的服务时，Web 浏览器可能不会自动打开。要在浏览器中打开应用程序，请右键单击 Docker 资源管理器中的容器，然后选择在浏览器中打开。如果配置了多个端口，系统将提示您选择端口。

    Screenshot - Open in Browser

    现在，您正在调试容器中运行的应用程序。

.NET

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

  2. VS Code 尝试使用默认路径将vsdbg从主机复制到目标容器。您也可以在附加配置中提供指向vsdbg现有实例的路径。

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

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

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

  5. 当您附加到暴露返回 HTML 的 HTTP 端点的服务时，Web 浏览器不会自动打开。要在浏览器中打开应用程序，请在侧边栏中选择容器，右键单击并选择在浏览器中打开。如果配置了多个端口，系统将提示您选择端口。

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

    Screenshot of starting debugging

  7. 如果您尝试附加到容器中运行的 .NET 应用程序，系统将提示您选择应用程序的容器。

    Screenshot of container selection

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

        "containerName": "Your ContainerName"

    接下来，系统会询问您是否要将调试器（vsdbg）复制到容器中。选择是。

    Screenshot of debugger prompt

如果所有内容都配置正确，则调试器应已附加到您的 .NET 应用程序。

Screenshot of debug session

卷挂载

默认情况下，Docker 扩展不会为调试组件执行任何卷装载。对于 .NET 或 Node.js 来说，不需要它，因为所需组件已内置到运行时中。如果您的应用程序需要卷装载，请使用docker-compose*.yml文件中的volumes标签指定它们。

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

使用多个 Compose 文件的 Docker Compose

工作区可以具有多个 docker-compose 文件来处理不同的环境，例如开发、测试和生产。配置内容可以拆分为多个文件。例如，一个基本 compose 文件定义所有环境的通用信息，而单独的覆盖文件定义特定于环境的信息。当这些文件作为输入传递给docker-compose命令时，它会将这些文件组合成一个配置。默认情况下，Docker：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属性匹配，并使用相应的模板。

"docker.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命令时使用哪个模板。例如

"docker.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