VS CodeでのDev Containersのマスター

Dev Containersを使用して、一貫性があり、移動可能で、再現可能な開発環境を構築しましょう。

目次

開発者は、依存関係の不一致、ツールのバージョン、またはOSの違いにより、「私のマシンでは動く」というジレンマに直面することがよくあります。 Visual Studio Code (VS Code) での Dev Containers は、この問題をエレガントに解決します — あなたのプロジェクトに特化した コンテナ化された環境 で開発できるようにするからです。

現代のソフトウェア開発では、マシンやオペレーティングシステムにかかわらず、一貫性があり、再現可能な環境が必要です。Pythonのデータサイエンスプロジェクト、Node.jsのウェブアプリケーション、またはGoのマイクロサービスを開発している場合でも、チームのすべてのメンバーが同じ開発設定を持つことを保証するのは難しい場合があります。

vs code dev containers

この包括的なガイドでは、Dev Containersとは何か、なぜ価値があるのか、そしてVS Codeでそれらを設定して、スムーズで移動可能な開発ワークフローを構築する方法を説明します。基本的な設定からDocker Composeを使用した高度な構成、チーム協力のためのベストプラクティスまで、すべてを学ぶことができます。


🧩 Dev Containersとは?

Dev Containersは、VS Code Remote - Containers拡張機能(現在はVS Code Remote Developmentの一部)が提供する機能です。 これにより、Dockerコンテナで開発プロジェクトを開くことができ、すべての依存関係、言語、ツールが事前に設定されています。

これは次のように考えることができます:

“コードとして定義された完全に設定された開発環境。”

あなたのマシンにPython、Node.js、データベース、さまざまなツールを直接インストールする代わりに、それらを設定ファイルで定義します。VS Codeでプロジェクトを開くと、指定された通りにすべてが事前にインストールおよび設定されたコンテナが自動的に起動します。

Dev Containerの設定には通常以下が含まれます:

  • Dockerfile またはベースイメージへの参照(コンテナのOS、言語、ツールを定義)
  • devcontainer.json ファイル(ワークスペース設定、VS Code拡張機能、ポート転送、環境変数、起動コマンドを設定)
  • 必要に応じて docker-compose.yml(データベース、Redis、メッセージキューなどの複数のサービスに依存するプロジェクトの場合)

⚙️ Dev Containersを使う理由

それらが強力な理由は以下の通りです:

  • 再現性: すべての開発者とCIシステムが同じ環境を使用します。もう「私のマシンでは動くが、あなたのマシンでは動かない」という問題はありません。あなたのラップトップで動作するものは、同僚のWindowsマシン、Mac、またはLinuxワークステーションでも同じように動作します。

  • 分離: ローカルマシンに競合する依存関係を汚染する必要はありません。Python、Node.js、または他のツールの異なるバージョンが必要な複数のプロジェクトを扱う際、バージョンの競合や仮想環境の調整を気にする必要がありません。

  • 移動性: Dockerをサポートする任意のOSで動作します。開発環境はコードとともに移動します。リポジトリをクローンし、VS Codeで開けば、オペレーティングシステムに関係なく数分でコードを書く準備ができます。

  • チームの一貫性: チーム全体で共有される1つの設定。新規チームメンバーは、数時間(または数日)かけて開発環境を設定する代わりに、数分で開始できます。

  • 自動化: プロジェクトを開くと、自動的にVS Code拡張機能、言語依存関係、ツールがインストールされます。ポスト作成コマンドは、データベースマイグレーション、シードデータの挿入、またはその他のセットアップタスクを手動操作なしで実行できます。

  • セキュリティ: リスクのある依存関係をコンテナに分離します。古い、脆弱なライブラリのバージョンでテストする必要がある場合でも、ホストシステムに影響を与えることなくコンテナ内に限定されます。

現実の例: Python 3.11、PostgreSQL 15、Redis、Elasticsearchを使用するマイクロサービスプロジェクトにチームに加わったと想像してください。Dev Containersがなければ、各コンポーネントをインストールして設定するのに何時間もかかるでしょう。Dev Containersがあれば、VS Codeでプロジェクトを開き、コンテナを構築させれば、5〜10分でコードを書く準備ができます。


🧱 VS CodeでのDev Containerの設定

ステップバイステップで説明します。

