自动代码规范CheckStyleWord格式.docx

1、命令行工具ANT任务同时，CheckStyle目前有很多针对流行IDE的插件，例如Eclipse、IntelliJ IDEA、JBuilder等。但是，大部分都是基于2.4的版本，新版本的特性不支持，同时配置也较为复杂。因为一般情况下，如果与开发过程与环境集成起来，编码规范的检查会更加有效，因此，作为ANT任务的运行方式使用的更加普遍。在ANT的build.xml文件中添加CheckStyle任务的步骤如下：1. 将checkstyle-all-3.1.jar拷贝到项目的LIB目录；2. 建立配置文件；3. 声明CheckStyle任务：taskdef resource=checkstylet

2、ask.properties classpath=$lib/checkstyle-all-3.1.jar/4. 建立CheckStyle任务：target name=checkstylecheckstyle cfileset dir=$src includes= */*.java /checkstyle/target2.4. 定制CheckStyleCheckStyle的执行基于XML配置文件，它的主要组成部分是：Module：整个配置文件就是一棵Module树。根节点是Checker Module。Properties：它来决定一个Module如何进行检查。每个Module都有一个默认值，如

3、果不满足开发需求，可以设定其它的值。下面是一个示例：module name=MethodLengthproperty name=max value=60/module它表示，如果方法或者构造函数的长度超过60行，CheckStyle就会报错。而默认值是150行。以下是一段CheckStyle对于Maven项目源文件的检查报告：Method createExpression is not designed for extension - needs to be abstract, final or empty. 91Unable to get class information for Jell

4、yException. 91Line has trailing spaces. 93Line has trailing spaces. 104evaluate is not designed for extension - needs to be abstract, final or empty. 113Parameter context should be final. 113Line has trailing spaces. 130getExpressionText is not designed for extension - needs to be abstract, final or

5、 empty. 131Line has trailing spaces. 134Line has trailing spaces. 135toString is not designed for extension - needs to be abstract, final or empty. 137isSupportAntVariables is not designed for extension - needs to be abstract, final or empty. 156setSupportAntVariables is not designed for extension -

6、 needs to be abstract, final or empty. 168Parameter supportAntVariables should be final. 168supportAntVariables hides a field. 168isValidAntVariableName is not designed for extension - needs to be abstract, final or empty. 183Parameter text should be final. 183一般情况下，与IDE集成在一起使用的时候，点击出错的条目，可以跳转到相应的代码

7、。本贴来自ZDNetChina中文社区,本贴地址： 三、CheckStyle的最佳实践3.1. Suns Code Conventions的修改在CheckStyle的最新发布版本中，有一个对于Sun的Java编码规范的配置文件信息。但是，其中有很多条目并不一定符合项目开发的需要。就算是对于很多优秀的开源项目，按照这个规范来进行检查，也会出现成千上万的错误。下面提出的一些修改意见，是从实际项目执行过程中总结出来的，可以作为大家的参考。我们以CheckStyle3.0配置文件的顺序来介绍：1. 去除对于每个包都有一个package.html文件的限制；!-module name=PackageH

8、tml/-2. 修改对于JavaDoc Comments的限定：对于很多使用Code Generator的项目来说，需要将手写代码与生成代码、单元测试代码的检查分开进行； 3. 修改对于体积大小的限制：目前，很多显示器都是17寸，而且打印方面的限制也比以前有所改善，同时，由于代码中Factory等模式的运用，以及有意义的 方法名称等约定，默认每行代码的长度（80）是远远不能满足要求；对于方法长度等等，也应该根据项目情况自行决定：FileLengthLineLength120/module300ParameterNumber/4. 修改对于Throws的的限制：允许Throws Unchecke

9、d Exception以及Throws Subclass Of Another Declared Exception。RedundantThrowsallowUncheckedtrueallowSubclasses/module5. 修改成员变量的可视性：一般情况下，应该允许Protected Members以及Package Visible Members。VisibilityModifierprotectedAllowedpackageAllowed/module3.2. CheckStyle应用的最佳实践采用CheckStyle以后，编码规范的检查就变得及其简单，可以作为一项切实可行的实

10、践加以执行。一般情况下，在项目小组中引入CheckStyle可以按照下面的步骤进行：1 强调Code Review与Code Conventions的重要作用；2 介绍CheckStyle；3 初步应用CheckStyle：参照CheckStyle附带的配置文件，酌情加以剪裁，在项目的Ant配置文件中，添加CheckStyle任务，可以单独执行；4 修改、定型CheckStyle的配置文件：按照基本配置文件执行一段时间（23周），听取开发人员的反馈意见，修改配置信息； 5 作为开发过程的日常实践，强制执行CheckStyle：稳定CheckStyle的配置信息，同时将CheckStyle任务作

11、为Build的依赖任务 或者配置源码控制系统（目前，CheckStyle可以与CVS有效集成），使得代码在加入系统之前必须通过检查。同时需要指出的是，CheckStyle的有效执行需要依赖两个条件：Ant的广泛应用：CheckStyle基于Ant执行的方式比较容易，而且可以在项目内容形成一致的执行环境。同时，也比较容易与其它任务，例如Build等发生关联。 IDE Format Code的强大功能：由于CheckStyle本身并没有提供很强大的Code Format等功能，因此，需要借助IDE的帮助，从而使得在发生错误的时候，可以很容易的进行修复。目前，主流的Java IDE都提供了这方面的功

12、能，IDEA在这方面尤其突出。它提供的统一、可定义的Code Format Template（项目小组内部可以使用统一模板）以及方便的快捷键功能（Ctrl+Alt+T：Format Code, Ctrl+Alt+O：Optimize Import等）。四、结论利用CheckStyle可以方便的对于编码的Code Conventions进行检查，同时，也有效地减少了Code Review的工作，使得Reviw人员的精力更多的集中到逻辑和性能检查。Checkstyle的结果输出序号 输出内容意义1 Type is missing a javadoc commentClass 缺少类型说明2“” s

13、hould be on the previous line “” 应该位于前一行3Methos is missing a javadoc comment方法前面缺少javadoc注释4Expected throws tag for “Exception”在注释中希望有throws的说明5“.” Is preceeded with whitespace “.” 前面不能有空格6“.” Is followed by whitespace“.” 后面不能有空格7“=” is not preceeded with whitespace“=” 前面缺少空格8“=” is not followed wit

14、h whitespace“=” 后面缺少空格9“” should be on the same line“” 应该与下条语句位于同一行10Unused param tag for “unused”没有参数“unused”，不需注释11Variable “CA” missing javadoc变量“CA”缺少javadoc注释12Line longer than 80characters行长度超过8013Line contains a tab character行含有”tab” 字符14Redundant “Public” modifier冗余的“public” modifier15Final

15、modifier out of order with the JSL suggestionFinal modifier的顺序错误16Avoid using the “.*” form of importImport格式避免使用“.*”17Redundant import from the same package从同一个包中Import内容18Unused import-java.util.listImport进来的java.util.list没有被使用19Duplicate import to line 13重复Import同一个内容20Import from illegal package

16、从非法包中 Import内容21“while” construct must use “”“while” 语句缺少“”22Variable “sTest1” must be private and have accessor method变量“sTest1”应该是private的，并且有调用它的方法23Variable “ABC” must match pattern “a-za-zA-Z0-9*$”变量“ABC”不符合命名规则“a-za-zA-Z0-9*$”24“（” is followed by whitespace“（” 后面不能有空格 25“）” is proceeded by whi

17、tespace“）” 前面不能有空格 不太明白的错误解答1. X hides a field.public class Foo private int bar; public Foo（int bar） this.bar = bar; public final int getBar（） return bar; 解释：全局private int bar;和局部public Foo（int bar）的bar变量名字重复。此错误，可以忽略不检查。2. Parameter X should be final.public class Foopublic Foo（int bar）的局部变量，被认为是不可改

18、变的，检查需要加上final关键字定义public Foo（final int bar）3. Redundant modifier.public interface CacheHRTreeService extends Manager /* * Organization Tree * * param orgDto * return * throws Exception */ public void setOrganization（OrganizationDTO orgDto） throws Exception; /* public OrganizationDTO getOrganization

19、（） throws Exception;.多余的字段。public OrganizationDTO getOrganization（） throws Exception;此时public为多余的字段，因为interface定义的时候，就是public的。需要检查。4. - Class X should be declared as final.解释：对于单例设计模式，要求返回唯一的类对象。但是HRFactory和ContextFactory为优化的两个类，不需求检查。其他的单例类，依然需要进行检查。5. Utility classes should not have a public or d

20、efault constructor.解释：工具类不必提供默认的构造方法。需要检查，仅仅为提示。6. File does not end with a newline.解释：虽然JAVA程序不要求结尾要用新行，但是习惯上应该要空一行。7. - Method addChildrenId is not designed for extension - needs to be abstract, final or empty.解释：通过父类继承的，此类有点特殊可以忽略此类。8. Variable id must be private and have accessor methods.BaseHRDTO类，为父类，属性给子类继承，比较特殊。但是其他的类，声名需要加上范围private关键字9. -Array brackets at illegal position.代码写法，习惯不一样。需要检查，仅仅提示。