Google checkstyle实战

概述

CheckStyle检查代码是否符合制定的规范。CheckStyle检查是基于源码的，无需编译，执行速度快。

CheckStyle的主要流程是：

  1. 对Java文件进行词法语法分析，生成语法树。
  2. 载入配置文件（checkstyle-metadata.xml以及自定义的配置文件）register check事件。
  3. 按照深度优先遍历对语法树进行解析，按照注册的事件，在到达某些节点(AST)时进行style检查。AST，A child-Sibling Tree，是语法树中的某个节点，其类型在TokenTypes类中定义。
  4. 自定义Style的检查，就是在第二步设定的。实现com.puppycrawl.tools.checkstyle.api.Check类，重载其中的两个方法：public int[] getDefaultTokens()和public void visitToken(DetailAST ast)。这两个方法的含义为，在遍历语法树的过程中，每当到达getDefaultTokens函数所返回的AST类型，程序就进入visitToken进行具体的检查和分析，即真正的分析检查过程是在visitToken中实现的。

CheckStyle有针对不同IDE和构建工具的各种插件，如 maven-checkstyle-plugin 插件，配置很简单：

<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-checkstyle-plugin</artifactId><version>3.3.1</version><configuration><!--内置4种规范：config/sun_checks.xml、config/maven_checks.xml、config/turbine_checks.xml、config/avalon_checks.xml、其中sun_checks.xml为默认值。修改默认配置--><configLocation>google_checkstyle.xml</configLocation></configuration><executions><execution><id>checkstyle</id><phase>validate</phase><goals><goal>check</goal></goals><configuration><failOnViolation>true</failOnViolation></configuration></execution></executions>
</plugin>

定义在maven lifecycle的validate阶段执行check task，并且如果发现有违反标准的情况就会fail当前的build。运行checkstyle检查：mvn checkstyle:checkstyle

跳过对指定文件的某些检查

  • suppression：忽略指定文件的问题检查，不推荐；
  • 新增checkstyle-suppressions.xml文件suppressions配置项：
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC"-//Puppy Crawl//DTD Suppressions 1.0//EN""http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
<suppressions><suppress checks="LineLengthCheck"files="SessionMessageSource.java"/>
</suppressions>

<suppressionsLocation>${basedir}/src/config/checkstyle-suppressions.xml</suppressionsLocation>
然后在配置文件里面可以定义一系列可用的模块，每一个模块提供严格程度(强制的，可选的…)可配置的检查规则。规则可以触发通知(notification)，警告(warning)和错误(error)。
附：google-checkstyle

特点：

  1. 它可以有效的帮助我们检视代码以便更好的遵循代码编写标准，特别适用于小组开发时彼此间的样式规范和统一。
  2. Checkstyle提供高可配置性，以便适用于各种代码规范，所以除了使用它提供的几种常见标准之外，你也可以定制自己的标准。
  3. Checkstyle提供支持大多数常见IDE的插件，大部分插件中就含有最新的Checkstyle。
  4. Checkstyle可以检查代码的很多方面，从传统观点看，它主要是用来检查代码层面的，自从第三版以后，它的内部架构作了重大改变，很多其它意图的检测加了进来，现在Checkstyle可以检查像类设计的问题，重复代码，如锁的双重检查的bug模式。

报错

Token “METHOD_REF” was not found in Acceptable tokens list in check SeparatorWrapCheck

在IDEA的Terminal执行mvn clean compile报错：

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.0.0:check (checkstyle) on project test: Failed during checkstyle configuration: cannot initialize module TreeWalker - Token "METHOD_REF" was not found in Acceptable tokens list in check com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck.

参考stackoverflow问答java-google-checkstyle-maven：

You are trying to use a newer configuration with an old version of Checkstyle.

上面的报错信息提示，使用的Maven插件版本为3.0.0，升级到当前最新版3.3.1解决问题。

TreeWalker is not allowed as a parent of LineLength Please review ‘Parent Module’ section for this Check in web documentation if Check is standard.

继续执行mvn clean compile报错：

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.3.1:check (checkstyle) on project test: Failed during checkstyle configuration: cannot initialize module TreeWalker - TreeWalker is not allowed as a parent of LineLength Please review 'Parent Module' section for this Check in web documentation if Check is standard.

参考GitHub issue，LineLength本来在TreeWalker module下面，提升到与TreeWalker同级的module，解决问题。
在这里插入图片描述
虽然解决问题，但是这样下去感觉问题会无穷无尽。

