介绍
CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来,这使它适合要执行编码标准的项目。
Checkstyle是高度可配置的,可以支持几乎所有的编码标准。一个示例配置文件提供支持Sun编码规范,谷歌Java风格
特性
Checkstyle可以查看源代码的许多方面。它能找到类设计问题,方法的设计问题。它也有能力来检查代码布局和格式问题,具体可检查的点见下表:
AbbreviationAsWordInName | 检查验证缩写(连续大写字母)长度标识符的名字,它还允许执行骆驼命名 |
AbstractClassName | 确保抽象类的名称符合一些正则表达式。 |
AnnotationLocation | 检查注释语言元素的位置。 |
AnnotationUseStyle | 检验控制注释的风格。 |
AnonInnerLength | 检查长匿名内部类。 |
ArrayTrailingComma | 检查数组初始化包含可选的逗号。 |
ArrayTypeStyle | 检查数组类型定义的风格。 |
AtclauseOrder | 检查at-clauses的顺序 |
AvoidEscapedUnicodeCharacters | 限定使用Unicode转义符。 |
AvoidInlineConditionals | 检测到内联条件。 |
AvoidNestedBlocks | 发现嵌套块。 |
AvoidStarImport | 检查发现使用*符号的导入语句。 |
AvoidStaticImport | 检查发现静态导入。 |
BooleanExpressionComplexity | 限制了嵌套的布尔操作符(& &,| |,&,|,^)到指定的深度(默认= 3)。 |
ClassDataAbstractionCoupling | 这个指标计算出在指定的类中实例化的其他类的数量。 |
ClassFanOutComplexity | 依赖于一个给定的类的其他类的数量。 |
ClassTypeParameterName | 检查类的类型、参数、名称符合指定的格式。 |
ConstantName | 检查常量的名称符合指定的格式 |
CommentsIndentation | 控制注释和代码之间的缩进 |
CovariantEquals | 检查定义的equals方法确实覆盖了Object的equals |
CustomImportOrder | 检查一组的导入声明出现在用户指定的顺序 |
CyclomaticComplexity | 对于复杂循环的限制 |
由于太多了,就不一一介绍了,具体可以参见官网(http://checkstyle.sourceforge.net/checks.html),下面拷贝了网上的一些总结:
(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:符合正则表达式,并且在代码中出现一定次数
根据以上总结可以看出,基本上大部分检查功能都已支持