[转载]checkStyle使用手册

cosmo1987

浏览: 80941 次
性别:
来自: 杭州

最近访客更多访客>>

cjm123s

azrael6619

朱尉铭

伊苏

博主相关

博客

微博

相册

留言

关于我

文章分类

社区版块

存档分类

博客分类：

java
checkStyle

java checkstyle

Checkstyle是SourceForge下的一个项目，如名所示，是检查java程序源代码编码风格的，是java程序员不可或缺的工具，用以检查自己的编码习惯是否符合公司的要求或Sun的约定。Checkstyle是目前最广泛使用的代码检查工具,功能强大，操作简单，可以和Ant结合使用，最重要的是其是Open Source的。提供了一个帮助JAVA开发人员遵守某些编码规范的工具。

CheckStyle默认提供一些主要检查内容：
　　·Javadoc注释
　　·命名约定
　　·标题
　　·Import语句
　　·体积大小
　　·空白
　　·修饰符
　　·块
　　·代码问题
　　·类设计
　　·混合检查（包括一些有用的，非必须的System.out和printstackTrace）

从上面可以看出，CheckStyle提供的大部分功能都是对于代码规范的检查，而没有提供象PMD和Jalopy那样的增强代码质量和修改代码的功能。但是，对于团队开发，尤其是强调代码规范的公司来说，它的功能已经足够强大。CheckStyle默认提供了对Sun编程规范的支持。通过编写配置文件，可以增加自己的检查规范。

CheckStyle的配置文件是基于XML而非Properties文件。它提供了两种运行的方式：命令行工具和ANT任务。另外CheckStyle目前有很多针对流行IDE的插件，例如Eclipse、IntelliJ IDEA、JBuilder等。

1、和Ant配合使用

从http://sourceforge.net/project/showfiles.php?group_id=29721下载最新版本的CheckStyle，目前的版本是4.3。把解压后目录复制到项目的lib目录下，然后就可以和Ant配合使用了。
在Ant脚本中，首先定义CheckStyle的解压目录位置：
<path id="checkstyle.path">
    <fileset dir="${lib.home}/checkstyle-4.3">
        <include name="**/*.jar"/>
    </fileset>
</path>
接着声明CheckStyle任务：
<taskdef resource="checkstyletask.properties" classpathref="checkstyle.path"/>
然后建立CheckStyle任务：
<target name="checkstyle">

     <checkstyle config="${lib.home}/checkstyle-4.3/sun_checks.xml"
             failureProperty="checkstyle.failure"
             failOnViolation="false">
             
             <formatter type ="xml" tofile ="d:/report.xml"/>
<!—指明要检查的文件 -->
             <fileset dir ="${src.home}">
                 <include name ="**/*.java"/>
             </fileset>
         </checkstyle>

         <style in="d:/report.xml" out ="d:/report.html"
style="${lib.home}/checkstyle-4.3/contrib/checkstyle-noframes.xsl"/>
</target>
最后运行ant checkstyle即可。

注：checkstyle提供了缺省的xslt，用来进行xml的格式转换。它们都放在contrib目录中。checkstyle同样也提供了自定义的check，但与PMD相比，书写要复杂。详细情况请参见checkstyle的文档。

2、 Eclipse插件

在Eclipse当中安装CheckStyle插件非常方便，可以参照以下五个步骤进行：
a.       在Eclipse当中分别打开一下菜单 Help->Software Updates->Find and Install
b.       选择 Search for new features to install 选项然后点击 Next
c.       新建一个 New Remote Site...
d.       输入名称（比如：CheckStyle Plug-in）和下面的URL：http://eclipse-cs.sourceforge.net/update
e.       开始安装
安装好CheckStyle以后，不符合CheckStyle编码规范的信息将会出现在“问题(Problems)”视图当中，可以点击问题视图的“过滤器（Filters）”配置显示内容；

选择“Window －> Preferences -> Checkstyle”进入CheckStyle的配置页面。CheckStyle默认的sun规范检查文件是：sun_checks.xml， CheckStyle的配置文件的导入/导出就在配置页面右侧。我们也可以导出以后，经过修改量身定做自己的规范。比如我们已经按照规范做好了一个代码规范文件，并且取名为“我的软件”，那么我们可以把这个规范导入，在location中加入自定义的xml文件，Type选择External Configuration File，名称填上：“我的软件”，然后填上相应的描述，然后点击browse按钮找到相应的配置文档，点击ok就可以了。这样checkstyle当中又多了一个叫做“我的软件”的规范。