1. 必要なツールのインストール

開始する前に、以下のものをインストールしてください:

  • Docker Desktop(またはPodmanなどの同等のコンテナランタイム)

    • Windows/Mac: Docker Desktopをダウンロードしてインストール
    • Linux: Docker Engineをインストールし、ユーザーがdockerグループに所属していることを確認
  • VS Code(最新バージョンが推奨)

  • Dev Containers拡張機能(Microsoft製)

    • VS Codeを開く
    • 拡張機能(Ctrl+Shift+X または Cmd+Shift+X
    • 「Dev Containers」を検索
    • ID: ms-vscode-remote.remote-containers の拡張機能をインストール

設定の確認:

# Dockerが動作しているか確認
docker --version
docker ps

# Dockerのバージョンと動作中のコンテナ(ある場合)を出力

2. Dev Containerの初期化

VS Code でプロジェクトフォルダを開き、コマンドパレットCtrl+Shift+P または Cmd+Shift+P)を開き、以下を入力して選択してください:

Dev Containers: Add Dev Container Configuration Files...

VS Codeは、事前に定義された環境テンプレートのリストを提示します。プロジェクトに合ったものを選択してください:

  • Node.js — JavaScript/TypeScriptプロジェクト
  • Python — データサイエンス、ウェブアプリ、スクリプト
  • Go — Goアプリケーションとサービス
  • .NET — C#/F#アプリケーション
  • Java — Spring Boot、Maven、Gradleプロジェクト
  • Docker-in-Docker — コンテナ内でDockerが必要な場合
  • その他にも多数…

追加の機能を選択することもできます:

  • 一般的なユーティリティ(git、curl、wget)
  • データベースクライアント
  • クラウドCLIツール(AWS、Azure、GCP)

このウィザードは、以下のものを作成します:

  • devcontainer.json — 主な設定ファイル
  • Dockerfile — カスタムイメージの定義(または事前に構築されたベースイメージへの参照)

3. devcontainer.jsonのカスタマイズ

devcontainer.jsonファイルは魔法が起こる場所です。以下はNode.jsプロジェクトのよく文書化された例です:

{
  // VS Codeでコンテナの表示名
  "name": "Node.js Development Container",
  
  // ビルド設定 - Dockerfileまたは事前に構築されたイメージを使用
  "build": {
    "dockerfile": "Dockerfile",
    "context": ".."
  },
  
  // 代替: Dockerfileの代わりに事前に構築されたイメージを使用
  // "image": "mcr.microsoft.com/devcontainers/javascript-node:18",
  
  // ワークスペース設定
  "customizations": {
    "vscode": {
      // コンテナ内で適用されるVS Code設定
      "settings": {
        "terminal.integrated.defaultProfile.linux": "bash",
        "editor.formatOnSave": true,
        "editor.defaultFormatter": "esbenp.prettier-vscode"
      },
      
      // 自動インストールする拡張機能
      "extensions": [
        "dbaeumer.vscode-eslint",
        "esbenp.prettier-vscode",
        "eamodio.gitlens",
        "ms-azuretools.vscode-docker"
      ]
    }
  },
  
  // ポート転送 - コンテナのポートをホストに公開
  "forwardPorts": [3000, 5432],
  "portsAttributes": {
    "3000": {
      "label": "Application",
      "onAutoForward": "notify"
    }
  },
  
  // 各段階で実行するコマンド
  "postCreateCommand": "npm install",     // コンテナが最初に作成された後
  "postStartCommand": "npm run dev",      // コンテナが起動した後
  
  // 環境変数
  "containerEnv": {
    "NODE_ENV": "development",
    "PORT": "3000"
  },
  
  // コンテナ内で使用するユーザーアカウント(セキュリティのため推奨)
  "remoteUser": "node",
  
  // その他のボリュームをマウント
  "mounts": [
    "source=${localEnv:HOME}/.ssh,target=/home/node/.ssh,readonly,type=bind"
  ]
}

重要な設定オプションの説明:

  • name — VS Codeステータスバーに表示される名前
  • build / image — Dockerfileまたは事前に構築されたイメージを使用
  • customizations.vscode.extensions — 自動インストールするVS Code拡張機能
  • forwardPorts — コンテナからホストに公開するポート
  • postCreateCommand — コンテナが最初に作成されたときに実行される(例: 依存関係のインストール)
  • postStartCommand — コンテナが起動するたびに実行される
  • containerEnv — コンテナ内で利用可能な環境変数
  • remoteUser — コンテナ内で使用するユーザーアカウント
  • mounts — その他のファイル/フォルダをマウント(例: SSHキー)

