VS Code DevContainer 是 Visual Studio Code 的一种开发环境容器化功能，属于其 Remote - Containers 插件的一部分。它允许开发者使用基于 Docker 的容器来创建隔离的、可复现的开发环境，并通过 VS Code 直接连接到容器中进行开发。

DevContainer

核心概念

1. DevContainer：一个基于 Docker 的容器，预先配置了开发环境所需的工具、依赖和设置。
2. .devcontainer 文件夹：项目中的目录，包含配置文件（如 devcontainer.json 和 Dockerfile）定义容器的构建方式和开发环境。
3. Remote Development：VS Code 使用 Remote Development 功能，将编辑器与容器连接，开发者仿佛在本地操作，但实际运行环境是在容器中。

为什么使用 DevContainer？

1. 环境一致性：确保团队成员之间的开发环境一致，避免 "在我电脑上能运行" 的问题。
2. 隔离性：开发环境与本机系统隔离，避免污染本机环境。
3. 快速启动：新成员只需克隆项目并启动容器，即可快速进入开发状态。
4. 易于迁移：开发环境可移植，适合切换设备或用于 CI/CD 管道。
5. 依赖管理：将语言版本、工具链等依赖集成到容器中，无需本机安装。

使用步骤

1. 安装 Remote - Containers 插件

   • 在 VS Code 的扩展市场中搜索 "Remote - Containers" 并安装。

2. 创建 .devcontainer 文件夹

   • 在项目根目录下创建 .devcontainer/，包含以下文件：
     • devcontainer.json：配置文件，定义容器设置。
     • Dockerfile（可选）：自定义容器镜像。

3. 编写 devcontainer.json 示例：

   {
     "name": "Django DevContainer",
     "build": {
       "dockerfile": "Dockerfile"
     },
     "settings": {
       "python.defaultInterpreterPath": "/usr/local/bin/python"
     },
     "extensions": ["ms-python.python", "batisteo.vscode-django"],
     "postCreateCommand": "pip install -r requirements.txt",
     "forwardPorts": [8000],
     "remoteUser": "vscode"
   }

4. 启动容器

   • 在 VS Code 中，点击左下角绿色按钮，选择 "Remote-Containers: Reopen in Container"。
   • VS Code 会根据配置文件构建并启动容器，并自动连接。

5. 开发环境内操作

   • 容器内的文件、工具、终端、调试与本地环境无异，支持 Django 项目开发等常见工作。

典型场景

1. 团队协作：在 .devcontainer 中定义统一的开发环境，让所有成员快速搭建一致的工作环境。
2. 语言隔离：项目需要不同的语言或工具版本（如 Python 3.9 和 3.11），通过容器实现隔离。
3. 临时环境：无需在本地安装大量依赖，通过容器直接运行项目。

优点

1. 跨平台一致性：无论在 macOS、Windows 还是 Linux，开发环境始终一致。
2. 自动化依赖安装：通过 postCreateCommand 或 Dockerfile，自动安装项目依赖。
3. 插件集成：支持安装与项目相关的 VS Code 插件到容器中。

示例：Django 项目配置

Dockerfile：

FROM python:3.10-slim
RUN apt-get update && apt-get install -y git
WORKDIR /workspace

devcontainer.json：

{
  "name": "Django DevContainer",
  "build": {
    "dockerfile": "Dockerfile"
  },
  "extensions": ["ms-python.python", "batisteo.vscode-django"],
  "postCreateCommand": "pip install -r requirements.txt",
  "forwardPorts": [8000]
}

1. 放入项目根目录的 .devcontainer/ 中。
2. 启动容器后，Django 开发环境会自动就绪。

查看日志

VS Code 最左侧菜单 > Remote Explorer > 选中某个 container > 右键 > Show Container Log

总结

VS Code DevContainer 是一个强大的工具，可以为 Django 项目（以及其他开发项目）提供一致、隔离、易迁移的开发环境。如果你希望避免环境问题并提升团队协作效率，这是一个值得使用的功能。