VS Code 中的 Java 建置工具
本文概述如何在 Visual Studio Code 中使用 Java 建置工具。它涵蓋了 Maven for Java 和 Gradle for Java 擴充功能以及其他工具。
如果您在使用以下功能時遇到任何問題,可以提交 issue 來聯絡我們。
Maven
Maven 是一個軟體工具,可協助您管理 Java 專案並自動化應用程式建置。Maven for Java Visual Studio Code 擴充功能提供完整整合的 Maven 支援,讓您可以瀏覽 Maven 專案、執行 Maven 命令,以及執行建置生命週期和外掛程式的目標。我們建議安裝 Extension Pack for Java,其中包含 Maven 支援和其他重要的 Java 開發功能。
瀏覽 Maven 專案
載入 Maven 專案後,擴充功能將會啟用,並且會自動掃描工作區中的 pom.xml
檔案,並在側邊欄中顯示所有 Maven 專案及其模組。
解析不明類型
Maven 擴充功能也支援搜尋 Maven Central,以解析原始碼中的不明類型。您可以選取懸停時顯示的解析不明類型連結來執行此操作。
使用 POM.xml
此擴充功能提供程式碼片段和自動完成功能,可根據本機 Maven 儲存庫新增 Maven 依賴項目。請參閱使用這些便利功能將新依賴項目新增至 pom.xml
有多麼容易。
此擴充功能也讓您可以產生有效的 POM。
您也可以使用Maven:新增依賴項目命令 (或 maven.project.addDependency
) 來協助將新依賴項目新增至 pom.xml
。此過程是互動式的。
您也可以透過專案檢視新增依賴項目,這會呼叫相同的 Maven 命令。
此外,VS Code 也支援在樹狀檢視中顯示依賴項目,讓您可以在單一位置檢查專案中的所有依賴項目,並檢查潛在問題。
執行 Maven 命令和目標
透過在 Explorer 中按一下滑鼠右鍵按一下每個 Maven 專案,您可以方便地執行 Maven 目標。
此擴充功能也會保留每個專案的目標歷史記錄,因此您可以快速重新執行先前的命令,這在您執行長時間的自訂目標時非常有用。
有兩種方法可以重新執行目標
- 在命令面板中,執行Maven:歷史記錄,然後從其歷史記錄中選取專案和命令。
- 按一下滑鼠右鍵按一下專案,然後選取歷史記錄。然後您可以從歷史記錄中選取先前的命令。
您也可以在設定中指定您最愛的命令,以供日後執行。
對於您專案使用的每個外掛程式,此擴充功能也提供您一種簡單的方式來存取每個外掛程式中的目標。
若要偵錯 Maven 目標,請按一下滑鼠右鍵按一下目標並開始偵錯。Maven 擴充功能將會使用正確的參數呼叫 Java 偵錯工具。這是一個方便、省時的功能。
從 Maven Archetype 產生專案
此擴充功能提供的另一個便利功能是從 Archetype 產生 Maven 專案。此擴充功能會載入本機/遠端目錄中列出的原型。選取後,此擴充功能會將 mvn archetype:generate -D...
傳送至終端機。
有多種方法可以建立 Maven 專案
-
從 Maven Explorer 中,選取 + 建立 Maven 專案按鈕。
-
開啟命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)),搜尋 建立 Java 專案 命令。
-
按一下滑鼠右鍵按一下目標資料夾,然後選取建立 Maven 專案。
Gradle
VS Code 透過 Gradle for Java 擴充功能支援 Gradle Java 專案 (不包含 Android)。此擴充功能提供數個元件來增強您的 Gradle Java 專案體驗
- Gradle 建置伺服器: Gradle 建置伺服器 用於匯入 Gradle 專案,並將建置工作委派給 Gradle 常駐程式,確保專案輸出的一致性,如同從命令列執行 Gradle 工作一樣。
- 視覺介面: 允許您檢視和管理 Gradle 工作和專案依賴項目,並直接在 VS Code 內執行 Gradle 工作。
- Gradle 語言伺服器: 為 Gradle 建置檔案提供改良的撰寫體驗,包括語法醒目提示、錯誤報告和自動完成。
Gradle 建置伺服器
預設情況下,如果您已安裝 Gradle for Java 擴充功能,則會使用 Gradle 建置伺服器來匯入 Gradle 專案。您可以透過設定 java.gradle.buildServer.enabled
來切換 Gradle 建置伺服器的開啟或關閉狀態。
您可以在 Gradle 建置伺服器 (建置) 輸出通道中檢視 Gradle 建置輸出,並在 Gradle 建置伺服器 (記錄) 輸出通道中追蹤 VS Code 與 Gradle 建置伺服器之間的互動。
將測試委派給 Gradle
此擴充功能支援將測試執行委派給 Gradle。您可以在測試 Explorer 中設定您想要使用的測試設定檔。
注意:請確定您已安裝 Test Runner for Java 擴充功能以使用此功能。
使用 Gradle 工作
當您在 VSCode 中開啟 Gradle 專案時,您可以按一下 Gradle 側邊欄項目來尋找一些有用的 Gradle 檢視。Gradle 專案檢視會列出在工作區中找到的所有 Gradle 專案。您可以在此處檢視、執行或偵錯 Gradle 工作。
當工作區中有許多 Gradle 工作時,可能很難找到特定的工作。此擴充功能提供已釘選的工作檢視,以協助您釘選您最愛的工作,以便您可以輕鬆地在個別檢視中找到它們。您也可以在最近的工作檢視中看到最近執行的工作。
檢視 Gradle 依賴項目
在Gradle 專案檢視中,您可以在每個 Gradle 專案項目下找到依賴項目項目。它包含您指定設定中的所有依賴項目,您可以輕鬆檢查專案的依賴項目狀態。
管理 Gradle 常駐程式
Gradle 常駐程式檢視會顯示目前工作區的常駐程式狀態。它會列出與工作區相同版本中的所有執行中 Gradle 常駐程式。您可以選擇停止此檢視中的特定常駐程式或所有常駐程式。
撰寫建置檔案
此擴充功能在 Gradle 建置檔案上提供一些有用的撰寫功能。
開啟 Groovy Gradle 檔案時,此擴充功能將會分析 Gradle 檔案並提供語意權杖資訊,提供更精確的醒目提示結果。
在大綱檢視中,此擴充功能提供已開啟 Gradle 檔案的文件符號,這可以協助您輕鬆導覽至檔案的任何部分。
如果已開啟的 Gradle 檔案中有任何語法錯誤 (遺失字元、找不到類型等),您可以在問題檢視中找到它們。
此擴充功能支援 Gradle 檔案的基本自動完成功能,當您嘗試在 Gradle 指令碼中輸入 Gradle 封閉或屬性時,此擴充功能將會建議可用的封閉或屬性供您使用。
當您嘗試宣告新的依賴項目時,此擴充功能將會為您提供依賴項目候選清單。
其他資源
請造訪 Maven 擴充功能的 GitHub 存放庫 以取得其他組態和疑難排解指南。
除了 Maven 之外,如果您使用 Bazel 來建置和測試專案,還有 Bazel 擴充功能。
後續步驟
繼續閱讀以深入瞭解