💡 プロのヒント:

  • postCreateCommandで遅い操作(npm install、pip install)を使用
  • postStartCommandで高速な起動タスク(データベースマイグレーション)を使用
  • 必ずプロジェクトに必要な拡張機能を指定 — これにより一貫したツールが保証される
  • 環境変数を使用して開発者間で異なる設定を指定

4. ビルドしてコンテナで開く

設定が準備できたら、開発環境を起動します:

コマンドパレットを開くCtrl+Shift+P / Cmd+Shift+P)と実行してください:

Dev Containers: Reopen in Container

次に何が起こるか:

  1. イメージのビルド — VS CodeはDockerfileに基づいてイメージをビルドしたり、事前に構築されたイメージをプルしたりします。最初の回は数分かかるかもしれません。

  2. コンテナの作成 — Dockerはビルドされたイメージから新しいコンテナを作成します。

  3. ボリュームのマウント — プロジェクトディレクトリがコンテナにマウントされ、コードがコンテナ内でアクセス可能になります。

  4. 拡張機能のインストール — 指定されたすべてのVS Code拡張機能が自動的にコンテナにインストールされます。

  5. ポスト作成コマンドpostCreateCommandが実行されます(例: npm install, pip install -r requirements.txt)。

  6. 準備完了! — VS Codeはコンテナに再接続し、今やコンテナ内で開発しています。

コンテナ内であることを確認する:

コンテナ内で作業していることを確認するために、ターミナルを開き、以下を実行してください:

# オペレーティングシステムを確認
uname -a
# 出力: Linux ... (コンテナのカーネル)

# ホスト名を確認(通常コンテナID)
hostname
# 出力: abc123def456

# 実行中のプロセスを確認
ps aux
# コンテナのプロセスが表示され、ホストシステムのプロセスではありません

VS Codeのステータスバー(左下)は今や: Dev Container: [コンテナ名] と表示されます。

コンテナライフサイクルコマンド:

  • コンテナの再構築Dev Containers: Rebuild Container(Dockerfileを変更したとき)
  • キャッシュなしで再構築Dev Containers: Rebuild Container Without Cache(新しいビルドが必要なとき)
  • ローカルで再開Dev Containers: Reopen Folder Locally(コンテナを終了し、ホストで作業)

5. その他のサービスの追加(オプション)

現実のアプリケーションは、データベース、キャッシュレイヤー、メッセージキュー、またはその他のサービスに依存することがよくあります。Docker Compose を使用して複数のコンテナをオーケストレートできます。

例: Node.js、PostgreSQL、Redisを使用したフルスタックアプリケーション

.devcontainerフォルダに docker-compose.yml を作成します:

version: "3.8"

services:
  # メイン開発コンテナ
  app:
    build: 
      context: ..
      dockerfile: .devcontainer/Dockerfile
    
    volumes:
      # プロジェクトディレクトリをマウント
      - ..:/workspace:cached
      # ネームドボリュームを使用して node_modules(パフォーマンス向上)
      - node_modules:/workspace/node_modules
    
    # コンテナを実行し続ける
    command: sleep infinity
    
    # 他のサービスへのネットワークアクセス
    depends_on:
      - db
      - redis
    
    environment:
      DATABASE_URL: postgresql://dev:secret@db:5432/appdb
      REDIS_URL: redis://redis:6379

  # PostgreSQLデータベース
  db:
    image: postgres:15-alpine
    restart: unless-stopped
    volumes:
      - postgres-data:/var/lib/postgresql/data
    environment:
      POSTGRES_USER: dev
      POSTGRES_PASSWORD: secret
      POSTGRES_DB: appdb
    ports:
      - "5432:5432"

  # Redisキャッシュ
  redis:
    image: redis:7-alpine
    restart: unless-stopped
    volumes:
      - redis-data:/data
    ports:
      - "6379:6379"

volumes:
  postgres-data:
  redis-data:
  node_modules:

その後、devcontainer.jsonを更新してDocker Composeを使用するようにします:

