參加你附近的 ，瞭解 VS Code 中的 AI 輔助開發。

Java 格式化與 Linting

由 Red Hat 提供的 Language Support for Java™ 也提供了格式化設定。你可以匯出一個 Eclipse 格式化檔案，然後在 VS Code 中用於你的專案。

此外，還有 Checkstyle for Java 和 SonarLint 擴充套件，它們提供了即時 linting 和程式碼分析的功能。

格式化工具

你可以使用 Format Document 命令來格式化一個 Java 檔案。如果你之前沒有指定格式化配置檔案，Java 檔案將使用預設設定進行格式化。

應用格式化設定

你可以輕鬆地應用來自現有 Eclipse 方案中的格式化配置檔案。例如，如果你想為你的 Java 專案應用 Google 風格，那麼你可以在 settings.json 中設定以下屬性：

"java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",

該屬性可以設定為一個 URL 或一個本地檔案路徑。如果格式化 XML 檔案包含多個配置檔案，你可以指定配置檔案的名稱。

"java.format.settings.profile": "GoogleStyle",

設定好格式化配置檔案後，Format Document 命令將使用指定的配置檔案來格式化你的 Java 檔案。

編輯格式化設定

Extension Pack for Java 提供了一個編輯器來幫助使用者編輯現有的格式化配置檔案。你可以透過命令 Java: Open Java Formatter Settings with Preview 開啟該編輯器。在編輯器中，你可以更改格式化設定並預覽效果。儲存當前編輯器後，更改將被儲存到格式化配置檔案中。

注意：格式化設定編輯器僅支援本地格式化配置檔案。如果你的工作區包含遠端格式化配置檔案，它會引導你將其下載到 .vscode 資料夾中。

在編輯器中編輯設定時，你可以在右側的 Preview 面板中預覽更改的效果。

你也可以撤銷和重做更改。

SonarLint

SonarLint 是一個易於使用的擴充套件，可以幫助你在編碼時發現並修復錯誤和安全問題。該擴充套件在後臺執行，就像拼寫檢查器一樣，高亮顯示存在質量或安全問題的原始碼。該擴充套件不僅告訴你問題是什麼，還提供了上下文指導，解釋其危害以及如何修復，並附帶示例。該擴充套件支援超過 500+ 條 Java 規則，幷包含多個快速修復，以自動修復某些質量問題。

即時程式碼分析

問題會直接在編輯器中高亮顯示，懸停時會提供詳細的解釋。

在開啟的檔案中發現的問題也可以透過 VS Code 的“問題”面板進行審查。在適用的情況下，會提及次要程式碼位置，以便你瞭解問題的根源（例如，導致錯誤的具體程式碼路徑）。

規則文件和修復指南

對於任何檢測到的問題，SonarLint 都會提供關於所違反規則的完整文件，以及其相關的最佳編碼實踐。這可以讓你理解為什麼會產生問題，以及如何修復它。

啟用更多的質量和安全規則

預設情況下，SonarLint 提供了大量規則來檢測錯誤和漏洞。可以透過 SonarLint Rules 檢視啟用更多檢查。

有關 SonarLint for VS Code 擴充套件的更多詳細資訊，請訪問 SonarLint 網站。

Checkstyle

透過 Checkstyle for Java 擴充套件，你可以為你的專案使用現有的 checkstyle 配置（Google 或 Sun 的檢查）或你自己的自定義檔案。在編輯 Java 檔案時，該擴充套件會檢查檔案格式，並在可能的情況下即時提供快速修復。

使用 Checkstyle: Set the Checkstyle Configuration File 命令設定 Checkstyle 配置檔案，並從下拉列表中選擇 Checkstyle 檔案。

Checkstyle for Java 擴充套件支援即時 linting。

以及批次檢查。

當你點選狀態列中的 Checkstyle 狀態圖示時，“問題”面板將會開啟。

設定 Checkstyle 配置檔案

要設定配置檔案，右鍵單擊 .xml 檔案並選擇 Set the Checkstyle Configuration File。

Set Checkstyle configuration file

你也可以觸發 Checkstyle: Set Checkstyle Configuration File 命令，在檔案瀏覽器中選擇配置檔案。該擴充套件會在你的工作區中查詢 checkstyle.xml 檔案，以簡化 Checkstyle 的配置。你還會看到兩個內建配置：

  • Google's Check
  • Sun's Check

Checkstyle: Set the Checkstyle Configuration 命令會檢測潛在的 Checkstyle 配置檔案並列出它們。你也可以透過在輸入框中直接寫入 URL 來提供一個配置檔案。

你還可以使用 Checkstyle: Set the Checkstyle Version 命令來設定 Checkstyle 的版本。

該命令將會：

  • 列出主倉庫中最新的 Checkstyle 版本。
  • 列出所有已下載的版本。
  • 列出所有支援的版本。
  • 用一個勾號標記當前正在使用的版本。

此外，你還可以透過配置其路徑來為 Checkstyle 引入任何第三方模組。例如，使用下面的配置後，你可以在 checkstyle.xml 中新增 <module name="SingleBreakOrContinueCheck"/> 或 <module name="com.github.sevntu.checkstyle.checks.naming.SingleBreakOrContinueCheck"/> 來使用這些檢查。

"java.checkstyle.modules": [ "${workspaceFolder}/src/main/resources/sevntu-checks-1.35.0.jar" ]

檢查風格並修復違規問題

在編輯 Java 檔案時，該擴充套件會檢查檔案格式，並在可能的情況下提供快速修復。你可以點選編輯器中的燈泡按鈕來顯示可用的快速修復。

Fix style violation

有關 Checkstyle for Java 的更多詳細資訊，請訪問其 GitHub 倉庫。

12/12/2021