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是一个易于使用的扩展,可帮助您在编写代码时查找和修复错误和安全问题。该扩展在后台运行,就像拼写检查器一样,突出显示可能存在质量或安全问题的源代码问题。该扩展不仅告诉您问题是什么,还提供有关其危害性以及如何修复的上下文指导,并附带示例。该扩展支持超过500多条 Java 规则,并包含几个快速修复功能,可自动修复某些质量问题。
实时代码分析
问题直接在编辑器中以悬停方式突出显示,并提供详细说明。
在打开的文件中发现的问题也可以通过 VS Code 的问题面板进行查看。如果适用,会提及次要代码位置,以便您了解问题的来源(例如,导致错误的路径)。
规则文档和修复指南
对于任何检测到的问题,SonarLint 提供有关违反的规则以及其相关的最佳编码实践的完整文档。这使您能够了解问题发生的原因以及如何修复它。
启用更多质量和安全规则
默认情况下,SonarLint 提供了一系列广泛的规则来检测错误和漏洞。可以通过SonarLint 规则视图启用更多检查。
有关适用于 VS Code 的 SonarLint 扩展的更多详细信息,请访问SonarLint 网站。
Checkstyle
使用Checkstyle for Java扩展,您可以使用现有的checkstyle
配置(Google 或 Sun 的 Check)或您自己的自定义文件用于您的项目。编辑 Java 文件时,扩展将检查文件格式并尽可能实时提供快速修复。
使用Checkstyle:设置 Checkstyle 配置文件命令设置 Checkstyle 配置文件,并从下拉列表中选择 Checkstyle 文件。
Checkstyle for Java扩展支持实时代码检查。
和批量检查。
当您单击状态栏中的 Checkstyle 状态图标时,问题面板将打开。
设置 Checkstyle 配置文件
要设置配置文件,右键单击.xml
文件并选择设置 Checkstyle 配置文件。
您还可以触发命令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 文件时,扩展程序将检查文件格式并尽可能提供快速修复。您可以单击编辑器中的灯泡按钮以显示可用的快速修复。
有关Checkstyle for Java的更多详细信息,请访问其GitHub 仓库。