Java 格式化与线条

Red Hat 的 Java™ 语言支持也提供格式设置。你可以导出一个Eclipse格式化文件，然后用VS Code来做项目。

此外，还有 Java 和 SonarLint 扩展的 Checkstyle，这些扩展提供了实时 linting 和代码分析的功能。

福尔马特

你可以使用格式化文档命令来格式化 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： Open Java Formatter Settings with Preview”打开编辑器。在编辑器中，你可以更改格式设置并预览特效。保存当前编辑器后，修改内容会保存到格式配置文件中。

注意：格式化设置编辑器仅支持本地格式化配置文件。如果你的工作区有远程格式化配置文件，它会引导你下载.vscode文件夹。

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

你也可以撤销和重做更改。

声纳林特

SonarLint 是一个易于使用的扩展，帮助你在编程过程中发现并修复错误和安全问题。该扩展在后台运行，就像拼写检查器一样，会突出显示对质量或安全问题存在的源代码问题。扩展不仅告诉你问题所在，还提供了上下文中的指导，说明为什么它有害以及如何解决，并附有示例。该扩展支持 500+ 多个 Java 规则，并包含多个快速修复功能，以自动修复某些质量问题。

即时代码分析

问题会直接在编辑器中高亮显示，鼠标悬停以提供详细说明。

打开文件中的问题也可以通过VS Code的问题面板进行复习。在适用的情况下，会提及次要代码位置，以便你了解问题的来源（例如导致错误的代码路径）。

规则文档与修复指导

对于发现的任何问题，SonarLint都会提供关于被违反规则及其最佳编码实践的完整文档。这能让你理解问题为何被提出，以及如何解决。

支持更多质量和安全规则

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

如需了解更多关于 SonarLint for VS Code 扩展的详细信息，请访问 SonarLint 官网。

格牌风格

通过 Checkstyle for Java 扩展，你可以使用现有的任意一种棋盘风格配置（Google或Sun的Check）或你为项目定制的自定义文件。编辑 Java 文件时，扩展名会检查文件格式，并在可能的情况下即时提供快速修复。

使用检查样式设置配置文件：设置检查样式配置文件命令，并从下拉菜单中选择该检查样式文件。

Checkstyle for Java 扩展支持实时打印。

还有批量检查。

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

Set Checkstyle 配置文件

要设置配置文件，右键点击.xml文件并选择设置检查样式配置文件。

Set Checkstyle 配置文件

你也可以触发命令“Checkstyle： Set Checkstyle Configuration File”，在文件资源管理器中选择配置文件。扩展查找的是一个checkstyle.xml在你的工作区中文件，使Checkstyle配置更简单。你还会看到两种内置配置：

  • 谷歌的支票
  • 太阳支票

命令 Checkstyle： Set the Checkstyle 配置检测潜在的 Checkstyle 配置文件并列出它们。你也可以直接在输入框中写入URL，提供配置文件。

你也可以通过命令 Checkstyle： Set the Checkstyle 版本来设置 Checkstyle 版本。

该指挥将：

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

此外，你还可以通过配置Checkstyle的路径，带入任何第三方模块。例如，使用下面的配置后，你可以添加<模块名=“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 仓库。