Java 格式化与 Lint 代码检查
Language Support for Java™ by Red Hat 也提供了格式化设置。你可以导出 Eclipse 格式化文件,然后在 VS Code 中将其用于你的项目。
此外,还有 Checkstyle for Java 和 SonarLint 插件,它们提供了实时 Lint 代码检查和代码分析功能。
格式化工具 (Formatter)
你可以使用格式化文档 (Format Document) 命令来格式化 Java 文件。如果你之前未指定格式化配置,则 Java 文件将使用默认设置进行格式化。
应用格式化配置
你可以轻松地从现有的 Eclipse 方案格式化配置文件中应用设置。例如,如果你想为你的 Java 项目应用 Google 样式 (Google Style),则可以在 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 是一款易于使用的插件,可帮助你在编写代码时发现并修复 Bug 和安全漏洞。该插件在后台运行,就像拼写检查器一样,高亮显示存在质量或安全隐患的源代码问题。它不仅会告知你问题的具体内容,还会结合示例提供有关其危害原因及修复方法的语境引导。该插件支持 500 多条 Java 规则,并包含多个可自动修复特定质量问题的快速修复 (Quick Fixes)。
实时代码分析
问题直接在编辑器中高亮显示,悬停即可查看详细解释。
在打开文件中发现的问题也可以通过 VS Code 的“问题 (Problems)”面板进行查看。在适用情况下,系统会提示相关的二级代码位置,以便你理解问题的来源(例如导致 Bug 的代码路径)。
规则文档和修复指导
对于检测到的任何问题,SonarLint 都会提供有关违规规则的完整文档,以及与之相关的最佳编码实践。这能让你理解引发问题的原因以及如何进行修复。
启用更多质量和安全规则
默认情况下,SonarLint 提供了大量用于检测 Bug 和漏洞的规则。你可以通过 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 插件支持实时 Lint 检查。
以及批量检查。
点击状态栏中的 Checkstyle 状态图标即可打开“问题 (Problems)”面板。
设置 Checkstyle 配置文件
要设置配置文件,请右键点击 .xml 文件并选择 Set the Checkstyle Configuration File。

你也可以触发 Checkstyle: Set Checkstyle Configuration File 命令在文件资源管理器中选择配置文件。该插件会在你的工作区中查找 checkstyle.xml 文件,以简化 Checkstyle 配置。你还会看到两个内置的配置方案
- Google 的检查规则 (Google's Check)
- Sun 的检查规则 (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 文件时,插件会检查文件格式并在可能时提供快速修复。你可以点击编辑器中的灯泡图标来查看可用的快速修复。

有关 Checkstyle for Java 的更多详细信息,请访问其 GitHub 仓库。