代码规范利器-CheckStyle

最新推荐文章于 2024-09-18 10:24:25 发布

zzouri

最新推荐文章于 2024-09-18 10:24:25 发布

阅读量555

点赞数

文章标签：代码规范 java

本文链接：https://blog.csdn.net/zzouri/article/details/106543281

版权

本文介绍了代码规范工具CheckStyle的使用背景、意义、安装与配置方法，以及在实际开发中的应用效果。通过CheckStyle，可以自动化检查Java代码的规范性，提高代码质量和团队协作效率。

摘要由CSDN通过智能技术生成

本期内容分为五个部分，阅读时长预估7分钟：

使用背景
CheckStyle使用意义
CheckStyle安装与使用
CheckStyle检查配置示例
落地使用情况及效果

使用背景

随着团队人员规模的增大，不断有新人加入及每个人的编码经验、代码习惯风格不同，很难靠口头讲来规范团队的代码规范。
能否有一个工具从一开始写代码就要求开发人员遵守编码规范？编写整洁优雅的代码，减轻CodeReview工作量，减少后续不断重构糟糕冗余的代码，自动化代码规范的检查过程？

它就是CheckStyle！

什么是CheckStyle
简单的说就是帮助Java程序员编写符合代码规范的工具。

它支持高度可配置的各种检查规则，进行自动化的检查，不符合代码规范的地方会有红色波浪线提醒，鼠标箭头移上去会有相应的提示，简单易用！

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

编码常见的问题

CheckStyle支持100多项代码检查规则，下面整理了我们平时编写代码中常见的不规范问题如下：

Import语句（无用的导入，多余导入使用’.*’）
嵌套层数太多，可读性、可维护性太差（if嵌套层数过多，try catch嵌套层数过多）
魔术数字
命名不规范(Static变量名\常量名\参数名\方法名\包名\类名\接口名)
方法、类行数太多导致可读、可维护性太差
方法参数个数过多
方法分支复杂度、圈复杂度过多
类或接口声明部分顺序没按照Java语言编码规则
空catch块，if else语句没有使用大括号等
编码细节问题：如检查是否在long类型定义了大写的L，字母小写l和数字1很相似

CheckStyle使用意义

遵从共同的编码规范，编写出易于阅读和维护的代码，减少Bug产生的可能性
自动化代码规范的检查过程，提升代码质量，减轻CodeReview工作量，提升研发效能
形成团队整体良好的编码习惯，减少后续因糟糕冗余代码导致的不断重构的工作量，提升研发效能

CheckStyle安装与使用

CheckStyle插件安装
点击Preferences，搜索框里搜索plugins，点击Plugins，搜索CheckStyle找到CheckStyle-IDEA插件，安装并启用
在这里插入图片描述