🚀 在 VS Code 中免費取得

VS Code 中的 Java 建置工具

本文概述如何在 Visual Studio Code 中使用 Java 建置工具。內容涵蓋 Maven for JavaGradle for Java 擴充功能,以及其他工具。

如果您在使用下列功能時遇到任何問題,可以提出 issue 與我們聯絡。

Maven

Maven 是一種軟體工具,可協助您管理 Java 專案並自動化應用程式建置作業。Visual Studio Code 的 Maven for Java 擴充功能提供完整整合的 Maven 支援,讓您可以瀏覽 Maven 專案、執行 Maven 命令,以及執行建置生命週期和外掛程式的目標。我們建議您安裝 Extension Pack for Java,其中包含 Maven 支援和其他重要的 Java 開發功能。

安裝 Extension Pack for Java

探索 Maven 專案

載入 Maven 專案後,擴充功能將會啟用,並自動掃描工作區中的 pom.xml 檔案,並在側邊欄中顯示所有 Maven 專案及其模組。

Maven Explorer

解析不明類型

Maven 擴充功能也支援搜尋 Maven Central,以解析原始碼中的不明類型。您可以選取滑鼠停留在上方時顯示的 [解析不明類型] 連結來執行此操作。

使用 POM.xml

此擴充功能提供程式碼片段和自動完成功能,可根據本機 Maven 存放庫新增 Maven 相依性。瞭解使用這些便利功能將新相依性新增至 pom.xml 有多麼容易。

此擴充功能也可讓您產生有效的 POM。

您也可以使用命令 Maven: Add a Dependency (或 maven.project.addDependency) 來協助將新的相依性新增至 pom.xml。此程序是互動式的。

您也可以透過專案檢視新增相依性,這會呼叫相同的 Maven 命令。

此外,VS Code 也支援在樹狀檢視中顯示相依性,讓您可以一處檢查專案中的所有相依性,並檢查潛在問題。

執行 Maven 命令和目標

在 Explorer 中以滑鼠右鍵按一下每個 Maven 專案,即可方便地執行 Maven 目標。

此擴充功能也會保留每個專案的目標歷程記錄,因此您可以快速重新執行先前的命令,這在您執行長時間的自訂目標時非常有用。

有兩種方式可以重新執行目標

  1. 在命令選擇區中,執行 Maven: History,然後從其歷程記錄中選取專案和命令。
  2. 以滑鼠右鍵按一下專案,然後選取 [歷程記錄]。然後您可以從歷程記錄中選取先前的命令。

您也可以在設定中指定您最愛的命令,以供日後執行。

針對您專案使用的每個外掛程式,此擴充功能也會提供您輕鬆存取每個外掛程式內目標的方式。

若要偵錯 Maven 目標,請以滑鼠右鍵按一下目標並開始偵錯。Maven 擴充功能將使用正確的參數呼叫 Java 偵錯工具。這是一項方便又省時的功能。

從 Maven Archetype 產生專案

此擴充功能提供的另一個便利功能是從 Archetype 產生 Maven 專案。此擴充功能會載入本機/遠端目錄中列出的原型。選取後,此擴充功能會將 mvn archetype:generate -D... 傳送至終端機。

有幾種方式可以建立 Maven 專案

  1. 從 Maven Explorer 中,選取 [+ 建立 Maven 專案] 按鈕。

    Create Maven Project

  2. 開啟 [命令選擇區] (⇧⌘P (Windows, Linux Ctrl+Shift+P)),搜尋 Create Java Project 命令。

  3. 以滑鼠右鍵按一下目標資料夾,然後選取 [建立 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 Dependencies

管理 Gradle 常駐程式

[Gradle 常駐程式] 檢視會顯示目前工作區的常駐程式狀態。它會列出與工作區相同版本的所有執行中 Gradle 常駐程式。您可以選擇停止特定常駐程式或此檢視中的所有常駐程式。

撰寫建置檔案

此擴充功能在 Gradle 建置檔案上提供一些實用的撰寫功能。

開啟 Groovy Gradle 檔案時,此擴充功能將會分析 Gradle 檔案並提供語意符號資訊,以提供更精確的醒目提示結果。

Gradle Highlighting

在 [大綱] 檢視中,此擴充功能提供已開啟 Gradle 檔案的文件符號,可協助您輕鬆導覽至檔案的任何部分。

Gradle Outline

如果已開啟的 Gradle 檔案中有任何語法錯誤 (遺失字元、找不到類型等),您可以在 [問題] 檢視中找到它們。

Gradle Problems

當您嘗試在 Gradle 腳本中輸入 Gradle 閉包或屬性時,此擴充功能支援 Gradle 檔案的基本自動完成功能,此擴充功能將為您建議可用的閉包或屬性。

當您嘗試宣告新的相依性時,此擴充功能將為您提供相依性候選清單。

其他資源

請造訪 Maven 擴充功能的 GitHub 存放庫,以取得其他 組態疑難排解指南

除了 Maven 之外,如果您使用 Bazel 來建置和測試專案,也有 Bazel 擴充功能

後續步驟

繼續閱讀以深入瞭解

  • Java 編輯 - 探索 VS Code 中 Java 的編輯功能。
  • Java 偵錯 - 瞭解如何使用 VS Code 偵錯 Java 專案。
  • Java 測試 - 將 VS Code 用於 JUnit 和 TestNG 案例。
  • Java 擴充功能 - 瞭解更多適用於 VS Code 的實用 Java 擴充功能。