JAVA面试题分享三百七十二：代码质量检测之checkstyle的安装使用

于 2024-01-30 09:27:27 发布
阅读量883 收藏 22
点赞数 20
分类专栏： JAVA 面试题分享 文章标签： java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45038038/article/details/135922931
版权
本文详细介绍了Checkstyle的安装、使用方法，特别是XPathQuery的原理和应用，以及如何配置Checkstyle进行代码规范检查，包括Google风格的缩进和Javadoc要求。
摘要由CSDN通过智能技术生成

目录

安装使用

下载

界面化运行

打开一个.java文件

认识左边的结构

checkstyle里面的Xpath Query是什么

基本用法

示例

使用属性

复合查询

注意事项

例子

/COMPILATION_UNIT

/CLASS_DEF[./IDENT[@text='AIApp']]

/OBJBLOCK

/METHOD_DEF[./IDENT[@text='checkCodeMenu']]

如何对Checkstyle进行简单配置

下载插件

配置插件

修改检查配置

进行检测

分析结果

安装使用

官方文档地址：https://checkstyle.sourceforge.io/

下载

下载地址：https://github.com/checkstyle/checkstyle/releases/

或使用maven引入：

<dependency>    <groupId>com.puppycrawl.tools</groupId>    <artifactId>checkstyle</artifactId>    <version>10.12.7</version></dependency>

界面化运行

"D:\java17\bin\java.exe" -cp "D:\tool_configs\checkstyle-10.12.7-all.jar" com.puppycrawl.tools.checkstyle.gui.Main

运行界面如下：

打开一个.java文件

界面如下

 