{
  "name": "Full-stack Dev Environment",
  
  // Docker Composeを使用する代わりに単一コンテナを使用
  "dockerComposeFile": "docker-compose.yml",
  
  // どのサービスを開発コンテナとして使用するか
  "service": "app",
  
  // コンテナ内のワークスペースフォルダへのパス
  "workspaceFolder": "/workspace",
  
  "customizations": {
    "vscode": {
      "extensions": [
        "dbaeumer.vscode-eslint",
        "esbenp.prettier-vscode",
        "ms-azuretools.vscode-docker",
        "ckolkman.vscode-postgres"  // PostgreSQLクライアント
      ]
    }
  },
  
  "forwardPorts": [3000, 5432, 6379],
  
  "postCreateCommand": "npm install && npm run db:migrate",
  
  "remoteUser": "node"
}

この設定が提供するもの:

  • app — Node.jsを使用した開発コンテナ
  • db — PostgreSQLデータベース、アプリから db:5432 でアクセス可能
  • redis — Redisキャッシュ、アプリから redis:6379 でアクセス可能
  • ネームドボリューム — コンテナの再起動間でデータベースデータを保持
  • ポート転送 — ホストマシンからすべてのサービスにアクセス可能

コードからサービスに接続:

// Node.jsアプリケーション内で
const { Pool } = require('pg');
const redis = require('redis');

// PostgreSQL接続
const pool = new Pool({
  connectionString: process.env.DATABASE_URL
  // 解決: postgresql://dev:secret@db:5432/appdb
});

// Redis接続
const redisClient = redis.createClient({
  url: process.env.REDIS_URL
  // 解決: redis://redis:6379
});

ホストからサービスにアクセス:

  • アプリ: http://localhost:3000
  • PostgreSQL: localhost:5432(任意のPostgreSQLクライアントを使用)
  • Redis: localhost:6379redis-cliまたはGUIツールを使用)

今や、VS Codeでプロジェクトを開くと、すべてのサービスが自動的に起動します!


🧠 高度なヒントとベストプラクティス

事前に構築されたイメージの使用

Microsoftの公式 devcontainerイメージ から開始して、ビルド時間を大幅に節約してください:

{
  "image": "mcr.microsoft.com/devcontainers/python:3.11",
  "features": {
    "ghcr.io/devcontainers/features/git:1": {},
    "ghcr.io/devcontainers/features/github-cli:1": {}
  }
}

機能は、Git、GitHub CLI、Node、AWS CLIなどの一般的なツールのための再利用可能なインストールスクリプトです。

バージョン管理のベストプラクティス

常に .devcontainer フォルダをコミットしてください:

git add .devcontainer/
git commit -m "Add Dev Container configuration"
git push

これにより以下が保証されます:

  • ✅ 新規チームメンバーが自動的に環境を取得
  • ✅ 環境変更が追跡され、レビュー可能
  • ✅ すべての人が同じ設定で開発

プロのヒント: .devcontainer フォルダに README セクションを追加して、開発コンテナの設定を説明してください:

## 開発セットアップ

このプロジェクトはVS Code Dev Containersを使用しています。開始するには:

1. Docker DesktopとVS Codeをインストール
2. 「Dev Containers」拡張機能をインストール
3. このリポジトリをクローン
4. VS Codeで開く
5. プロンプトが表示されたら「Reopen in Container」をクリック

コンテナでのデバッグ

デバッグはシームレスに動作します。launch.jsonを通常通り設定してください:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Launch Node.js",
      "type": "node",
      "request": "launch",
      "program": "${workspaceFolder}/index.js",
      "skipFiles": ["<node_internals>/**"]
    }
  ]
}

ブレイクポイントを設定し、通常通りデバッグしてください — VS Codeは自動的にコンテナ接続を処理します。

連続統合とのパリティ

CI/CDパイプラインで同じコンテナイメージを使用してください:

# GitHub Actionsの例
name: CI
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    container:
      image: mcr.microsoft.com/devcontainers/javascript-node:18
    steps:
      - uses: actions/checkout@v3
      - run: npm install
      - run: npm test

これにより 開発/プロダクションのパリティ が保証されます — ローカルでテストが通れば、CIでも通ります。

パフォーマンス最適化

macOS/Windowsユーザー向け — 依存関係にネームドボリュームを使用してください:

