VS Code 中的 Java 構建工具
本文件概述瞭如何在 Visual Studio Code 中使用 Java 構建工具。它涵蓋了 Maven for Java 和 Gradle for Java 擴充套件以及其他工具。
如果您在使用以下功能時遇到任何問題,可以透過提交問題聯絡我們。
Maven
Maven 是一種幫助您管理 Java 專案和自動化應用程式構建的軟體工具。Visual Studio Code 的 Maven for Java 擴充套件提供了完全整合的 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: Add a Dependency (或 maven.project.addDependency
) 命令來幫助向 pom.xml
新增新的依賴。該過程是互動式的。
您也可以透過專案檢視新增依賴,它會呼叫相同的 Maven 命令。
此外,VS Code 還支援以樹狀檢視顯示依賴,讓您可以在一個地方檢查專案中的所有依賴,並檢查潛在問題。
執行 Maven 命令和目標
透過右鍵單擊資源管理器中的每個 Maven 專案,您可以方便地執行 Maven 目標。
該擴充套件還保留了每個專案的目標歷史記錄,因此您可以快速重新執行上一個命令,這在執行冗長的自定義目標時非常有用。
有兩種方法可以重新執行目標
- 在命令面板中,執行 Maven: History,然後從其歷史記錄中選擇一個專案和命令。
- 右鍵單擊專案並選擇 History。然後您可以從歷史記錄中選擇上一個命令。
您還可以在設定中指定您喜歡的命令,以備將來執行。
對於您在專案中使用的每個外掛,該擴充套件還為您提供了一種輕鬆訪問每個外掛內目標的方法。
要除錯 Maven 目標,請右鍵單擊一個目標並開始除錯。Maven 擴充套件將使用正確的引數呼叫 Java 偵錯程式。這是一個方便、省時的功能。
從 Maven Archetype 生成專案
此擴充套件提供的另一個便捷功能是從 Archetype 生成 Maven 專案。該擴充套件會載入本地/遠端目錄中列出的 Archetype。選擇後,擴充套件會將 mvn archetype:generate -D...
傳送到終端。
建立 Maven 專案有幾種方法
-
在 Maven 資源管理器中,選擇 + 建立 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 構建伺服器 (Build) 輸出通道中檢視 Gradle 構建輸出,並在 Gradle 構建伺服器 (Log) 輸出通道中跟蹤 VS Code 與 Gradle 構建伺服器之間的互動。
將測試委託給 Gradle
該擴充套件支援將測試執行委託給 Gradle。您可以在測試資源管理器中配置要使用的測試配置檔案。
注意:請確保您已安裝 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 擴充套件。
後續步驟
繼續閱讀以瞭解更多關於