认识左边的结构

	COMPILATION_UNIT	1	0	COMPILATION_UNIT	PACKAGE_DEF	1	0	package	IMPORT	3	0	import	IMPORT	4	0	import	IMPORT	5	0	import	IMPORT	6	0	import	IMPORT	7	0	import	IMPORT	8	0	import	IMPORT	9	0	import	IMPORT	10	0	import	IMPORT	11	0	import	IMPORT	12	0	import	IMPORT	13	0	import	IMPORT	14	0	import	IMPORT	15	0	import	IMPORT	16	0	import	IMPORT	17	0	import	IMPORT	18	0	import	IMPORT	19	0	import	IMPORT	20	0	import	IMPORT	21	0	import	IMPORT	22	0	import	IMPORT	23	0	import	IMPORT	24	0	import	IMPORT	25	0	import	IMPORT	26	0	import	IMPORT	27	0	import	IMPORT	28	0	import	IMPORT	29	0	import	IMPORT	30	0	import	IMPORT	31	0	import	IMPORT	33	0	import	IMPORT	34	0	import	IMPORT	35	0	import	IMPORT	36	0	import	IMPORT	37	0	import	IMPORT	38	0	import	CLASS_DEF	40	0	CLASS_DEF	MODIFIERS	40	0	MODIFIERS	LITERAL_PUBLIC	40	0	public	LITERAL_CLASS	40	7	class	IDENT	40	13	AIApp	EXTENDS_CLAUSE	40	19	extends	IDENT	40	27	Application	OBJBLOCK	40	39	OBJBLOCK	LCURLY	40	39	{	METHOD_DEF	42	4	METHOD_DEF	MODIFIERS	42	4	MODIFIERS	TYPE	42	11	TYPE	IDENT	42	16	checkCodeMenu	LPAREN	42	29	(	PARAMETERS	42	30	PARAMETERS	RPAREN	42	53	)	SLIST	42	54	{	METHOD_DEF	51	4	METHOD_DEF	METHOD_DEF	61	4	METHOD_DEF	METHOD_DEF	84	4	METHOD_DEF	METHOD_DEF	177	4	METHOD_DEF	METHOD_DEF	231	4	METHOD_DEF	METHOD_DEF	261	4	METHOD_DEF	METHOD_DEF	297	4	METHOD_DEF	METHOD_DEF	325	4	METHOD_DEF	METHOD_DEF	365	4	METHOD_DEF	METHOD_DEF	441	4	METHOD_DEF	RCURLY	445	0	}

这是 Checkstyle GUI 解析的 Java 源文件的抽象语法树（AST）的部分内容。AST 是对代码结构的一种树形表示，它将源代码的结构以一种易于分析和处理的方式呈现。

以下是每个条目的解释：

  1. COMPILATION_UNIT： 表示整个 Java 编译单元，即一个 Java 文件。

  2. PACKAGE_DEF： 表示 Java 包的定义，即 package 语句。

  3. IMPORT： 表示导入语句，即 import 语句。

  4. CLASS_DEF： 表示 Java 类的定义，包括类的修饰符、类名、继承关系等。

  5. MODIFIERS： 表示修饰符，例如 public。

  6. LITERAL_PUBLIC： 表示 public 关键字。

  7. LITERAL_CLASS： 表示 class 关键字。

  8. IDENT： 表示标识符，例如类名、方法名等。

  9. EXTENDS_CLAUSE： 表示类的继承关系，即 extends 关键字。

  10. OBJBLOCK： 表示代码块，包括类的主体。

  11. LCURLY： 表示左大括号 {。

  12. METHOD_DEF： 表示方法的定义。

  13. TYPE： 表示数据类型。

  14. LPAREN： 表示左圆括号 (。

  15. PARAMETERS： 表示方法的参数。

  16. RPAREN： 表示右圆括号 )。

  17. SLIST： 表示语句块，包含在方法或代码块内的语句。

  18. RCURLY： 表示右大括号 }。

这些条目组合在一起构成了 Java 源文件的结构。Checkstyle 使用 AST 来遍历和检查源代码，确保代码符合定义的规范。在这个例子中，可能是一个包含类定义和多个方法的 Java 文件。

checkstyle里面的Xpath Query是什么

Checkstyle 的 XPath Query 功能允许用户定义自定义规则并在代码中使用 XPath 表达式进行检查。这个功能允许开发者基于代码结构的 XPath 查询来定义检查规则，XPath 表达式用于定位和匹配源代码中的特定结构。以下是 Checkstyle XPath Query 的基本用法和示例

基本用法

XPath Query 的基本语法为

//XPath_Expression

其中，// 表示查找匹配的任意位置，XPath_Expression 是 XPath 表达式。

示例

查找所有类定义xpath //CLASS_DEF查找所有包含 System.out.println 的语句xpath //EXPR[matches(@text, 'System\.out\.println')]

使用属性

XPath 还支持使用元素的属性进行匹配。例如，可以使用 @token 属性匹配指定类型的元素。

//LITERAL[@token='abstract']
复合查询

可以使用逻辑运算符 and、or 和 not 来组合多个查询条件。

//CLASS_DEF[MODIFIERS/LITERAL_PUBLIC and not(MODIFIERS/LITERAL_STATIC)]
注意事项

XPath 查询功能需要在 Checkstyle 配置文件中启用。在配置文件中，使用 <module name="XPathCheck"/> 启用 XPath 检查器。xml <module name="XPathCheck"/>XPath 表达式通常基于 XML 结构，但在 Checkstyle 中，它用于匹配 AST（抽象语法树）中的代码结构。因此，XPath 表达式的使用方式可能与常规 XML 文档中的 XPath 表达式有所不同。Checkstyle 的 XPath Query 功能是强大的，但也需要一定的 XPath 知识。详细的 XPath 表达式语法和使用方法可以参考 XPath 的相关文档。

例子

让我们逐步解析这个表达式

/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='AIApp']]/OBJBLOCK/METHOD_DEF[./IDENT[@text='checkCodeMenu']]
/COMPILATION_UNIT

从根节点开始，查找名为 COMPILATION_UNIT 的元素。

/CLASS_DEF[./IDENT[@text='AIApp']]

在找到的 COMPILATION_UNIT 中，查找名为 CLASS_DEF 的子元素，并确保其中有一个子元素的名字为 IDENT 且其文本内容为 'AIApp'。

/OBJBLOCK

在满足上述条件的 CLASS_DEF 中，查找名为 OBJBLOCK 的子元素。

/METHOD_DEF[./IDENT[@text='checkCodeMenu']]

