自定义Docker扩展

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

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

Docker 扩展任务支持 Visual Studio Code 任务的所有常见功能（例如，将任务分组为复合任务）。有关常见任务功能和属性的更多信息，请参阅 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构建)

使用默认值的最小配置

一个基于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构建)

使用默认值的最小配置

一个基于Python的Docker镜像，如果没有特定的平台选项，可以简单地将platform属性设置为python：

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

平台默认值

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

.NET (docker构建)

使用默认值的最小配置

当你构建一个基于.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 对象属性

节点对象属性 (docker-build 任务)

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

Docker 运行任务

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

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

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

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

Docker 运行平台支持

虽然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 对象属性

volumes 对象属性

节点对象属性 (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 启动

支持的令牌：

Docker Compose 关闭

支持的令牌：

额外支持的令牌

除了特定命令支持的令牌外，所有命令模板还支持以下令牌：