在 VS Code 中试试！

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 是一个易于使用的扩展，可帮助你在编写代码时查找和修复 Bug 和安全问题。该扩展在后台运行，就像拼写检查器一样，会突出显示可能导致质量或安全问题的源代码问题。该扩展不仅会告诉你问题是什么，还会提供有关其危害以及如何修复的上下文指导，并附带示例。该扩展支持超过 500 多条 Java 规则，并包含多个快速修复，可自动修复某些质量问题。

即时代码分析

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

在 VS Code 的“问题”面板中，也可以查看已打开文件中发现的问题。在适用情况下，还会提及次要代码位置，以便你了解问题的来源（例如，导致 Bug 的代码路径）。

规则文档和修复指南

对于检测到的任何问题，SonarLint 都提供了有关违规规则的完整文档，以及其相关的最佳编码实践。这使你能够理解为什么会提出问题以及如何修复它。

启用更多质量和安全规则

默认情况下，SonarLint 提供了大量规则来检测 Bug 和漏洞。可以通过 SonarLint 规则视图启用更多检查。

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

Checkstyle

使用 Checkstyle for Java 扩展，你可以使用现有的 checkstyle 配置（Google 的或 Sun 的检查）或为你自己的项目自定义文件。在编辑 Java 文件时，该扩展将检查文件格式，并尽可能提供即时快速修复。

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

适用于 Java 的 Checkstyle 扩展支持实时代码检查。

以及批量检查。

当你点击状态栏中的 Checkstyle 状态图标时，“问题”面板将打开。

设置 Checkstyle 配置文件

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

Set Checkstyle configuration file

你还可以触发命令 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 文件时，该扩展将检查文件格式，并尽可能提供快速修复。你可以点击编辑器中的灯泡按钮以显示可用的快速修复。

Fix style violation

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

12/12/2021