{
  "mounts": [
    "source=myproject-node_modules,target=${containerWorkspaceFolder}/node_modules,type=volume"
  ]
}

これにより node_modulesvenv などのファイルI/Oパフォーマンスが大幅に向上します。

マルチステージ開発

異なるチームロール用に異なる設定を作成してください:

.devcontainer/
├── devcontainer.json          # デフォルト(フルスタック)
├── frontend/
│   └── devcontainer.json      # フロントエンド専用(軽量)
└── backend/
    └── devcontainer.json      # バックエンド専用(DBあり)

チームメンバーはプロジェクトを開くときに環境を選択できます。

SSHキーとGitでの作業

Git操作のためにSSHキーをマウントしてください:

{
  "mounts": [
    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/node/.ssh,readonly,type=bind"
  ],
  "postCreateCommand": "ssh-add ~/.ssh/id_ed25519 || true"
}

カスタム環境ファイル

環境固有の設定を読み込む:

{
  "runArgs": ["--env-file", ".devcontainer/.env"]
}

.devcontainer/.env:

API_KEY=dev_key_here
DEBUG=true
LOG_LEVEL=debug

🔧 一般的なトラブルシューティング

コンテナが起動しない

エラー: Dockerデーモンに接続できません

解決策:

  • Docker Desktopが動作していることを確認
  • Linuxでは: sudo systemctl status docker
  • DockerがPATHに含まれているか確認: docker --version

macOS/Windowsでのパフォーマンスが遅い

問題: ファイル操作が遅い

解決策:

  1. node_modulesvenv などにネームドボリュームを使用

  2. Docker Desktopの設定でファイル共有を有効

  3. cached または delegated マウントオプションを使用:

    "workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=cached"
    

拡張機能がインストールされない

問題: devcontainer.json に指定された拡張機能がインストールされない

解決策:

  1. コンテナを再構築: Dev Containers: Rebuild Container
  2. 拡張機能IDが正しいか確認
  3. 拡張機能がリモートコンテナをサポートしているか確認(ほとんどの拡張機能はサポートしています)

ポートが既に使用されている

エラー: ポート3000はすでに割り当てられています

解決策:

  1. 競合中のコンテナを停止: docker psdocker stop <コンテナ>
  2. forwardPorts でポートマッピングを変更
  3. ディナミックポートを使用: VS Codeが利用可能なポートを自動的に割り当てます

Dockerfileの変更が反映されない

問題: Dockerfileを変更したが変更が反映されない

解決策: キャッシュなしで再構築:

Dev Containers: Rebuild Container Without Cache

コンテナがすぐに終了

問題: コンテナが起動してすぐに終了

解決策: docker-compose.yml にコマンドを追加して実行を維持:

command: sleep infinity

または devcontainer.json に:

{
  "overrideCommand": true
}

✅ 結論

VS CodeのDev Containersは、開発ワークフローに一貫性、シンプルさ、自動化をもたらします。複雑で脆い設定をコードで定義された環境に変えることで、あなたのマシンやオペレーティングシステムに関係なく、すべてが 動作 します。

重要なポイント:

  • 🎯 「私のマシンでは動く」問題を解決 — すべての人が同じ環境を使用
  • 🚀 オンボーディングが速い — 新規チームメンバーが数分で生産的になる
  • 🔒 セキュリティが向上 — 依存関係をホストシステムから分離
  • 📦 移動性が高まる — 環境がコードとともに移動
  • 🤝 チームの一貫性 — 依存関係のバージョン競合がなくなる
  • 🔄 CI/CDとのパリティ — 開発と継続的統合で同じイメージを使用

単純なPythonスクリプトから複雑なマイクロサービスアーキテクチャ(複数のデータベースを含む)まで、Dev Containersは現代の開発に堅牢な基盤を提供します。

複数言語プロジェクトに協力、オープンソースリポジトリに貢献、頻繁に新規開発者をオンボーディング、または単にクリーンで再現可能な開発環境が必要な場合 — Dev Containersはあなたのスタックに必須のツールです

小さなステップから始めてください: 次のプロジェクトでDev Containersを試してみてください。一度その利点を経験すると、それまでに開発していた方法がどうだったかを疑問に思います。


📚 有用なリソースと関連記事

公式ドキュメント:

このサイトの関連記事: