Java 格式化和 Linting
Language Support for Java™ by Red Hat 也提供了格式化设置。你可以导出 Eclipse 格式化程序文件,然后在 VS Code 中将其用于你的项目。
此外,还有 Checkstyle for Java 和 SonarLint 扩展,它们提供了实时 linting 和代码分析功能。
格式化程序 (Formatter)
你可以使用格式化文档 (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 规则,并包含多个快速修复 (Quick Fixes) 以自动修复某些质量问题。
实时代码分析
问题直接在编辑器中高亮显示,并提供悬停提示以获取详细说明。
在打开的文件中发现的问题也可以通过 VS Code 的“问题 (Problems)”面板进行查看。在适用的情况下,会提及辅助代码位置,以便你了解问题的根源(例如,导致错误的路径)。
规则文档和补救指南
对于检测到的任何问题,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。

你也可以触发 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 模块。例如,使用以下配置后,你可以将 <module name="SingleBreakOrContinueCheck"/> 或 <module name="com.github.sevntu.checkstyle.checks.naming.SingleBreakOrContinueCheck"/> 添加到 checkstyle.xml 以使用这些检查。
"java.checkstyle.modules": [ "${workspaceFolder}/src/main/resources/sevntu-checks-1.35.0.jar" ]
检查样式并修复违规
在编辑 Java 文件时,扩展将检查文件格式并在可能的情况下提供快速修复。你可以点击编辑器中的灯泡按钮来显示可用的快速修复。

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