Checkstyle介绍

一、主要作用

（1）介绍
Checkstyle是一款检查java程序代码样式的工具，可以有效的帮助我们检视代码以便更好的遵循代码编写标准，特别适用于小组开发时彼此间的样式规范和统一。Checkstyle提供了高可配置性，以便适用于各种代码规范。

（2）原理

Checkstyle配置是通过指定modules来应用到java文件的。

modules是树状结构，以一个名为Checker的module作为root节点，一般的checker都会包括TreeWalker子module。可以参照checkstyle中的sun_checks.xml，这是根据sun的java语言规范写的配置。

在xml配置文件中通过module的name属性来区分module，module的Properties可以控制如何去执行这个module，每个property都有一个默认值，所有的check都有一个severity属性，用它来指定check的level。TreeWalker为每个java文件创建一个语法树，在节点之间调用submodules的Checks。

二、在Eclipse中集成Checkstyle插件
从此处安装http://eclipse-cs.sf.net/update/

三、Checkstyle规则

 

（1）Javadoc Comments（Javadoc相关）
Package Html：是否每个包中存在package.html

Method Javadoc：方法的javadoc

Style Javadoc：javadoc的格式验证

Type Javadoc：类或接口的javadoc

Variable Javadoc：变量的javadoc

 

（2）Naming Conventions（命名惯例）
Abstract Class Name：抽象类命名

Constants Name：常量名

Local Final Variable Name：局部final变量名

Local Variable Name：局部非final变量名

Member Name：成员变量名

Method Name：方法名

Package Name：包名

Parameter Name：检查类的参数名

Static Variable Name：静态变量名

Type Name：类或接口名

 

（3）Headers（文件头检查）

Header：检查java源文件头

Regular Expression Header：利用正则表达式检查java源文件头

Cross Langurag Regexp Header：利用正则表达式检查任何源文件头

（4）Imports（导入检查）

Avoid Star Imports：避免*导入

Illegal Imports：避免导入一些不合理的包，如sun.*，非100%纯java

Import Order Check：保证导入顺序

Redundant Imports：多余的导入

Unused Imports：未使用的导入

Import Control：控制包能导入什么

 

（5）Size Violations（检查大小）

Anonymous inner class lengths：匿名内部类的长度

Executable Statement Size：限制可执行代码片段的长度

Maximum File Length：最大文件长度

Maximum Line Length：最大行长度

Maximum Method Length：最大方法长度

Maximum Parameter Length：最大参数个数

 

（6）Whitespace（空白相关）
Empty For Initializer Pad：在初始化处是否需要空白，如：for的初始化处

Empty For Iterator Pad：在迭代处是否需要空白，如：for的迭代处

No Whitespace After：在某些符号后面没有空白

No Whitespace Before：在某些符号前面没有空白

Operator Wrap：当折行时，哪些操作符必须在新起一行

Method Parameter Pad：方法名和左括号中间是否有空白

Paren Pad：是否有空白在左括号和右括号之间

Tab Character：是否在源代码中有/t

Typecase Paren Pad：强制类型转换后面是否有空格

Whitespace After：检查分隔符后是否有空白，如：逗号后面有空格

Whitespace Around：检查分隔符周围是否有空白，如：等号前后有空格

 

（7）Modifiers（修饰符相关）
Modifier Order：修饰符顺序
Redundant Modifier：多余修饰符
 

（8）Blocks（代码块）
Avoid Nested Blocks：避免嵌套块
Empty Block：空块
Left Curly Brace Placement：左括号的位置
Need Braces：某些控制结构必须有括号
Right Curly Brace Placement：右括号的位置
 

（9）Coding Problems（代码常见问题）
Avoid Inline Conditionals：避免内联条件

Covariant Equals：检查定义的equals方法确实覆盖了Object的equals

Default Comes Last：default在switch的最后

Declaration Order Check：检查定义顺序

Double Check Locking：双检查锁

Empty Statement：空语句

Equals and HashCode：覆盖了equals也会覆盖hashCode

Explicit Initialization：明确初始化每一个变量

Fall Through：switch中的case在没有break或return等情况下，必须有注释

Final Local Variable：本地变量，如果值未改变，则定义成final

