Java格式化和代码检查

Language Support for Java™ by Red Hat 还提供了 格式化设置。您可以导出一个Eclipse格式化文件,然后在VS Code中为您的项目使用它。

此外,还有Checkstyle for JavaSonarLint扩展,它们提供了实时代码检查和代码分析的功能。

格式化器

你可以使用格式化文档命令来格式化一个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 规则 视图启用更多检查。

有关SonarLint for VS Code 扩展的更多详细信息,请访问SonarLint 网站

Checkstyle

使用Checkstyle for Java扩展,您可以使用现有的checkstyle配置(Google的或Sun的Check)或您自己为项目定制的文件。在编辑Java文件时,扩展将检查文件格式,并在可能的情况下提供快速修复。

使用Checkstyle: 设置Checkstyle配置文件命令设置Checkstyle配置文件,并从下拉菜单中选择Checkstyle文件。

Checkstyle for Java 扩展支持实时代码检查。

以及批量检查。

当您点击状态栏中的Checkstyle状态图标时,问题面板将会打开。

设置Checkstyle配置文件

要设置配置文件,请右键点击.xml文件并选择设置Checkstyle配置文件

设置Checkstyle配置文件

你也可以触发命令Checkstyle: 设置Checkstyle配置文件在文件资源管理器中选择配置文件。该扩展会在你的工作区中寻找checkstyle.xml文件,以使Checkstyle配置更加容易。你还会看到两个内置的配置:

  • 谷歌的检查
  • 太阳的检查

命令Checkstyle: 设置Checkstyle配置会检测潜在的Checkstyle配置文件并列出它们。你也可以通过在输入框中直接写入URL来提供配置文件。

你也可以通过使用命令Checkstyle: Set the Checkstyle Version来设置Checkstyle版本。

该命令将:

  • 列出主仓库中的最新Checkstyle版本。
  • 列出所有下载的版本。
  • 列出所有支持的版本。
  • 用勾号标记当前使用的版本。

此外,您还可以通过配置路径来引入任何第三方模块用于Checkstyle。例如,使用以下配置后,您可以添加checkstyle.xml中以使用这些检查。

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

检查样式并修复违规

在编辑Java文件时,扩展程序将检查文件格式,并在可能的情况下提供快速修复。您可以点击编辑器中的灯泡按钮以显示可用的快速修复。

修复样式违规

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