VS Code 远程开发容器：自定义镜像与环境配置

VS Code 的远程开发容器功能允许在隔离的容器环境中开发，确保环境一致性。以下是自定义镜像与环境配置的完整指南：

---

1. 核心概念

• 自定义镜像：基于 Dockerfile 构建，包含特定工具链（如 Python 3.11、Node.js 18）。
• 环境配置：通过 devcontainer.json 文件定义容器行为（如端口映射、扩展安装）。

---

2. 创建自定义镜像

步骤：

1. 新建 Dockerfile 文件：

# 基础镜像（例如：Ubuntu 22.04）
FROM ubuntu:22.04

# 安装工具链
RUN apt-get update && apt-get install -y \
    python3-pip \
    git \
    curl

# 配置工作目录
WORKDIR /workspace

1. 构建镜像：

docker build -t my-custom-dev-image:latest .

---

3. 配置开发容器

关键文件：devcontainer.json

{
  "name": "Custom Dev Container",
  "build": {
    "dockerfile": "Dockerfile"  // 指向自定义镜像
  },
  "settings": {
    "terminal.integrated.shell.linux": "/bin/bash"
  },
  "extensions": [
    "ms-python.python",          // 安装Python扩展
    "esbenp.prettier-vscode"     // 安装Prettier
  ],
  "forwardPorts": [8080],        // 端口转发
  "postCreateCommand": "pip install -r requirements.txt"  // 容器启动后自动执行的命令
}

---

4. 启动远程容器

1. 在VS Code中：
   • 打开项目文件夹。
   • 按 F1 → 选择 Remote-Containers: Reopen in Container。
2. VS Code将自动：
   • 构建自定义镜像（若未构建）。
   • 启动容器并加载配置。
   • 安装指定扩展。

---

5. 高级配置技巧

• 复用基础镜像：
  在 Dockerfile 中使用官方镜像加速构建：

  FROM mcr.microsoft.com/vscode/devcontainers/python:3.11
  RUN pip install numpy pandas  // 添加额外依赖
  

• 环境变量注入：
  在 devcontainer.json 中添加：

  "containerEnv": {
    "PYTHONPATH": "/workspace/src"
  }
  

• 绑定本地文件：
  通过 mounts 字段挂载本地目录：

  "mounts": [
    "source=${localWorkspaceFolder}/data,target=/workspace/data,type=bind"
  ]
  

---

6. 调试与验证

• 检查容器状态：
  终端执行 docker ps 查看运行中的容器。
• 日志诊断：
  VS Code 输出面板选择 Dev Containers 查看详细日志。
• 测试配置：
  修改 devcontainer.json 后，使用 Rebuild Container 重新加载。

---

7. 最佳实践

• 轻量化镜像：使用 .dockerignore 排除无关文件（如 node_modules）。
• 版本锁定：在 Dockerfile 中指定工具版本（例如 python3.11）。
• 配置同步：将 Dockerfile 和 devcontainer.json 提交至版本控制系统（如 Git）。

通过以上步骤，可快速构建标准化开发环境，避免“在我机器上能运行”的问题。