【保存版】Visual Studio CodeでJava開発を始める完全ガイド2024 – 環境構築から実践的な使い方まで

1.1 従来のIDEと比較したVS Codeの強み

　　● ピーク時でも1GB未満を維持

   # インストーラーを実行後、以下の環境変数を設定
   JAVA_HOME = C:\Program Files\Java\jdk-21
   Path = %JAVA_HOME%\bin

   # Homebrewを使用する場合
   brew install openjdk@21

   # 環境変数の設定
   export JAVA_HOME=$(/usr/libexec/java_home -v 21)

   java -version
   javac -version

{
    "java.home": "【JDKのパス】",
    "java.configuration.updateBuildConfiguration": "automatic",
    "java.completion.importOrder": [
        "java",
        "javax",
        "org",
        "com"
    ],
    "java.format.settings.url": ".vscode/java-formatter.xml",
    "java.format.settings.profile": "GoogleStyle",
    "editor.formatOnSave": true,
    "java.compile.nullAnalysis.mode": "automatic",
    "java.configuration.maven.userSettings": "【Mavenの設定ファイルパス】",
    "java.jdt.ls.java.home": "【JDKのパス】"
}

   # プロジェクトのクリーン
   mvn clean

   # .settingsフォルダの削除
   rm -rf .settings

   # プロジェクトの再読み込み
   # VS Code: Ctrl+Shift+P → Java: Clean Java Language Server Workspace

   // settings.jsonに追加
   {
    "java.jdt.ls.vmargs": "-XX:+UseParallelGC -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xmx2G -Xms100m"
   }

  {
    "extensions.autoUpdate": true,
    "java.semanticHighlighting.enabled": true
  }

{
  "files.exclude": {
    "**/.classpath": true,
    "**/.project": true,
    "**/.settings": true,
    "**/.factorypath": true
  }
}

{
  "java.autobuild.enabled": true,
  "files.watcherExclude": {
    "**/target/**": true
  }
}

   Java: Create Java Project

   # プロジェクトのルートディレクトリを開く
   File -> Open Folder

   # 自動的にpom.xmlが認識される
   # 必要に応じて以下を実行
   Maven: Update Project

   # build.gradleファイルが存在するディレクトリを開く
   # 自動的にGradleプロジェクトとして認識される

   // 入力途中で自動提案
   String str = new Str|  // StringBufferやStringBuilderなどが候補表示

   // メソッド呼び出し時のパラメータ情報
   str.substring|  // メソッドのオーバーロード情報が表示

   // 変数の型推論
   var list = new ArrayList<String>();  // 型が自動的に推論される
   list.add("|");  // String型のメソッドが候補表示

   // 'sysout' + Tab
   System.out.println();

   // 'fori' + Tab
   for (int i = 0; i < array.length; i++) {}

   // 'psvm' + Tab
   public static void main(String[] args) {}

   public void processData(String input) {
       // ここにブレークポイントを設定
       String processed = input.trim();
       if (processed.isEmpty()) {
           return;
       }
       // 処理続行
   }

   // デバッグ中に式を評価
   // VARIABLES ビューで変数の値を監視
   // WATCH ビューで式を追加
   map.get("key")  // 式の結果がリアルタイムで表示
   list.stream().filter(s -> s.length() > 5).count()  // 複雑な式も評価可能

   // ブレークポイントを右クリック→Edit Breakpoint
   // 条件式を設定
   i > 100 && list.isEmpty()  // この条件が真の時のみ停止

   // ブレークポイントを右クリック→Edit Breakpoint
   // メッセージを設定
   "Current value: {variable}"  // 変数の値をログ出力

   // ブレークポイントを右クリック→Edit Breakpoint
   // Hit Count を設定
   // 指定回数目の実行時のみ停止

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "java",
            "name": "Debug Current File",
            "request": "launch",
            "mainClass": "${file}",
            "vmArgs": "-Xmx512m",
            "env": {
                "ENV": "development"
            }
        }
    ]
}

// 1. リファクタリング操作
Alt + Enter        // クイックフィックスとリファクタリングの提案
Ctrl + Alt + M     // メソッドの抽出
Ctrl + Alt + V     // 変数の抽出
F2                 // 変数名の一括リネーム

// 2. コード生成
Alt + Insert       // コンストラクタ、getter/setter等の生成
Ctrl + O           // メソッドのオーバーライド
Ctrl + I           // インターフェースメソッドの実装

// keybindings.json
[
    {
        "key": "ctrl+alt+t",
        "command": "java.test.generateTests",
        "when": "editorLangId == 'java'"
    },
    {
        "key": "ctrl+alt+d",
        "command": "java.debug.debugJavaFile",
        "when": "editorLangId == 'java'"
    }
]

# ソース管理ビューで変更を確認（Ctrl+Shift+G）
- 変更ファイルの横の「+」をクリック：ステージング
- 「-」をクリック：ステージング解除
- D で差分表示

   # メッセージを入力してCtrl+Enterでコミット
   # ステータスバーの同期ボタンでプッシュ/プル

   # ステータスバーのブランチ名をクリック
   # - 新規ブランチ作成
   # - ブランチ切り替え
   # - マージ操作

