现已发布!阅读关于 12 月份的新功能和修复。

Java 格式化与代码检查

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

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

格式化程序

您可以使用 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",

设置了格式化程序配置文件后,Format Document 命令将使用指定的配置文件来格式化您的 Java 文件。

编辑格式化程序设置

Extension Pack for Java 提供了一个编辑器,帮助用户编辑现有的格式化程序配置文件。您可以使用命令 Java: Open Java Formatter Settings with Preview 打开编辑器。在编辑器中,您可以更改格式化程序设置并预览效果。保存当前编辑器后,更改将保存到格式化程序配置文件中。

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

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

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

SonarLint

SonarLint 是一个易于使用的扩展,可帮助您在编码时查找和修复 bug 和安全问题。该扩展程序在后台运行,就像拼写检查器一样,突出显示存在质量或安全问题的源代码。该扩展程序不仅会告诉您问题是什么,还会提供上下文指导,说明为什么它有害以及如何修复它,并附带示例。该扩展程序支持 500 多个 Java 规则,并包含一些 快速修复 来自动修复某些质量问题。

实时代码分析

问题直接在编辑器中突出显示,并带有悬停提示以提供详细解释。

通过 VS Code 的 Problems 面板也可以查看已打开文件中发现的问题。在适用的情况下,会提到次要代码位置,以便您了解问题的来源(例如,导致 bug 的代码路径)。

规则文档和修复指南

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

启用更多质量和安全规则

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

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

Checkstyle

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

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

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

以及批量检查。

当您单击状态栏中的 Checkstyle 状态图标时,将打开 Problems 面板。

设置 Checkstyle 配置文件

要设置配置文件,请右键单击 .xml 文件并选择 Set the Checkstyle Configuration File

Set Checkstyle configuration file

您还可以通过 File Explorer 中的 Checkstyle: Set Checkstyle Configuration File 命令来选择配置文件。该扩展程序会在您的工作区中查找 checkstyle.xml 文件,以方便 Checkstyle 配置。您还将看到两个内置配置:

  • Google's Check
  • Sun's Check

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

Fix style violation

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

© . This site is unofficial and not affiliated with Microsoft.