升级配置文件

考虑到上面升级过maven插件，即maven-checkstyle-plugin到最新版，那配置文件是不是也得一起升级下？打开托管在GitHub的官方配置文件google_checks，借助于diffchecker这类在线文本对比工具，好家伙。本地配置文件和GitHub里的配置文件相差也太大了吧。是该更新一下了！！

至于为何不直接使用存放在GitHub上的配置文件？这样的话，可以保证一直使用最新的配置文件。而要使用一个下载到本地的必定会过期的备份配置文件？主要是两点考量：

  1. The Wall的存在，访问GitHub速度不是很快很稳定；
  2. 一份可用的配置文件可以保证团队成员使用尽可能相同的编码规范。

Token “LITERAL_SWITCH” was not found in Acceptable tokens list in check RightCurlyCheck.

继续执行mvn clean compile依旧报错：

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.3.1:check (checkstyle) on project test: Failed during checkstyle configuration: cannot initialize module TreeWalker - Token "LITERAL_SWITCH" was not found in Acceptable tokens list in check com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.

不会吧。插件和配置文件都是最新的，配置文件是官方提供的，没有任何修改。

搜索google_checkstyle.xml文件，可以找到LITERAL_SWITCH及RightCurly。分析此最新版配置文件，不难得出结论：

  • checkstyle有若干个module组成，表示各个不同检查环节
  • LineLength不再是TreeWalker module下的子module，而是和TreeWalker同级，这也正好印证上面一个问题
  • TreeWalker下有若干个module，一个module对应一个方法，如com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck
  • 那token是什么呢？进阶章节会继续研究

回到问题本身。分析报错，大意是在RightCurly这个module里有个tokens属性字段里不能出现LITERAL_SWITCH？

抱着试一试的想法，修改官方提供的配置文件，删除RightCurly module下LITERAL_SWITCH这个token。

再次执行mvn clean compile，上面这个报错消失。出现新的报错，不过其形式和上面的报错一模一样。那就依样画瓢，找到报错的module和token，删除。最后执行mvn clean compile成功。

进阶

源码分析

上面留下一个疑问：token是什么？

看到完整包路径com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck，不难找到maven依赖：

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

包结构如下：
在这里插入图片描述
配置文件google_checkstyle.xml里的module对应的**Check类全部位于com.puppycrawl.tools.checkstyle.checks包下面。并且Check也模块化，有一下几种类型：
在这里插入图片描述
与此同时，在目录com.puppycrawl.tools.checkstyle.meta.blocks.blocks下面有一个xml文件RightCurlyCheck.xml，和Check方法一一对应。配置文件里的module对应一个继承AbstractCheck的Check方法，对应一个**Check.xml配置文件。

NoLineWrapCheck.xml文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata><module><check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck"name="NoLineWrap"parent="com.puppycrawl.tools.checkstyle.TreeWalker"><description>Checks that chosen statements are not line-wrapped. By default, this Check restricts wrapping import and package statements, but it's possible to check any statement.</description><properties><property default-value="PACKAGE_DEF,IMPORT,STATIC_IMPORT"name="tokens"type="java.lang.String[]"validation-type="tokenSet"><description>tokens to check</description></property></properties><message-keys><message-key key="no.line.wrap"/></message-keys></check></module>
</checkstyle-metadata>

check下的name和配置文件google_checkstyle.xml的module name正好对应，parent指向TreeWalker，fully-qualified-name指向Java类文件。properties定义检查的token。

token是什么，回到文章开头，提到AST语法树及TokenTypes类。

借助于IDEA Double Shift快捷键以及左侧的项目视图，不难快速找到com.puppycrawl.tools.checkstyle.api.TokenTypes类文件，定义194个静态常量。以及tokentypes.properties配置文件，里面正好也是194行。经过对比，是一一对应的。

tokentypes.properties文件样例：

OBJBLOCK=An object block.

message-keys

参考

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/708459.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【ElfBoard】基于 Linux 的智能家居小项目

【ElfBoard】基于 Linux 的智能家居小项目

大家好&#xff0c;我是 Hello阿尔法&#xff0c;这段时间参与了保定飞凌嵌入式技术有限公司举办的 ElfBoard 共创社招募活动&#xff0c;并有幸成为了一名共创官&#xff0c;官方寄来了一块 ELF 1 开发板&#xff0c;开箱看这里 ELF 1 开箱初体验。 作为共创官&#xff0c;我…
阅读更多...
数据可视化工具选择指南：山海鲸、Tableau与Power BI特点详解