在 OBJBLOCK 中，查找名为 METHOD_DEF 的子元素，并确保其中有一个子元素的名字为 IDENT 且其文本内容为 'checkCodeMenu'。这个 XPath Query 的整体作用是定位一个 Java 源代码文件中，包含一个类定义（CLASS_DEF）的 COMPILATION_UNIT，这个类的名字是 'AIApp'，在这个类的 OBJBLOCK 中包含一个名为 'checkCodeMenu' 的方法（METHOD_DEF）。这种 XPath Query 可以用于 Checkstyle 中，作为自定义规则的一部分，用于检查代码中是否包含特定类和方法的定义，以确保符合团队的编码规范。

基于上面的步骤，我们就可以去定位代码了。

如何对Checkstyle进行简单配置

可以配置来检查和强制执行不同的编码规范和最佳实践。我们先来看看如何在IDEA中使用CheckStyle

下载插件

在idea的插件商店中安装下载CheckStyle-IDEA，如下图：

配置插件

进入editor->Inspections->搜索Checkstyle 全部勾上

 

修改检查配置

进入 Tools->Checkstyle

可以发现区域中包含了两部分的检测方案，分别是sun公司和Google的规范对应的配置。相关的介绍我们可以在官方文档中可以看到，地址分别是https://checkstyle.sourceforge.io/google_style.html 和 https://checkstyle.sourceforge.io/sun_style.html。

进行检测

在安装好了checkstyle之后，我们就可以在idea的界面看到相关的操作。

 

点击1处按钮，进入checkstyle的操作，选择2中的Google Checks，然后选择3代表的是启动分析，将会分析4对应的文件，最终将结果输出到窗口中。

分析结果

下面是一个简单Checkstyle 对 Java 代码进行了 Google 风格的检查，并给出了一系列的警告和错误

