定制CheckStyle

在CheckStyle的最新发布版本中，有一个对于Sun的Java编码规范的配置文件信息。但是，其中有很多条目并不一定符合项目开发的需要。就算是对于很多优秀的开源项目，按照这个规范来进行检查，也会出现成千上万的错误。这就是为什么需要定制CheckStyle的原因。

CheckStyle的执行基于XML配置文件，它的主要组成部分是：
　　·Module：整个配置文件就是一棵Module树。根节点是Checker Module。
　　·Properties：它来决定一个Module如何进行检查。每个Module都有一个默认值，如果不满足开发需求，可以设定其它的值。
　　下面是一个示例：

＜module name="MethodLength"＞

＜property name="max" value="60"/＞
＜/module＞

它表示，如果方法或者构造函数的长度超过60行，CheckStyle就会报错。而默认值是150行。一般情况下，与IDE集成在一起使用的时候，点击出错的条目，可以跳转到相应的代码。

对于所有的模块来书，如果有这个模块则说明检测这一项，没有则不检测这一项。所有的模块中，其ROOT必须为Checker。配置文件中某些元素的具体讲解如下。

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD CheckeConfiguration 1.2//EN"

"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

<!-- 对于所有的模块来说,如果有这个模块则说明检测这一项,没有则不检测这一项 -->

<!-- 所有的模块中,其ROOT必须为Checker -->