CheckStyle是一个非常复杂的代码风格检查过程：包括缩进，命名规范等，因此缺省是Disable的，启动针对一个项目的CheckStyle需要用右键点击项目，在弹出的菜单中选择“Checkstyle－>Check Code with Checkstyle”。这样，我们就能使用CheckStyle对文档进行规范了。下面这个例子是使用CheckStyle以后，在eclipse中对不符合规范的代码进行标注，这样我们就可以按照“我的软件”规范对代码进行约束了。下图当中左边的放大镜图标表示此行代码不符合规范，当鼠标悬停在上面的时候，会显示这行代码的问题所在。（图略）

3、定制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">


<module name="Checker">
     
     
     
     
     
     
     
     
     <module name="Translation" />
     <module name="TreeWalker">
         
         
         
         <module name="JavadocMethod">
              <property name="scope" value="public" />
              
              <property name="allowMissingParamTags" value="true" />
              
              <property name="allowMissingThrowsTags" value="true" />
              
              <property name="allowMissingReturnTag" value="true" />
         </module>
         
         <module name="JavadocType" />
         
         <module name="JavadocVariable">
              <property name="scope" value="protected" />
         </module>
         
         <module name="JavadocStyle">
              <property name="scope" value="public" />
              
              <property name="checkFirstSentence" value="false" />
              
              <property name="checkHtml" value="true" />
         </module>
         
         
         
         
         <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" />
         
         
         
         
         
         
         
         
         
         
         
         <module name="AvoidStarImport" />
         
         <module name="IllegalImport">
              <property name="illegalPkgs" value="sun.*" />
         </module>
         
         <module name="RedundantImport" />
         
         <module name="UnusedImports" />
         
         
         
         
         
         
         
         
         
         
         
         <module name="FileLength">
              <property name="max" value="2000" />
         </module>
         
         <module name="LineLength">
              
              
              <property name="max" value="120" />
         </module>
         
         <module name="MethodLength">
              <property name="max" value="200" />
              
              <property name="countEmpty" value="false" />
         </module>
         
         <module name="AnonInnerLength">
              <property name="max" value="60" />
         </module>
         
         <module name="ParameterNumber" />
         
         
         <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" />
         
         
         
         
         <module name="RedundantModifier" />
         
         
         
         
         <module name="LeftCurly" />
         
         <module name="NeedBraces" />
         
         <module name="RightCurly">
              <property name="option" value="alone" />
         </module>
         
         <module name="AvoidNestedBlocks" />
         
         
         <module name="AvoidInlineConditionals" />
         <module name="CovariantEquals" />
         <module name="DeclarationOrder" />
         <module name="DefaultComesLast" />
         <module name="DoubleCheckedLocking" />
         
         <module name="EqualsHashCode" />
         
         
         <module name="FallThrough" />
         
         <module name="HiddenField">
              <property name="ignoreConstructorParameter" value="true" />
              <property name="ignoreSetter" value="true" />
         </module>
         
         
         <module name="IllegalInstantiation" />
         
         <module name="IllegalTokenText" />
         <module name="IllegalType" />
         <module name="InnerAssignment" />
         
         <module name="MissingSwitchDefault" />
         <module name="MultipleVariableDeclarations" />
         
         
         
         <module name="RedundantThrows" />
         
         <module name="SimplifyBooleanExpression" />
         <module name="SimplifyBooleanReturn" />
         <module name="StringLiteralEquality" />
         <module name="SuperClone" />
         <module name="SuperFinalize" />
         <module name="UnnecessaryParentheses" />
         
         
         
         
         
         
         
         
         <module name="InterfaceIsType" />
         
         <module name="VisibilityModifier">
              <property name="packageAllowed" value="true" />
              <property name="protectedAllowed" value="true" />
         </module>
         
         
         
         
         
         
         <module name="ArrayTypeStyle" />
         
         
         
         <module name="GenericIllegalRegexp">
              <property name="format" value="System.out.print" />
              <property name="message" value="bad practice of use System.out.print" />
         </module>
         <module name="GenericIllegalRegexp">
              <property name="format" value="System.exit" />
              <property name="message" value="bad practice of use System.exit" />
         </module>
         <module name="GenericIllegalRegexp">
              <property name="format" value="printStackTrace" />
              <property name="message" value="bad practice of use printStackTrace" />
         </module>
         
         <module name="TodoComment">
              <property name="format" value="TODO" />
         </module>
         
         
         
         
         
         <module name="UpperEll" />
         
         
         
         
         
         <module name="CyclomaticComplexity">
              <property name="max" value="12" />
         </module>
     </module>
</module>

分享到：

restlet2.0学习——请求超时设置 | [转载]高性能JAVA开发之内存管理

2012-08-23 20:28
浏览 6828
评论(0)
分类:企业架构
查看更多

发表评论

您还没有登录,请您登录后再发表评论

最近访客更多访客>>

博主相关

文章分类

社区版块

存档分类

最新评论