Hidden Field：变量间不存在隐藏

Illegal Instantiation：检查不合理的实例化，此处实例化可以用工厂方法代替

Illegal Catch：检查不合理的异常捕获

Illegal Throws：检查不合理的异常抛出

Illegal Tokens：检查非法的分隔符

Illegal Tokens Text：检查非法的分隔符的下个字符

Illegal Type：某些类应当从不用于定义类型、参数等

Inner Assignment：检查子表达式中是否有赋值操作

JUnit Test Case：junit的测试命名正确

Magic Number：无魔数

Missing Constructor：缺少构造函数

Missing Switch Default：switch缺少default语句

Modified Control Variable：更改了控制变量

Multiple String Literals：检查在一个文件中相同字符串出现多次

Multiple Variable Declaration：每个变量定义在单独一行

Nested If Depth：检查if的嵌套层次深度

Nested Try Depth：检查try的嵌套层次深度

Package Declaration：保证每个类都有一个包定义

Parameter Assignment：不允许对参数进行赋值

Redundant Throws：多余的异常抛出

Require This：引用本类的变量、方法时需要this

Return Count：限制return的数量

Simplify Boolean Expression：保证boolean表达式简单

Simplify Boolean Return：保证boolean返回值表达式简单

String Literal Equality：String的判等不使用==或!=

SuperClone：子类的clone中调用了super.clone()

SuperFinalize：子类的finalize调用了super.finalize()

Trailing Array Comma：数组初始化包括尾逗号

Unnecessary Parentheses：不必要的括号

 

（10）Class Design（类设计）

Design For Extension：检查类是否为扩展设计

Final Class：仅有private构造函数的类应定义为final类

Hide Utility Class Constructor：工具类不定义public构造函数

Interface Is Type：接口是类型，不能只定义常量，必须定义方法

Mutable Exception：保证异常类的所有成员是final的，是不可变类

Throws Count：限制抛出异常的数量

Visiblity Modifier：检查类成员的可见性

（11）Duplicates（重复）

Strict Duplicate Code：重复检测

（12）Metrics（代码质量度量）

Cyclomatic Complexity：圈复杂度

Non Commenting Soruce Statements：非注释源代码行数

Boolean Expression Complexity：限制布尔操作符的数量

Class Data Abstraction Coupling：其他的类在某一个类中实例的数量

Class Fan Out Complexity：一个类依赖其他类的数量

NPath Complexity：一个函数的可执行路径数

（13）Miscellaneous（杂项）

Array Type Style：数组样式（C-Style：String args[]，Java-Style：String[] args）

Descendent Token Check

Final Parameter：方法和构造函数的参数是final的

Generic Illegal Regexp：通过正则表达式检查一些代码问题

Indentation：检查缩进

New Line At End Of File：文件以一新行结束

Required Regular Expression：在代码中存在符合正则的代码

TODO Comments：检查TODO

Translation：检查属性文件是否缺少key

Trailing Comment：每个注释仅仅占一行

Uncommented Main：检查是否有未注释的main方法

Upper Ell：Long被使用L而不是l来定义

Regexp：符合正则表达式，并且在代码中出现一定次数

（14）J2EE（主要是相关于EJB的一些检查）

（15）Other（其他）

Checker：checkstyle配置的根，不能移除

TreeWalker：按照定义的属性检查java源文件

（16）Filters（过滤器）

Severity Match Filter：根据event的严重性来决定audit events

Supression Filter：根据supression xml document，当check error时，压制audit events

Supression Comment Filter：使用某些注释格式来压制audit events

 

四、在持续集成时进行checkstyle检查

（1）在项目pom.xml中填入maven的plugin配置
<project> ... <build> <!-- To define the plugin version in your parent POM --> <pluginManagement> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.6</version> </plugin> ... </plugins> </pluginManagement> <!-- To use the plugin goals in your POM or parent POM --> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.6</version> </plugin> ... </plugins> </build> ... <!-- To use the report goals in your POM or parent POM --> <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-checkstyle-plugin</artifactId> <version>2.6</version> </plugin> ... </plugins> </reporting> ... </project> 

（2）执行maven checkstyle:check进行代码风格检查 

（3）更多信息，见：http://checkstyle.sourceforge.net/