// settings.json
{
    "gitlens.codeLens.enabled": true,
    "gitlens.currentLine.enabled": true,
    "gitlens.hovers.currentLine.over": "line",
    "gitlens.blame.compact": false
}

{
    "java.completion.postfix.enabled": true,
    "java.completion.filteredTypes": [
        "java.awt.*",
        "com.sun.*"
    ]
}

// ! 重要な警告
// ? 疑問点や検討事項
// TODO: タスク
// * 重要な情報

// Test Runner設定例
{
    "java.test.config": {
        "workingDirectory": "${workspaceFolder}",
        "vmargs": ["-ea", "-Duser.timezone=UTC"]
    },
    "java.test.defaultConfig": "default"
}

{
    "sonarlint.rules": {
        "java:S1068": false,  // 未使用フィールドの警告を無効化
        "java:S1481": true    // 未使用ローカル変数の警告を有効化
    }
}

<!-- checkstyle-config.xml -->
<module name="Checker">
    <module name="TreeWalker">
        <module name="MethodLength">
            <property name="max" value="50"/>
        </module>
    </module>
</module>

// java.json
{
    "JUnit Test Method": {
        "prefix": "test",
        "body": [
            "@Test",
            "void ${1:testName}() {",
            "    // Arrange",
            "    $2",
            "    // Act",
            "    $3",
            "    // Assert",
            "    $4",
            "}"
        ]
    },
    "Logger Declaration": {
        "prefix": "logger",
        "body": [
            "private static final Logger logger = LoggerFactory.getLogger(${1:${TM_FILENAME_BASE}}.class);"
        ]
    }
}

{
    "files.exclude": {
        "**/.classpath": true,
        "**/.project": true,
        "**/.settings": true,
        "**/.factorypath": true,
        "**/target": true
    },
    "java.completion.maxResults": 50,
    "java.autobuild.enabled": true,
    "java.configuration.updateBuildConfiguration": "automatic"
}

   // workspace.code-workspace
   {
       "folders": [
           {
               "path": "core-service",
               "name": "コアサービス"
           },
           {
               "path": "api-service",
               "name": "APIサービス"
           },
           {
               "path": "common-library",
               "name": "共通ライブラリ"
           }
       ],
       "settings": {
           "java.configuration.updateBuildConfiguration": "automatic",
           "java.compile.nullAnalysis.mode": "automatic",
           "files.exclude": {
               "**/.classpath": true,
               "**/.project": true,
               "**/.settings": true,
               "**/target": true
           }
       }
   }

project-root/
├── .vscode/                  # VS Code設定
│   ├── settings.json        # プロジェクト固有の設定
│   ├── launch.json         # デバッグ設定
│   └── extensions.json     # 推奨拡張機能
├── src/                     # ソースコード
├── tests/                   # テストコード
└── docs/                    # プロジェクトドキュメント

// settings.json
{
    "files.autoSave": "afterDelay",
    "files.autoSaveDelay": 1000,
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
        "source.organizeImports": true,
        "source.fixAll": true
    },
    "java.completion.importOrder": [
        "java",
        "javax",
        "org",
        "com"
    ],
    "java.sources.organizeImports.starThreshold": 5,
    "java.sources.organizeImports.staticStarThreshold": 3
}

<!-- eclipse-formatter.xml -->
<profiles version="13">
    <profile kind="CodeFormatterProfile" name="Custom">
        <setting id="org.eclipse.jdt.core.formatter.lineSplit" value="120"/>
        <setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
        <setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/>
        <!-- その他のフォーマット設定 -->
    </profile>
</profiles>

# .gitignore
.vscode/*
!.vscode/settings.json
!.vscode/extensions.json
!.vscode/launch.json
*.class
target/
bin/
.settings/
.classpath
.project

   // extensions.json
   {
       "recommendations": [
           "vscjava.vscode-java-pack",
           "vscjava.vscode-java-debug",
           "vscjava.vscode-java-test",
           "redhat.java",
           "ms-vscode.vscode-maven",
           "eamodio.gitlens"
       ]
   }

   // settings.json
   {
       "java.checkstyle.configuration": "${workspaceFolder}/checkstyle.xml",
       "java.format.settings.url": "${workspaceFolder}/eclipse-formatter.xml",
       "editor.rulers": [120],
       "editor.wordWrapColumn": 120,
       "editor.detectIndentation": false,
       "editor.insertSpaces": true,
       "editor.tabSize": 4
   }

// settings.json
{
    "java.jdt.ls.memory": "-Xmx2G",
    "java.configuration.runtimes": [
        {
            "name": "JavaSE-17",
            "path": "/path/to/jdk-17",
            "default": true
        }
    ],
    "java.server.launchMode": "Standard"
}

   {
       "files.exclude": {
           "**/node_modules": true,
           "**/bower_components": true,
           "**/dist": true,
           "**/coverage": true
       },
       "search.exclude": {
           "**/target": true,
           "**/build": true
       }
   }

　　● ワークスペースの適切な分割

次のステップ

最後に