数据可视化工具选择指南：山海鲸、Tableau与Power BI特点详解

在数据可视化的领域中&#xff0c;众多工具各有千秋。今天&#xff0c;我们将从客观的角度&#xff0c;对三款热门的数据可视化产品——山海鲸可视化、Tableau和Power BI进行深入的对比&#xff0c;帮助用户更全面地了解它们的特点&#xff0c;从而做出更明智的选择。 一、产品…
阅读更多...
移动硬盘在电脑上显示不出来？三招教你轻松应对

移动硬盘在电脑上显示不出来？三招教你轻松应对

随着网络的普及&#xff0c;数据的增多&#xff0c;对于数据储存的需要也是越来越多&#xff0c;相信许多人的手中都存在着一些如U盘、MP3、MP4、移动硬盘之类的储存设备&#xff0c;而在使用这些设备的时候&#xff0c;难免会遇到一些这样或那样的问题&#xff0c;比如移动硬盘…
阅读更多...
微信小程序证书评级导致接口无法访问问题

微信小程序证书评级导致接口无法访问问题

微信小程序的ssl证书到期后&#xff0c; 更换了免费的ssl证书&#xff0c; 是在freessl网站申请的&#xff0c; 配置完了&#xff0c;后台可以访问https网页&#xff0c;但是小程序还是无法访问&#xff0c; 开始没有怀疑是https证书的问题&#xff0c; 调适了好长时间的代码&a…
阅读更多...
Scala Intellij编译错误：idea报错xxxx“is already defined as”

Scala Intellij编译错误：idea报错xxxx“is already defined as”

今天写scala代码时,Idea报了这样的错误&#xff0c;如下图所示&#xff1a; 一般情况下原因分两种&#xff1a; 第一是我们定义的类或对象重复多次出现&#xff0c;编译器无法确定使用哪个定义。 这通常是由于以下几个原因导致的&#xff1a; 重复定义&#xff1a;在同一个文件…
阅读更多...
【探索AI】十一 深度学习之第1周：深度学习概述与基础

【探索AI】十一 深度学习之第1周：深度学习概述与基础

深度学习概述与基础 深度学习的发展历史与现状神经网络的基本原理前向传播与反向传播算法常见的激活函数与优化算法深度学习框架&#xff08;如TensorFlow或PyTorch&#xff09;进行基础操作 深度学习的发展历史与现状 深度学习的发展历史可以追溯到上世纪40年代&#xff0c;当…
阅读更多...
24计算机考研深大经验分享（计算机专业考研综合安排）

24计算机考研深大经验分享（计算机专业考研综合安排）

文章目录 背景科目选择高数选课一轮二轮冲刺阶段 线代一轮二轮 概率论计算机学科专业基础408数据结构计算机组成原理操作系统计算机网络总结 英语政治 末言 背景 首先贴一下初试成绩。这篇分享主要是给零基础的同学使用的&#xff0c;基础好的同学可以自行了解补充一下&#xf…
阅读更多...
Docker数据卷-自定义镜像

Docker数据卷-自定义镜像

一.数据卷 1.1数据卷的基本使用 数据卷是一个特殊的目录&#xff0c;用于在Docker容器中持久化和共享数据。 数据卷的主要特点包括&#xff1a; 数据持久性&#xff1a;数据卷允许您在容器的生命周期之外保持数据的持久性。即使容器被删除&#xff0c;数据卷中的数据依然存在&…
阅读更多...
Redis 协议与异步方式

Redis 协议与异步方式

redis pipeline 模式 redis pipeline 是一个客户端提供的机制&#xff0c;与 redis 无关。pipeline 不具备事务性。目的&#xff1a;节约网络传输时间。通过一次发送多条请求命令&#xff0c;从而减少网络传输时间。 时间窗口限流 系统限定某个用户的某个行为在指定的时间范围…
阅读更多...
国创证券策略：春季躁动行情有望持续演绎

国创证券策略：春季躁动行情有望持续演绎

国创证券指出&#xff0c;商场在连续逼空后总算迎来真正意义上的调整&#xff0c;而指数上也并未能突破3030—3050点压力区&#xff0c;显示现在仍处于中期的下降趋势中的反弹&#xff0c;只是反弹起伏确实是超预期的。周三商场的调整还是近期大涨的巨量获利盘实现压力。由于大…
阅读更多...
palworld-server-tool(0.5.7)使用指南