<module name="Checker">

     <!-- 检验每个包是否存在package.html文件-->

     <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->

     <!--

     <module name="PackageHtml"/>

     -->

     <!-- 检验每个文件末尾是否有一个空行,在UNIT机器上是有的,在CVS上如果没有会有警告的-->

     <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->

     <!--

     <module name="NewlineAtEndOfFile"/>

     -->

     <!-- Checks that property files contain the same keys. -->

     <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->

     <module name="Translation" />

     <module name="TreeWalker">

         <!-- Checks for Javadoc comments. -->

         <!-- See http://checkstyle.sf.net/config_javadoc.html -->

         <!-- Checks Javadoc commentsefor method definitions.-->

         <module name="JavadocMethod">

              <property name="scope" value="public" />

              <!-- 是否允许错误的参数声明,true为允许,缺省为不允许 -->

              <property name="allowMissingParamTags" value="true" />

              <!-- 是否允许错误的错误声明,true为允许,缺省为不允许 -->

              <property name="allowMissingThrowsTags" value="true" />

              <!-- 是否允许错误的返回类型声明,true为允许,缺省为不允许 -->

              <property name="allowMissingReturnTag" value="true" />

         </module>

         <!--Checks Javadoc comments for class and interface definitions.-->

         <module name="JavadocType" />

         <!-- Checks that variables have Javadoc comments.-->

         <module name="JavadocVariable">

              <property name="scope" value="protected" />

         </module>

         <!-- 检查Javadoc的格式 -->

         <module name="JavadocStyle">

              <property name="scope" value="public" />

              <!-- Comment的第一句的末尾是否要有一个句号,true必须有,default为true -->

              <property name="checkFirstSentence" value="false" />

              <!-- 检查错误的HTML脚本,比如不匹配,true检查,default为true -->

              <property name="checkHtml" value="true" />

         </module>

         <!-- Checks for Naming Conventions. -->

         <!-- See http://checkstyle.sf.net/config_naming.html -->

         <!-- 确省必须以Abstract开始或者以Factory结束 -->

         <!--

         <module name="AbstractClassName"/>

         -->

         <module name="ConstantName" />

         <module name="LocalFinalVariableName" />

         <module name="LocalVariableName" />

         <module name="MemberName" />

         <module name="MethodName" />

         <module name="PackageName" />

         <module name="ParameterName" />

         <module name="StaticVariableName" />

         <module name="TypeName" />

         <!-- Checks for Headers -->

         <!-- See http://checkstyle.sf.net/config_header.html -->

         <!-- 检查文件是否以指定文件开始,这里最好是放一些版权信息和工程描述 -->

         <!-- headerFile:指定的文件 -->

         <!-- ignoreLines:忽略哪些行,以","分隔 -->

         <!--

         <module name="Header">

             <property name="headerFile" value="java.header"/>

             <property name="ignoreLines" value="2, 3, 4, 5"/>

         </module>

         -->

         <!-- Following interprets the header file as regular expressions. -->

         <!--

         <module name="RegexpHeader"/>

         -->

         <!-- Checks for imports -->

         <!-- See http://checkstyle.sf.net/config_import.html -->

         <!-- 检查使用*号的导入,默认为全部类 -->

         <module name="AvoidStarImport" />

         <!-- 检查是否有非法的包,确省检查sun.*;对于某些包是不建议直接调用的 -->

         <module name="IllegalImport">

              <property name="illegalPkgs" value="sun.*" />

         </module>

         <!-- 检查多于的导入,如一个类导入了多次 -->

         <module name="RedundantImport" />

         <!-- 检查没有使用的导入 -->

         <module name="UnusedImports" />

         <!-- 导入排序 -->

         <!-- groups:分组,哪些是一组的 -->

         <!-- ordered:同一个组内是否排序,true排序,确省为true -->

         <!-- separated:各个组之间是否需要用空行分隔,确省为false -->

         <!-- caseSensitive:是否是大小写敏感的,确省是 -->

         <!--

         <module name="ImportOrder">

             <property name="groups" value="java,javax"/>

             <property name="ordered" value="true"/>

             <property name="separated"evalue="true"/>

             <property name="caseSensitive" value="true"/>

         </module>

         -->

         <!-- Checks for Size Violations. -->

         <!-- See http://checkstyle.sf.net/config_sizes.html -->

         <!-- 检查方法内可执行语句的个数,确省为30行 -->

         <!--

         <module name="ExecutableStatementCount">

             <property name="max" value="30"/>

         </module>

         -->

         <!-- 文件的最大行数,缺省为1500 -->

         <module name="FileLength">

              <property name="max" value="2000" />

         </module>

         <!-- 每行的最大字符数,缺省为80 -->

         <module name="LineLength">

              <!-- 忽略指定格式的行,如*号开始的,等 -->

              <!--

              <property name="ignorePattern" value="^ ** *[^ ]+$"/>

              -->

              <property name="max" value="120" />

         </module>

         <!-- 方法的最大行数,缺省为150 -->

         <module name="MethodLength">

              <property name="max" value="200" />

              <!-- 统计时是否包括空行和以//开始的注释,缺省为统计(true)-->

              <property name="countEmpty" value="false" />

         </module>

         <!-- 匿名类的最大行数,缺省为20 -->

         <module name="AnonInnerLength">

              <property name="max" value="60" />

         </module>

         <!-- 检查方法和构造子参数的最大个数,缺省为7 -->

         <module name="ParameterNumber" />

         <!-- Checks for whitespace -->

         <!-- See http://checkstyle.sf.net/config_whitespace.html -->

         <module name="EmptyForInitializerPad" />

         <module name="EmptyForIteratorPad" />

         <module name="MethodParamPad">

              <property name="allowLineBreaks" value="true" />

         </module>

         <module name="NoWhitespaceAfter" />

         <module name="NoWhitespaceBefore" />

         <module name="OperatorWrap" />

         <module name="ParenPad" />

         <module name="TypecastParenPad" />

         <module name="TabCharacter" />

         <module name="WhitespaceAfter" />

         <module name="WhitespaceAround" />

         <!-- Modifier Checks -->

         <!-- See http://checkstyle.sf.net/config_modifiers.html -->

         <!-- 要求JLS suggestions -->

         <!--

         <module name="ModifierOrder"/>

         -->

         <module name="RedundantModifier" />

         <!-- Checks for blocks. You know, those {}'s -->

         <!-- See http://checkstyle.sf.net/config_blocks.html -->

         <!-- 检查空块 -->

         <!--

         <module name="EmptyBlock"/>

         -->

         <module name="LeftCurly" />

         <!-- 检查只有必须有{},确省为必须,主要在if,else时有这样的情况 -->

         <module name="NeedBraces" />

         <!-- 检查"}",确省在同一行 -->

         <module name="RightCurly">

              <property name="option" value="alone" />

         </module>

         <!-- 检查多余嵌套的{},请看文档,不易说明 -->

         <module name="AvoidNestedBlocks" />

         <!-- Checks for common coding problems -->

         <!-- See http://checkstyle.sf.net/config_coding.html -->

         <module name="AvoidInlineConditionals" />

         <module name="CovariantEquals" />

         <module name="DeclarationOrder" />

         <module name="DefaultComesLast" />

         <module name="DoubleCheckedLocking" />

         <!--

             <module name="EmptyStatement"/>

         -->

         <module name="EqualsHashCode" />

         <!-- 变量必须初始化为自己的类型,如果给一个Object类型的变量初始化为null会提示 -->

         <!--

         <module name="ExplicitInitialization"/>

         -->

         <module name="FallThrough" />

         <!--

         <module name="FinalLocalVariable"/>

         -->

         <module name="HiddenField">

              <property name="ignoreConstructorParameter" value="true" />

              <property name="ignoreSetter" value="true" />

         </module>

         <!-- Exception, Throwable, RuntimeException是不允许catch的 -->

         <!--

         <module name="IllegalCatch"/>

         -->

         <module name="IllegalInstantiation" />

         <!-- 有一个bug,比如i++居然都不认

         <module name="IllegalToken"/>

         -->

         <module name="IllegalTokenText" />

         <module name="IllegalType" />

         <module name="InnerAssignment" />

         <!--检查直接数

         <module name="MagicNumber"/>

         检查是否有构造子

         <module name="MissingCtor"/>

         -->

 

更多checkstyle资料下载：