VS Code環境構築（Mac/Windows）

VS CodeでのJava開発環境構築

Visual Studio Code（VS Code）を使用したJava開発環境の構築手順を、Mac版とWindows版それぞれについて詳しく解説します。

前提条件

VS Codeがインストールされていること
JDKがインストールされていること（Java 17以上推奨）

Mac版の環境構築

ステップ1: JDKのインストールと確認

Homebrewを使用する場合（推奨）:

# OpenJDK 17をインストール
brew install openjdk@17

# または、OpenJDK 21をインストール
brew install openjdk@21

# インストール確認
java -version
javac -version

環境変数の設定:

# ~/.zshrc（または~/.bash_profile）に追加
export JAVA_HOME=$(/usr/libexec/java_home -v 17)
export PATH="$JAVA_HOME/bin:$PATH"

# 設定を反映
source ~/.zshrc  # zshを使用している場合
# または
source ~/.bash_profile  # bashを使用している場合

# 確認
echo $JAVA_HOME

手動でJAVA_HOMEを設定する場合:

# インストールされているJavaのバージョンを確認
/usr/libexec/java_home -V

# 特定のバージョンをJAVA_HOMEに設定
export JAVA_HOME=$(/usr/libexec/java_home -v 17)

ステップ2: VS Codeの拡張機能のインストール

VS Codeを起動し、以下の拡張機能をインストールします：

必須拡張機能:

Extension Pack for Java（Microsoft）
- 拡張機能ID: vscjava.vscode-java-pack
- このパックには以下が含まれます：
  - Language Support for Java by Red Hat
  - Debugger for Java
  - Test Runner for Java
  - Maven for Java
  - Project Manager for Java
  - Visual Studio IntelliCode

推奨拡張機能:

Spring Boot Extension Pack（VMware）
- 拡張機能ID: vmware.vscode-spring-boot
- Spring Boot開発に特化した機能を提供
Spring Boot Tools（VMware）
- 拡張機能ID: vmware.vscode-spring-boot-dashboard
Spring Initializr Java Support（VMware）
- 拡張機能ID: vmware.vscode-spring-initializr

インストール方法:

# コマンドラインからインストール（オプション）
code --install-extension vscjava.vscode-java-pack
code --install-extension vmware.vscode-spring-boot
code --install-extension vmware.vscode-spring-boot-dashboard
code --install-extension vmware.vscode-spring-initializr

または、VS Codeの拡張機能タブ（Cmd + Shift + X）から検索してインストールします。

ステップ3: VS Codeの設定

settings.jsonの設定:

VS Codeの設定を開き（Cmd + ,）、以下の設定を追加します：

{
  // Java設定
  "java.configuration.updateBuildConfiguration": "automatic",
  "java.compile.nullAnalysis.mode": "automatic",
  "java.configuration.runtimes": [
    {
      "name": "JavaSE-17",
      "path": "/Library/Java/JavaVirtualMachines/openjdk-17.jdk/Contents/Home",
      "default": true
    }
  ],

  // フォーマッター設定
  "java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",
  "java.format.settings.profile": "GoogleStyle",

  // インポートの自動整理
  "java.completion.importOrder": [
    "java",
    "javax",
    "org",
    "com"
  ],

  // Maven設定
  "java.configuration.maven.userSettings": null,

  // テスト設定
  "java.test.config": {
    "workingDirectory": "${workspaceFolder}"
  },

  // ファイルエクスプローラー設定
  "files.exclude": {
    "**/.classpath": true,
    "**/.project": true,
    "**/.settings": true,
    "**/.factorypath": true
  }
}

JAVA_HOMEの確認:

VS Codeの統合ターミナルで確認：

echo $JAVA_HOME
java -version

ステップ4: プロジェクトの作成と開く

Spring Initializrを使用（VS Code内から）:

VS Codeのコマンドパレットを開く（Cmd + Shift + P）
「Spring Initializr: Create a Maven Project」または「Spring Initializr: Create a Gradle Project」を選択
プロジェクトの設定を入力：
- Spring Bootバージョン: 3.1.0（または最新のLTS）
- 言語: Java
- グループID: com.example
- アーティファクトID: my-app
- パッケージング: Jar
- Javaバージョン: 17
- 依存関係: Spring Web, Spring Data JPA, PostgreSQL Driver
プロジェクトの保存場所を選択

既存のプロジェクトを開く:

# ターミナルから
cd /path/to/your/project
code .

または、VS Codeの「ファイル」→「フォルダーを開く」からプロジェクトフォルダを選択します。

ステップ5: 動作確認

プロジェクトのビルド:

