VSCode 與 Java 環境整合

發表於 分類於

VSCode 與 Java 環境整合

在 VSCode 中進行 Java 開發，需要完成 JDK 安裝、環境變數配置 以及 擴充套件安裝 三個核心步驟。本文將系統性地介紹從環境建置到專案運行的完整流程，幫助開發者在 VSCode 上高效進行 Java 開發。

VSCode 開發環境配置

安裝 Java 擴充套件

透過擴充套件市場（Ctrl + Shift + X）安裝以下核心套件：

擴充套件名稱 說明
Extension Pack for Java Java 開發必備套件包，內含語言支援、偵錯器、測試執行器、Maven 支援等
Spring Boot Extension Pack （選用）Spring Boot 開發工具，提供專案建立、自動完成、執行管理等功能
Gradle for Java （選用）Gradle 建置工具支援

Extension Pack for Java 是由 Microsoft 官方維護的套件包，安裝後會自動包含以下擴充套件：

  • Language Support for Java™ by Red Hat
  • Debugger for Java
  • Test Runner for Java
  • Maven for Java
  • Project Manager for Java
  • IntelliCode

配置 JDK 路徑

若 VSCode 未自動偵測到 JDK，可透過以下方式手動設定：

  1. 按下 Ctrl + Shift + P 開啟命令面板
  2. 輸入 Java: Configure Java Runtime
  3. 選擇已安裝的 JDK 路徑

或者直接在 settings.json 中加入設定：

1
2
3
{
  "java.jdt.ls.java.home": "C:\\Program Files\\Java\\jdk-17"
}

提示
若系統安裝了多個 JDK 版本，可透過 java.configuration.runtimes 進行管理：

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "java.configuration.runtimes": [
    {
      "name": "JavaSE-17",
      "path": "C:\\Program Files\\Java\\jdk-17",
      "default": true
    },
    {
      "name": "JavaSE-21",
      "path": "C:\\Program Files\\Java\\jdk-21"
    }
  ]
}

Java 專案開發與運行

建立專案

有以下兩種方式可以建立 Java 專案：

方式 操作步驟
命令面板 Ctrl + Shift + P → 輸入 Java: Create Java Project → 選擇專案類型（No build tools / Maven / Gradle）→ 指定路徑
手動建立 新增 src 目錄 → 在其中建立 .java 檔案

撰寫與運行程式碼

在 src 目錄下建立 HelloWorld.java 檔案：

1
2
3
4
5
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, VSCode!");
    }
}

運行方式：

方式 操作 適用情境
點擊 Run 點擊 main 方法上方的 Run 按鈕 快速執行，最常用
偵錯模式 切換至偵錯檢視（Ctrl + Shift + D）→ 設定中斷點 → 按 F5 啟動 需要除錯時使用
終端機編譯 javac src/HelloWorld.java → java -cp src HelloWorld 傳統命令列編譯方式

偵錯功能

VSCode 的 Java 偵錯器提供完整的除錯功能：

  • 設定中斷點：在行號左側點擊即可新增 / 移除中斷點
  • 逐步執行：F10（跳過）、F11（進入）、Shift + F11（跳出）
  • 變數檢視：在偵錯面板中即時查看變數值
  • 監看運算式：新增自訂運算式進行即時監控
  • 呼叫堆疊：檢視方法的呼叫層級

進階配置（選用）

建置工具支援

Maven

安裝 Extension Pack for Java 後即內建 Maven 支援，可透過命令面板執行以下操作：

  • Maven: Create Maven Project — 使用 archetype 建立新專案
  • Maven: Execute Commands — 執行 clean、install、package 等指令

Gradle

安裝 Gradle for Java 擴充套件後，即可支援 Gradle 專案的建置與管理。

程式碼格式化

在 settings.json 中可設定 Google Java Style 格式化規範，並啟用存檔時自動格式化：

1
2
3
4
5
6
7
{
  "java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",
  "[java]": {
    "editor.defaultFormatter": "redhat.java",
    "editor.formatOnSave": true
  }
}

若不希望每次格式化都從遠端下載設定檔，可將 eclipse-java-google-style.xml 下載至本機，改用本地路徑來降低網路流量負擔：

1
2
3
{
  "java.format.settings.url": "./config/eclipse-java-google-style.xml"
}

下載指令（以專案根目錄的 config 資料夾為例）：

1
2
mkdir -p config
curl -o config/eclipse-java-google-style.xml https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml

單元測試

Test Runner for Java（已包含在 Extension Pack for Java 中）支援以下測試框架：

  • JUnit 4 / 5
  • TestNG

可直接在測試方法上方點擊 Run Test 或 Debug Test 按鈕執行測試，測試結果會以視覺化方式呈現在側邊欄中。

常見問題處理

JDK 未被偵測

  • 確認 JAVA_HOME 環境變數已正確設定
  • 確認 Path 中包含 %JAVA_HOME%\bin
  • 在 VSCode settings.json 中手動指定 java.jdt.ls.java.home
  • 設定完成後重新啟動 VSCode

擴充套件衝突

  • 避免同時安裝多個功能重複的 Java 擴充套件
  • 若出現異常，嘗試停用所有 Java 相關擴充套件後，僅啟用 Extension Pack for Java
  • 確保擴充套件皆更新至最新版本

編譯錯誤

  • 確認類別名稱與檔案名稱一致（Java 規範要求）
  • 確認 .java 檔案位於正確的目錄結構下
  • 檢查 package 宣告是否與資料夾路徑匹配
  • 執行 Java: Clean Java Language Server Workspace 清除快取後重試