Java 格式化和 linting

Red Hat 对 Java™ 的语言支持还提供格式设置。您可以导出 Eclipse 格式化程序文件,然后将其用于 VS Code 中的项目。

此外,还有Checkstyle for JavaSonarLint扩展,提供实时 linting 和代码分析功能。

格式化程序

您可以使用Format Document命令来格式化 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: Open Java Formatter Settings with Preview打开编辑器。在编辑器中,您可以更改格式化程序设置并预览效果。保存当前编辑器后,更改将保存到格式化程序配置文件中。

注意:格式化程序设置编辑器仅支持本地格式化程序配置文件。如果您的工作区包含远程格式化程序配置文件,它将引导您将其下载到.vscode文件夹中。

在编辑器中编辑设置时,您可以在右侧预览面板中预览更改的效果。

您还可以撤消和重做更改。

声纳林特

SonarLint是一个易于使用的扩展,可帮助您在编码时查找并修复错误和安全问题。该扩展在后台运行,就像拼写检查器一样,突出显示引起质量或安全问题的源代码问题。该扩展不仅告诉您问题是什么,还通过示例提供有关其有害原因以及如何解决问题的上下文指导。该扩展支持超过500 条 Java 规则,并包含多个快速修复来自动修复某些质量问题。

动态代码分析

问题会直接在编辑器中突出显示,并通过悬停来提供详细说明。

在打开的文件中发现的问题也可以通过 VS Code 的“问题”面板进行查看。如果适用,会提及辅助代码位置,以便您可以了解问题的根源(例如,导致错误的代码路径)。

规则文档和补救指南

对于检测到的任何问题,SonarLint 都会提供有关所违反规则及其相关最佳编码实践的完整文档。这可以让您了解为什么会出现问题以及如何解决它。

启用更多质量和安全规则

默认情况下,SonarLint 提供了广泛的规则来检测错误和漏洞。可以通过SonarLint 规则视图启用更多检查。

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

格子风格

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

使用 Checkstyle 设置 Checkstyle 配置文件:设置 Checkstyle 配置文件命令并从下拉列表中选择 Checkstyle 文件。

Checkstyle for Java扩展支持实时 linting。

并进行批量检查。

单击状态栏中的 Checkstyle 状态图标时,将打开“问题”面板。

设置Checkstyle配置文件

要设置配置文件,请右键单击该.xml文件并选择“设置 Checkstyle 配置文件”

设置Checkstyle配置文件

您还可以触发命令Checkstyle: Set Checkstyle Configuration File在文件资源管理器中选择配置文件。该扩展会在您的工作区中查找checkstyle.xml文件以使 Checkstyle 配置更容易。您还将看到两个内置配置:

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

命令Checkstyle:设置 Checkstyle 配置会检测潜在的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 文件时,扩展程序将检查文件格式并在可能的情况下提供快速修复。您可以单击编辑器中的灯泡按钮来显示可用的快速修复。

修复样式违规问题

有关Java 版 Checkstyle的更多详细信息,请访问其GitHub 存储库