VS Codeの統合ターミナル（Ctrl + `）で：

# Mavenプロジェクトの場合
./mvnw clean install

# Gradleプロジェクトの場合
./gradlew build

アプリケーションの実行:

src/main/java/com/example/myapp/MyAppApplication.javaを開く
mainメソッドの左側にある「実行」ボタンをクリック
または、コマンドパレット（Cmd + Shift + P）から「Java: Run Java」を選択

デバッグ:

ブレークポイントを設定（行番号の左側をクリック）
mainメソッドの左側にある「デバッグ」ボタンをクリック
または、F5キーを押してデバッグを開始

Windows版の環境構築

ステップ1: JDKのインストールと確認

方法1: Oracle JDKをインストール

Oracle JDKダウンロードページにアクセス
Windows版のJDK 17または21をダウンロード
インストーラーを実行してインストール
インストール先を確認（通常は C:\Program Files\Java\jdk-17）

方法2: OpenJDKをインストール（推奨）

Adoptium（Eclipse Temurin）にアクセス
Windows版のJDK 17または21をダウンロード
インストーラーを実行してインストール

環境変数の設定:

「システムのプロパティ」を開く
- Windowsキー + R → sysdm.cpl → Enter
- または、「設定」→「システム」→「詳細情報」→「システムの詳細設定」
「環境変数」ボタンをクリック
「システム環境変数」セクションで「新規」をクリック
変数名: JAVA_HOME
変数値: JDKのインストールパス（例: C:\Program Files\Java\jdk-17）
「OK」をクリック
Path変数を選択して「編集」をクリック
「新規」をクリックして %JAVA_HOME%\bin を追加
「OK」をクリックしてすべてのダイアログを閉じる

確認（コマンドプロンプトまたはPowerShell）:

java -version
javac -version
echo %JAVA_HOME%

java -version
javac -version
$env:JAVA_HOME

PowerShellで一時的に設定する場合:

# 現在のセッションのみ有効
$env:JAVA_HOME = "C:\Program Files\Java\jdk-17"
$env:Path = "$env:JAVA_HOME\bin;$env:Path"

ステップ2: VS Codeの拡張機能のインストール

Mac版と同様に、以下の拡張機能をインストールします：

必須拡張機能:

Extension Pack for Java（Microsoft）
- 拡張機能ID: vscjava.vscode-java-pack

推奨拡張機能:

Spring Boot Extension Pack（VMware）
Spring Boot Tools（VMware）
Spring Initializr Java Support（VMware）

インストール方法:

# PowerShellからインストール（オプション）
code --install-extension vscjava.vscode-java-pack
code --install-extension vmware.vscode-spring-boot
code --install-extension vmware.vscode-spring-boot-dashboard
code --install-extension vmware.vscode-spring-initializr

または、VS Codeの拡張機能タブ（Ctrl + Shift + X）から検索してインストールします。

ステップ3: VS Codeの設定

settings.jsonの設定:

VS Codeの設定を開き（Ctrl + ,）、以下の設定を追加します：

{
  // Java設定
  "java.configuration.updateBuildConfiguration": "automatic",
  "java.compile.nullAnalysis.mode": "automatic",
  "java.configuration.runtimes": [
    {
      "name": "JavaSE-17",
      "path": "C:\\Program Files\\Java\\jdk-17",
      "default": true
    }
  ],

  // フォーマッター設定
  "java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",
  "java.format.settings.profile": "GoogleStyle",

  // インポートの自動整理
  "java.completion.importOrder": [
    "java",
    "javax",
    "org",
    "com"
  ],

  // Maven設定
  "java.configuration.maven.userSettings": null,

  // テスト設定
  "java.test.config": {
    "workingDirectory": "${workspaceFolder}"
  },

  // ファイルエクスプローラー設定
  "files.exclude": {
    "**/.classpath": true,
    "**/.project": true,
    "**/.settings": true,
    "**/.factorypath": true
  },

  // Windows固有の設定
  "terminal.integrated.defaultProfile.windows": "PowerShell"
}

注意: java.configuration.runtimesのpathは、実際のJDKのインストールパスに合わせて変更してください。

JAVA_HOMEの確認:

VS Codeの統合ターミナル（Ctrl + `）で確認：

# PowerShellの場合
$env:JAVA_HOME
java -version

# コマンドプロンプトの場合
echo %JAVA_HOME%
java -version

ステップ4: プロジェクトの作成と開く

Spring Initializrを使用（VS Code内から）:

VS Codeのコマンドパレットを開く（Ctrl + Shift + P）
「Spring Initializr: Create a Maven Project」または「Spring Initializr: Create a Gradle Project」を選択
プロジェクトの設定を入力（Mac版と同様）
プロジェクトの保存場所を選択