Checkstyle found 36 item(s) in 1 file(s)YamlUtils.java : 36 item(s)Package name 'com.demo123567.desktop.auto_tools.utils' must match pattern '^[a-z]+(\.[a-z][a-z0-9]*)*$'. (1:9) [PackageName]缺少摘要javadoc。(6:0) [SummaryJavadoc]'method def modifier' 缩进了4个缩进符，应为2个。(12:5) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(13:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(14:5) [Indentation]'method def modifier' 缩进了4个缩进符，应为2个。(16:5) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(17:9) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(18:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(19:5) [Indentation]'method def modifier' 缩进了4个缩进符，应为2个。(21:5) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(22:9) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(23:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(24:5) [Indentation]'method def modifier' 缩进了4个缩进符，应为2个。(26:5) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(27:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(28:5) [Indentation]'method def modifier' 缩进了4个缩进符，应为2个。(30:5) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(31:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(32:5) [Indentation]Javadoc的第一句缺少一个结束时期。(34:0) [SummaryJavadoc]@标签应有非空说明。(37:0) [NonEmptyAtclauseDescription]@标签应有非空说明。(38:0) [NonEmptyAtclauseDescription]'method def modifier' 缩进了4个缩进符，应为2个。(40:5) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(41:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(42:5) [Indentation]'method def modifier' 缩进了4个缩进符，应为2个。(44:5) [Indentation]'method def' 子元素缩进了8个缩进符，应为4个。(45:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(46:5) [Indentation]'method def modifier' 缩进了4个缩进符，应为2个。(48:5) [Indentation]WhitespaceAround: '{' is not preceded with whitespace. (48:66) [WhitespaceAround]'method def' 子元素缩进了8个缩进符，应为4个。(49:9) [Indentation]',' 后应有空格。(49:61) [WhitespaceAfter]'method def' 子元素缩进了8个缩进符，应为4个。(50:9) [Indentation]'method def rcurly' 缩进了4个缩进符，应为2个。(51:5) [Indentation]本行字符数 1,495个，最多：100个。(57:0) [LineLength]注释应与第48行代码同样缩进4个缩进符，而不是0个。(65:1) [CommentsIndentation]

以下是对每个问题的简要解释：

  1. Package name 'com.demo123567.desktop.auto_tools.utils' must match pattern '^[a-z]+(.[a-z][a-z0-9])$'.

    • 包名不符合规范，应该是小写字母开头的小写字母和数字的组合。

  2. 缺少摘要 javadoc。

    • 在某个地方缺少了对方法或类的摘要 Javadoc 注释。

  3. 'method def modifier' 缩进了 4 个缩进符，应为 2 个。

    • 方法定义的修饰符缩进不符合规范，应该缩进 2 个空格。

  4. 'method def' 子元素缩进了 8 个缩进符，应为 4 个。

    • 方法定义的子元素（参数、方法体等）缩进不符合规范，应该缩进 4 个空格。

  5. 'method def rcurly' 缩进了 4 个缩进符，应为 2 个。

    • 方法定义的右大括号缩进不符合规范，应该缩进 2 个空格。

  6. Javadoc 的第一句缺少一个结束句点。

    • Javadoc 注释的第一句应该以一个结束句点结尾。

  7. @标签应有非空说明。

    • Javadoc 注释中的 @ 标签应该有非空说明。

  8. WhitespaceAround: '{' is not preceded with whitespace.

    • { 前面没有空格。

  9. ',' 后应有空格。

    • 逗号后应该有一个空格。

  10. 本行字符数 1,495 个，最多：100 个。

  • 一行代码的长度超过了最大限制。

  1. 注释应与第 48 行代码同样缩进 4 个缩进符，而不是 0 个。

  • 注释的缩进不符合规范，应该与相应的代码同样缩进。

这些问题主要涉及到代码格式、缩进、Javadoc 注释等方面的规范。我们可以根据这些提示逐一修复代码，以确保代码符合 Google 的编码规范。

之乎者也·
关注
  • 20
    点赞
  • 踩
  • 22
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
还在为代码的规范问题头疼吗？CheckStyle来了解一下
Java笔记虾
02-05 659
CheckStyle 是 SourceForge 下的一个项目，提供了一个帮助 Java 开发人员遵守某些编码规范的工具。开发人员能够根据已经设置好的编码规则来自动地检查自己所写的代码，例...
java 泛型空间_Checkstyle Java泛型：’？’之前没有空格
weixin_39795116的博客
03-05 557
我正在使用插件maven-checkstyle-plugin2.17它有6.11.2 checkstyle版本.关于空格的配置是：我总是得到这个错误：(whitespace) WhitespaceAround: WhitespaceAround: '?' is not preceded with whitespace.(whitespace) WhitespaceAround: Whitespac...
checkStyle结果分析
xo_zhang的专栏
12-21 3297
checkStyle结果分析 参考：http://commons.apache.org/jelly/libs/http/checkstyle-report.html 1.Missing a Javadoc comment:缺少JavaDoc注释 2.First sentence should end with a period:你的注释的第一行文字结束应该加上一个"."
Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin
L
07-06 3985
idea编译项目时，出现如下报错：[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.0.0:check (validate) on project devops-brain: Failed during checkstyle configuration: Cannot set property 'cacheFile' to 'F:\Copote\Code\devops-brain\devops-
详解CheckStyle的检查规则（共138条规则）
热门推荐
yang1982_0907的专栏
01-10 6万+
本文主要介绍CheckStyle 5.6.1版本的各个规则配置项目，这个版本的CheckStyle将样式规则分为了以下十七种类型： 1. Annotations（注解：5个） Annotation Use Style（注解使用风格） 这项检查可以控制要使用的注解的样式。 Missing Deprecated（缺少deprecad） 检查ja
Java代码质量检查工具及使用案例
02-24
主要对下面的七块进行分析编码格式规范代码重复代码覆盖率依赖项分析复杂度监控Java模拟技术代码评审和重构接下来的使用Eclipse插件来揭示这些分析领域：编码格式规范：codeStyle和CheckStyle代码重复：PMD的CPD代码...
action-checkstyle：基于reviewdog的GitHub操作，可在Java代码上运行Checkstyle
01-30
action-checkstyle：基于reviewdog的GitHub操作，可在Java代码上运行Checkstyle
checkstyle-idea：用于IntelliJ IDEA的CheckStyle插件
02-03
CheckStyle-IDEA :copyright:版权所有2006-2020 CheckStyle-IDEA贡献者 托管在 JetBrains的IntelliJ IDEA 2019-20插件，可通过检查针对给定的配置文件提供实时反馈。 请注意，这不是Checkstyle的正式组成部分-...
java质检工具(FindBugs、CheckStyle、Junit、Jmeter、Apifox)安装使用总结
最新发布
08-06
Java 质检工具安装使用总结 Java 质检工具是软件开发过程中不可或缺的一部分，它可以帮助开发者编写高质量的代码，提高软件的可靠性和稳定性。本文将对五款常用的 Java 质检工具进行详细介绍，包括 FindBugs、...
diff-checkstyle:在代码的增量更改行上检查样式问题
05-16
diff-checkstyle 请注意，此存储库不再维护，有关更好的选择，请查看 。 介绍 当使用扫描项目时，它将立即在每个文件中输出所有问题。 这使得在清除所有现有样式问题之前，很难对正在开发的代码进行有效的样式检查...
Java代码规范、格式化和checkstyle检查配置文档
12-01
最全的Java代码规范、格式化和checkstyle检查配置文档
intellij idea checkstyle 的配置文件
05-16
intellij idea checkstyle 的配置文件 checks.xml
checkstyle配置文件
05-22
checkstyle 配置文件
[宝宝巴士]最佳程序员评分 - 评分规则
weixin_30235225的博客
06-30 218
1. Lua Comments（Luadoc注释：6个）{ "File comment（文件注释）", "检查每个Lua包是否都有注释。并且注释内容必须一致。",},{ "Method comment（方法注释）", "检查方法或构造器的注释。默认不会检查方法可能抛出的异常。", "如果是覆盖方法则必须显式的显示调用父类方法的注解。例如，如果方法实现了接口中的某个方法，那么注释可以这样编...
PyCharm选择性忽略PEP8代码风格警告信息
Focusing on your own Mind :) －> 站在巨人的肩膀上
11-07 7442
用了几天的PyCharm，发现确实在编写Python代码上非常好用，但有一点体验不太好，就是代码编写时要按照PEP8代码风格编写，不然会有波浪线的警告信息。解决方法如下： 方法一： 将鼠标移到提示的地方，按alt+Enter，选择忽略（Ignore）这个错误即好。 方法二 打开：File - Settings…… - Editor - Inspections 在pyt
IDEA代码规范插件（CheckStyle插件、alibaba插件）
WindSweet的博客
10-29 4364
IDEA代码规范插件（CheckStyle插件、alibaba插件）代码规范插件CheckStyle插件alibaba插件 代码规范插件 CheckStyle插件 1、安装 打开idea的file→settings→plugins 再搜索框搜索CheckStyle-IDEA，点击install，下载完成之后点击Restart intellij IDEA重启idea 在idea界面最下方 找到checkstyle 2、使用可以直接使用原有的谷歌的配置或sun公司的配置（跳到第3步），也可以自己配置 2.1
Idea Maven的几个问题
qq_42943161的博客
08-12 54
1.maven下载不了jar包 ​ 解决方法:全局配置有问题 2.Not allowed to load local resource-Chrome ​ 解决方法:目录路径对不对? 3.Process terminated ​ 解决方法:调整Maven目录 估计被修改了 Idea日常
idea 配置详解 （二） 之editor 详解
爱媳妇儿爱编程
05-06 1703
默认选项：跳转到当前单词边界：这是默认选项。Use block caret：选中此复选框可在插入模式中应用块插入符，在覆盖模式中应用常用插入符。跳转到下一个/上一个单词边界：当您选择此选项时，插入符号向前移动到下一个单词的开头，而当向后移动时，插入符号跳转到前一个单词的末尾。跳转到下一行/上一行边界：当您选择此选项时，插入符号向前移动到下一行的开头，而当向后移动时，插入符号跳转到上一行的末尾。跳转到当前行边界：选择此选项时，插入符号总是跳到当前行的末尾（向前移动时）或当前行的开头（向后移动时）。
Checkstyle安装说明操作手册.doc
01-27
Checkstyle是一款检查java程序代码样式的工具，可以有效的帮助我们检视代码以便更好的遵循代码编写标准，特别适用于小组开发时彼此间的样式规范和统一

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

之乎者也·

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值