本站点文档内容均翻译自code.visualstudio.com，仅供个人学习，如有差异请以官网为准。

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文件夹。

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

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

声呐 lint

SonarLint 是一个易于使用的扩展，帮助您在编码时查找和修复错误和安全问题。该扩展在后台运行，就像拼写检查器一样，突出显示源代码中可能存在的质量和安全问题。该扩展不仅告诉您问题是什么，还提供上下文指导，解释为什么它有害以及如何通过示例进行修复。该扩展支持超过 500+ Java 规则 并包括几个 快速修复 以自动修复某些质量问题。

代码分析实时进行

问题会在编辑器中直接突出显示，并通过悬停提供详细解释。

在打开的文件中发现的问题也可以通过 VS Code 的问题面板进行查看。当适用时，会提及次要的代码位置，以便您可以了解问题的来源（例如导致错误的代码路径）。

规则文档和修复指南

对于检测到的任何问题，SonarLint 提供了关于所违反规则的完整文档，以及与之相关的最佳编码实践。这使您能够了解为什么会出现问题，并如何修复它。

启用更多质量与安全规则

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

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

检查样式

通过 Java 的 Checkstyle 扩展，您可以使用现有的 检查样式配置（Google 或 Sun 的 Check）或您自己的自定义文件。当编辑 Java 文件时，扩展将检查文件格式，并在可能的情况下实时提供快速修复。

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

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

批量检查。

问题面板会在你点击状态栏中的检查样式状态图标时打开。

设置Checkstyle配置文件

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

设置Checkstyle配置文件

你也可以触发命令 Checkstyle: 设置Checkstyle配置文件 在文件资源管理器中选择配置文件。该扩展查找 checkstyle.xml将文件放在你的工作区中以简化Checkstyle配置。你还会看到两个内置配置：

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

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

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

该命令将：

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

此外，您还可以通过配置其路径来引入任何第三方Checkstyle模块。例如，使用以下配置后，您可以添加<模块名称="SingleBreakOrContinueCheck"/>或<模块名称="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仓库。