自定义 Docker 扩展

Docker 扩展包含多个 Visual Studio Code 任务，用于控制 Docker 构建 和 运行 的行为，并构成容器启动以进行调试的基础。

这些任务允许进行大量的控制和自定义。最终的配置是通用默认值、特定于平台的默认值（例如 Node.js、Python 或 .NET）和用户输入的组合。当用户输入与默认值冲突时，用户输入优先。

Visual Studio Code 任务的所有常见功能（例如，将任务分组到复合任务中）都受 Docker 扩展任务支持。有关常见任务功能和属性的更多信息，请参阅 Visual Studio Code 的 自定义任务 文档。

Docker 构建任务

docker-build 任务使用 Docker 命令行（CLI）构建 Docker 镜像。该任务可以独立使用，也可以作为一系列任务的一部分来运行和/或调试 Docker 容器中的应用程序。

docker-build 任务最重要的配置设置是 dockerBuild 和 platform。

• dockerBuild 对象指定 Docker 构建命令的参数。此对象指定的值直接应用于 Docker 构建 CLI 调用。
• platform 属性是提示，它会改变 docker-build 任务如何确定 Docker 构建默认值的方式。

请参阅 属性参考，以获取所有任务属性的完整列表。

平台支持

虽然 tasks.json 中的 docker-build 任务可用于构建任何 Docker 镜像，但扩展明确支持（并简化了配置）Node.js、Python 和 .NET Core。

Node.js（docker-build）

使用默认值进行最小配置

基于 Node.js 的 Docker 镜像（没有特定平台选项）只需将 platform 属性设置为 node。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Build Node Image",
      "type": "docker-build",
      "platform": "node"
    }
  ]
}

平台默认值

对于 Node.js Docker 镜像，docker-build 任务会推断以下选项。

Python（docker-build）

使用默认值进行最小配置

基于 Python 的 Docker 镜像（没有特定平台选项）只需将 platform 属性设置为 python。

{
  "tasks": [
    {
      "type": "docker-build",
      "label": "docker-build",
      "platform": "python"
    }
  ]
}

平台默认值

对于 Python Docker 镜像，docker-build 任务会推断以下选项。

.NET（docker-build）

使用默认值进行最小配置

构建基于 .NET 的 Docker 镜像时，可以省略 platform 属性，只需设置 netCore 对象即可（当存在 netCore 对象时，platform 会隐式设置为 netcore）。请注意，appProject 是必需属性。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Build Node Image",
      "type": "docker-build",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

平台默认值

对于基于 .NET 的镜像，docker-build 任务会推断以下选项。

构建任务参考

以下列出了可用于配置 docker-build 任务的所有属性。除非另有说明，否则所有属性都是可选的。

dockerBuild 对象属性

node 对象属性（docker-build 任务）

netCore 对象属性（docker-build 任务）

Docker 运行任务

tasks.json 中的 docker-run 任务使用 Docker 命令行界面 (CLI) 创建并启动 Docker 容器。该任务可以单独使用，也可以作为一系列任务的一部分，用于在 Docker 容器中调试应用程序。

docker-run 任务最重要的配置设置是 dockerRun 和 platform。

• dockerRun 对象指定 Docker run 命令的参数。此对象指定的值将直接应用于 Docker run CLI 调用。
• platform 属性是一个提示，它会改变 docker-run 任务确定 Docker run 默认值的方式。

有关所有任务属性的完整列表，请参见 属性参考。

Docker run 平台支持

虽然 docker-run 任务可用于运行任何 Docker 镜像，但扩展程序对 Node.js、Python 和 .NET 提供明确的支持（以及简化的配置）。

Node.js (docker-run)

使用默认值进行最小配置

基于 Node.js 的 Docker 镜像，如果没有特定的平台选项，可以将 platform 属性设置为 node。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run Node Image",
      "node": "docker-run",
      "platform": "node"
    }
  ]
}

平台默认值

对于基于 Node.js 的 Docker 镜像，docker-run 任务会推断以下选项

Python (docker-run)

构建基于 Python 的 Docker 镜像时，可以省略 platform 属性，只需设置 python 对象（当 python 对象存在时，platform 会隐式设置为 python）。

Django 应用程序的最小配置

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "python": {
    "args": ["runserver", "0.0.0.0:8000", "--nothreading", "--noreload"],
    "file": "path_to/manage.py"
  }
}

Flask 应用程序的最小配置

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "dockerRun": {
    "env": {
      "FLASK_APP": "path_to/flask_entry_point.py"
    }
  },
  "python": {
    "args": ["run", "--no-debugger", "--no-reload", "--host", "0.0.0.0", "--port", "5000"],
    "module": "flask"
  }
}

通用应用程序的最小配置

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "python": {
    "file": "path_to/app_entry_point.py"
  }
}

平台默认值

对于基于 Python 的 Docker 镜像，docker-run 任务会推断以下选项

.NET (docker-run)

