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