Java 格式化和代码检查
Red Hat 的 Java 语言支持也提供了格式化设置。您可以导出 Eclipse 格式化文件,然后将其用于 VS Code 中的项目。
此外,还有 Checkstyle for Java 和 SonarLint 扩展,它们提供了实时代码检查和代码分析功能。
格式化工具
您可以使用 格式化文档 命令来格式化 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",
设置格式化配置文件后,格式化文档 命令将使用特定配置文件来格式化您的 Java 文件。
编辑格式化设置
Java 扩展包 提供了一个编辑器,帮助用户编辑现有格式化配置文件。您可以使用命令 Java:使用预览打开 Java 格式化设置 来打开编辑器。在编辑器中,您可以更改格式化设置并预览效果。保存当前编辑器后,更改将保存到格式化配置文件中。
注意:格式化设置编辑器仅支持本地格式化配置文件。如果您的工作区包含远程格式化配置文件,它将引导您将其下载到
.vscode
文件夹中。
在编辑器中编辑设置时,您可以在右侧的 预览 面板中预览更改的效果。
您还可以撤销和重做更改。
SonarLint
SonarLint 是一个易于使用的扩展,可帮助您在编写代码时查找和修复错误以及安全问题。该扩展在后台运行,就像拼写检查器一样,突出显示存在质量或安全问题的源代码。该扩展不仅会告诉您问题是什么,还会提供上下文指导,解释其危害以及如何修复,并附带示例。该扩展支持超过 500 多条 Java 规则,并包含多个 快速修复,可自动修复某些质量问题。
即时代码分析
问题直接在编辑器中高亮显示,并提供悬停提示以提供详细解释。
在打开的文件中发现的问题也可以通过 VS Code 的“问题”面板进行查看。在适用的情况下,会提及次要代码位置,以便您了解问题的来源(例如,导致错误的路径)。
规则文档和修复指南
对于检测到的任何问题,SonarLint 提供关于违反规则的完整文档,以及其相关的最佳编码实践。这使您能够理解为什么会引发问题以及如何修复它。
启用更多质量和安全规则
默认情况下,SonarLint 提供广泛的规则来检测错误和漏洞。可以通过 SonarLint 规则 视图启用更多检查。
有关 适用于 VS Code 的 SonarLint 扩展 的更多详细信息,请访问 SonarLint 网站。
Checkstyle
通过 Checkstyle for Java 扩展,您可以使用现有的 checkstyle
配置(Google 或 Sun 的检查)或您自己的自定义文件来检查您的项目。在编辑 Java 文件时,该扩展将检查文件格式,并尽可能即时提供快速修复。
使用 Checkstyle:设置 Checkstyle 配置文件 命令设置 Checkstyle 配置文件,并从下拉列表中选择 Checkstyle 文件。
Checkstyle for Java 扩展支持实时代码检查。
以及批量检查。
当您单击状态栏中的 Checkstyle 状态图标时,“问题”面板将打开。
设置 Checkstyle 配置文件
要设置配置文件,请右键单击 .xml
文件并选择 设置 Checkstyle 配置文件。
您还可以触发命令 Checkstyle:设置 Checkstyle 配置文件 以在文件资源管理器中选择配置文件。该扩展会在您的工作区中查找 checkstyle.xml
文件,以方便 Checkstyle 配置。您还会看到两个内置配置:
- Google 检查
- Sun 检查
命令 Checkstyle:设置 Checkstyle 配置 会检测潜在的 Checkstyle 配置文件并列出它们。您还可以通过直接在输入框中写入 URL 来提供配置文件。
您还可以使用命令 Checkstyle:设置 Checkstyle 版本 来设置 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 仓库。