使用默认值进行最小配置

构建基于 .NET 的 Docker 镜像时，可以省略 platform 属性，只需设置 netCore 对象（当 netCore 对象存在时，platform 会隐式设置为 netcore）。请注意，appProject 是一个必需的属性。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run .NET Core Image",
      "type": "docker-run",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

平台默认值

对于基于 .NET 的镜像，docker-run 任务会推断以下选项

运行任务参考

以下是可用于配置 docker-run 任务的所有属性。除非另有说明，否则所有属性都是可选的。

dockerRun 对象属性

端口对象属性

extraHosts 对象属性

卷对象属性

node 对象属性 (docker-run 任务)

python 对象属性 (docker-run 任务)

netCore 对象属性 (docker-run 任务)

Docker Compose 任务

tasks.json 中的 docker-compose 任务使用 Docker Compose 命令行界面 (CLI) 创建并启动 Docker 容器。该任务可以单独使用，也可以作为一系列任务的一部分，用于在 Docker 容器中调试应用程序。

docker-compose 任务最重要的配置设置是 dockerCompose。

• dockerCompose 对象指定 Docker Compose 命令的参数。此对象指定的值将直接应用于 Docker Compose CLI 调用。

有关所有任务属性的完整列表，请参见 属性参考。

示例配置

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run docker-compose up",
      "type": "docker-compose",
      "dockerCompose": {
        "up": {
          "detached": true,
          "build": true,
          "services": ["myservice"]
        },
        "files": [
          "${workspaceFolder}/docker-compose.yml",
          "${workspaceFolder}/docker-compose.debug.yml"
        ]
      }
    }
  ]
}

Compose 任务参考

以下是可用于配置 docker-compose 任务的所有属性。除非另有说明，否则所有属性都是可选的。

dockerCompose 对象属性

up 对象属性

down 对象属性

命令自定义

Docker 扩展在您执行各种操作时（例如构建镜像、运行容器、附加到容器和查看容器日志）会执行许多 Docker CLI 命令。其中一些命令有大量的可选参数，通常用于非常特定的场景。作为上述 Visual Studio Code 任务的替代方案，当任务未被使用时，可以自定义一些命令。

例如，Compose Up 命令中的 ${serviceList} 和 ${profileList} 令牌可以轻松地启动 Docker Compose YAML 文件中的一组服务。

对于每个可自定义的 Docker 命令，都提供了一个配置设置来设置要执行的模板。或者，您可以定义多个模板，可以选择使用正则表达式，当匹配时，它会提示应该使用模板的上下文。这些模板支持一些与 launch.json 和 tasks.json 相似的令牌，例如 ${workspaceFolder}。

设置 JSON 模式

您有两种选择来配置每个模板（如下所示）。第一个选项是覆盖默认行为的单个模板。

{
  "docker.commands.build": "docker build --rm -f \"${dockerfile}\" -t ${tag} \"${context}\""
}

第二个选项是根据 match 正则表达式以及用户输入选择的多个模板。

例如，以下示例显示了三个模板

{
  "docker.commands.build": [
    {
      "label": "Default build command",
      "template": "docker build --rm -f \"${dockerfile}\" -t ${tag} \"${context}\""
    },
    {
      "label": "Alpine-specific build command",
      "template": "docker build -p 1234:1234 -f \"${dockerfile}\" -t ${tag} \"${context}\"",
      "match": "alpine"
    }
  ]
}

选择行为

选择的要执行的命令模板是根据以下规则选择的

1. 如果没有配置设置，则选择默认命令模板。
2. 如果只配置了一个模板（上面的第一个示例），则选择该模板。
3. 如果配置了多个模板
   1. 检查约束模板。约束模板具有 match。将 match 正则表达式与上下文提示（例如，镜像名称、容器名称等）进行比较。
   2. 如果多个约束模板适用，则会提示用户选择。如果只有一个适用，则不会提示用户。
   3. 如果没有适用的约束模板，则检查不受约束的模板。不受约束的模板没有 match，因此始终适用。
   4. 如果多个不受约束的模板适用，则会提示用户选择。如果只有一个适用，则不会提示用户。

Docker 构建

支持的令牌

注意：如果 docker.commands.build 设置不包含 ${tag} 令牌，则不会提示用户输入/确认标签。

注意：match 正则表达式将与所选的 Dockerfile 名称和工作区文件夹名称进行比较。

Docker 运行

支持的令牌

注意：match 正则表达式将与所选镜像的完整标签进行比较。

Docker 附加

支持的令牌

注意：match 正则表达式将与容器名称和容器镜像的完整标签进行比较。

Docker 日志

支持的令牌

注意：match 正则表达式将与容器名称和容器镜像的完整标签进行比较。

Docker Compose Up

支持的令牌

Docker Compose Down

支持的令牌

其他支持的令牌

除了特定于命令的支持的令牌之外，以下令牌在所有命令模板中都受支持