palworld-server-tool(0.5.7)使用指南

文章目录 说明管理工具&#xff08;docker版本&#xff09;部署教程使用指南RCON指令工具RCON使用广播内容右下角&#xff0c;有加入白明单&#xff0c;和封禁和踢出的功能 游戏中RCON命令使用 说明 本文&#xff0c;主要使简单的使用介绍&#xff08;其实也没有什么指导的&am…
阅读更多...
Rocky Linux 运维工具 systemctl

Rocky Linux 运维工具 systemctl

一、​​systemctl​的简介 ​​systemctl​是用于管理系统服务的命令行工具。​systemctl​命令可以启动、停止、重启或重新加载服务&#xff0c;并管理它们。 二、systemctl​的参数说明 序号参数描述1start启动指定系统服务2stop停止指定系统服务3status显示指定系统服务的…
阅读更多...
【Micropython教程】点亮第一个LED与流水灯

【Micropython教程】点亮第一个LED与流水灯

文章目录 前言MicroPython在线仿真GPIO的工作模式一、有哪些工作模式&#xff1f;1.1 GPIO的详细介绍1.2 GPIO的内部框图输入模式输出部分 一、machine.Pin类1.1 machine.Pin 类的构造对象1.2 machine.Pin 类的方法init方法value方法设置高低电平方法 二、延时函数 三、流水灯总…
阅读更多...
JVM(2)

JVM(2)

JVM类加载 指的是java进程运行时,需要把.class文件从硬盘加载到内存,并进行一系列校验解析的过程. 核心: .class文件>类对象; 硬盘>内存. 类加载过程 在整个JVM的执行流程中,和程序员关系最密切的就是类加载的过程了,所以我们来看一下类加载的执行流程. 对于一个类…
阅读更多...
使用Git从其他分支merge个别文件

使用Git从其他分支merge个别文件

项目背景 产品经理&#xff1a;我们本次开发三个功能&#xff0c;列表页功能、详情页功能、系统消息功能&#xff0c;分两次上线&#xff0c;先上列表功能&#xff0c;再上详情页和系统消息。 小明&#xff1a;好的吧。 紧接着&#xff0c;小明就将本次需求分为2个分支&…
阅读更多...
camunda7流程跳转和流程退回的实现方法

camunda7流程跳转和流程退回的实现方法

我们在使用工作流的时候&#xff0c;常常有“流程退回”、“流程跳转”、“自由流”、“动态加签”等这样的需求。Camunda流程平台提供了这样的机制和接口&#xff0c;虽然流程模型定义活动执行顺序的序列流&#xff0c;但有时需要灵活地重新启动活动或取消正在运行的活动&…
阅读更多...
k8s-项目测试环境部署

k8s-项目测试环境部署

部署规划 概述 项目开发好后&#xff0c;我们需要部署&#xff0c;我们接下来就基于 阿里云云效 阿里云容器镜像服务 k8s 搭建部署环境 阿里云云效 : 放代码&#xff0c;可以做cicd&#xff08;https://www.aliyun.com/product/yunxiao&#xff09; 阿里云容器镜像服务 :…
阅读更多...
Unity（第十六部）声音和视频

Unity（第十六部）声音和视频

声音 1、听声音 创建相机的时候&#xff0c;相机自带Audio Listener 多个相机的时候&#xff0c;我们只保留一个Audio Listener就可以 2、声音源&#xff0c;环境音 添加Audio Source就行中文叫声音源 3、脚本执行的声音 using System.Collections; using System.Collection…
阅读更多...
Servlet（1）Request 请求对象

Servlet（1）Request 请求对象

1、接收请求数据的流程 浏览器发送HTTP请求到Tomcat服务器HTTP的请求中会包含很多请求数据&#xff08;请求行请求头请求体&#xff09;Tomcat服务器会对HTTP请求中的数据进行解析并把解析结果存入到一个对象中所封装的对象即为Request对象&#xff0c;所以可以从Request对象中…
阅读更多...
ubuntu安装新版本的CMake

ubuntu安装新版本的CMake

来到cmake官网选择版本 我需要在嵌入式板子上的Ubuntu18安装使用 故我选择aarch64版本。 按F12进入检查模式得到下载链接。 在板子上运行以下命令&#xff0c;获取安装脚本 wget https://github.com/Kitware/CMake/releases/download/v3.28.3/cmake-3.28.3-linux-aarch64.s…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023