既存のプロジェクトを開く:

# PowerShellから
cd C:\path\to\your\project
code .

または、VS Codeの「ファイル」→「フォルダーを開く」からプロジェクトフォルダを選択します。

ステップ5: 動作確認

プロジェクトのビルド:

VS Codeの統合ターミナル（Ctrl + `）で：

# Mavenプロジェクトの場合
.\mvnw.cmd clean install

# Gradleプロジェクトの場合
.\gradlew.bat build

アプリケーションの実行:

src/main/java/com/example/myapp/MyAppApplication.javaを開く
mainメソッドの左側にある「実行」ボタンをクリック
または、コマンドパレット（Ctrl + Shift + P）から「Java: Run Java」を選択

デバッグ:

ブレークポイントを設定（行番号の左側をクリック）
mainメソッドの左側にある「デバッグ」ボタンをクリック
または、F5キーを押してデバッグを開始

共通の設定とトラブルシューティング

VS Codeのワークスペース設定

プロジェクトルートに .vscode/settings.json を作成して、プロジェクト固有の設定を行います：

{
  "java.configuration.runtimes": [
    {
      "name": "JavaSE-17",
      "path": "/Library/Java/JavaVirtualMachines/openjdk-17.jdk/Contents/Home",
      "default": true
    }
  ],
  "java.project.sourcePaths": ["src/main/java"],
  "java.project.outputPath": "target/classes",
  "java.project.referencedLibraries": [
    "lib/**/*.jar"
  ]
}

よくある問題と解決策

問題1: Java拡張機能がJDKを認識しない

解決策:

VS Codeのコマンドパレット（Cmd/Ctrl + Shift + P）を開く
「Java: Configure Java Runtime」を選択
JDKのパスを手動で設定

または、settings.jsonに以下を追加：

{
  "java.home": "/Library/Java/JavaVirtualMachines/openjdk-17.jdk/Contents/Home"  // Mac
  // または
  "java.home": "C:\\Program Files\\Java\\jdk-17"  // Windows
}

問題2: Maven/Gradleプロジェクトが認識されない

解決策:

コマンドパレット（Cmd/Ctrl + Shift + P）を開く
「Java: Clean Java Language Server Workspace」を実行
VS Codeを再起動

問題3: インポートが自動で解決されない

解決策:

{
  "java.completion.importOrder": [
    "java",
    "javax",
    "org",
    "com"
  ],
  "java.saveActions.organizeImports": true
}

問題4: ビルドエラーが表示されない

解決策:

コマンドパレット（Cmd/Ctrl + Shift + P）を開く
「Java: Rebuild Projects」を実行

問題5: デバッグが動作しない

解決策:

.vscode/launch.jsonを作成：

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "java",
      "name": "Launch Current File",
      "request": "launch",
      "mainClass": "${file}"
    },
    {
      "type": "java",
      "name": "Launch Spring Boot App",
      "request": "launch",
      "mainClass": "com.example.myapp.MyAppApplication",
      "projectName": "my-app",
      "args": "",
      "envFile": "${workspaceFolder}/.env"
    }
  ]
}

便利なショートカット

Mac:

Cmd + Shift + P: コマンドパレット
Cmd + P: ファイル検索
Cmd + Shift + O: シンボル検索
Cmd + .: クイックフィックス
F5: デバッグ開始
F9: ブレークポイントの切り替え

Windows:

Ctrl + Shift + P: コマンドパレット
Ctrl + P: ファイル検索
Ctrl + Shift + O: シンボル検索
Ctrl + .: クイックフィックス
F5: デバッグ開始
F9: ブレークポイントの切り替え

推奨ワークフロー

プロジェクトの作成: Spring Initializrを使用してプロジェクトを作成
拡張機能のインストール: 必須拡張機能をインストール
設定の確認: settings.jsonでJava設定を確認
プロジェクトのビルド: 統合ターミナルでビルドを実行
コードの記述: 自動補完とリファクタリング機能を活用
デバッグ: ブレークポイントを設定してデバッグ実行
テスト: Test Runner拡張機能を使用してテストを実行

次のステップ

VS Codeでの環境構築が完了したら、以下のステップに進みます：

プロジェクト構造の理解: フォルダ構成を確認
基本的なアノテーション: Spring Bootのアノテーションを学ぶ
REST APIの作成: コントローラーを作成してAPIエンドポイントを実装
データベース接続: JPAを使用してデータベースに接続

VS CodeでのJava開発環境が整いました。快適な開発を始めましょう！