代码规范工具-Checkstyle

 1、Checkstyle简介

     Checkstyle是一个静态分析工具，检查Java程序代码。主要关注的是java的代码格式。
       主要包括：Javadoc注释，命名规范，多余没用的Imports，Size度量，如过长的方法，缺乏必要的空格Whitespace，重复代码

2、Checkstyle下载及安装

    2.1 Checkstyle下载

    Checkstyle能够从其官网下载，速度很快。官网地址是http://eclipse-cs.sourceforge.net/#!/。
    下载net.sf.eclipsecs-updatesite_6.16.0.201603042325.zip

    2.1 Checkstyle安转

如下的安装过程，基于Eclipse Java EE IDE for Web Developers。
help --》install new software
安转完后重启eclipse。

打开eclipse，选择window->preferences->左边导航栏中Checkstyle，若是出现checkstyle说明你安装成功。

3、Checkstyle的使用

右击项目能够看到

点击Check Code with Checkstyle

能够看到

双击任何一个条目能够跳转到相应代码

4、关于各个检查项的详细参考

1Type is missing a javadoc commentClass 缺乏类型说明

2“{” should be on the previous line“{” 应该位于前一行。解决方法：把“{”放到上一行去

3Methos is missing a javadoc comment 方法前面缺乏javadoc注释。解决方法：添加javadoc注释 相似这样：

/**

* set default mock parameter.（方法说明）

* @param additionalParameters parameter additional(参数名称)

* @return data manager(返回值说明)

* @throws Exception if has error(异常说明)

*/

4 Expected @throws tag for “Exception”在注释中但愿有@throws的说明

解决方法：在方法前得注释中添加这样一行：* @throws Exception if has error(异常说明)

5“.” Is preceeded with whitespace “.” 前面不能有空格。解决方法：把“（”前面的空格去掉

6“.” Is followed by whitespace“.” 后面不能有空格。解决方法：把“）”后面的空格去掉

7“=” is not preceeded with whitespace“=” 前面缺乏空格。解决方法：在“=”前面加个空格

8“=” is not followed with whitespace“=” 后面缺乏空格。解决方法：在“=”后面加个空格

9“}” should be on the same line“}” 应该与下条语句位于同一行。解决方法：把“}”放到下一行的前面

10Unused @param tag for “unused”没有参数“unused”，不需注释

解决方法：“* @param unused parameter additional(参数名称)” 把这行unused参数的注释去掉“

11 Variable “CA” missing javadoc变量“CA”缺乏javadoc注释

解决方法：在“CA“变量前添加javadoc注释：/** CA. */（注意：必定记得加上“.”）

12 Line longer than 80characters行长度超过80  。解决方法：把它分红多行写。必要时候，能够ctrl+shift+f

13 Line contains a tab character行含有”tab” 字符。快速解决方法：可使用editplus中的format功能，把tab字符转化为空格，而后保存Editplus英文版安装文件在我机子上有。须要的能够来拷贝。注册Editplus，点击安装文件中注册的文件

14 Redundant “Public” modifier冗余的“public” modifier   。解决方法：冗余的“public”

15 Final modifier out of order with the JSL suggestion Final modifier的顺序错误

16 Avoid using the “.*” form of importImport格式避免使用“.*”

17 Redundant import from the same package从同一个包中Import内容

18 Unused import-java.util.listImport进来的java.util.list没有被使用。解决方法：去掉导入的多余的类

19 Duplicate import to line 13重复Import同一个内容    解决方法：去掉导入的多余的类

20 Import from illegal package从非法包中 Import内容

21 “while” construct must use “{}”  “while” 语句缺乏“{}”

22 Variable “sTest1” must be private and have accessor method变量“sTest1”应该是private的，而且有调用它的方法

23 Variable “ABC” must match pattern “^[a-z][a-zA-Z0-9]*$”变量“ABC”不符合命名规则“^[a-z][a-zA-Z0-9]*$”解决方法：把这个命名改为符合规则的命名 “aBC”

24 “(” is followed by whitespace“(” 后面不能有空格 25“)”is proceeded by whitespace“)” 前面不能有空格

解决方法：把前面或者后面的空格去掉

25 First sentence should end with a period.解决方法：你的注释的第一行文字结束应该加上一个"."。

26 Redundant throws: 'NameNotFoundException' is subclass of 'NamingException'. 'NameNotFoundException '是'NamingException'的子类重复抛出异常。

解决方法：若是抛出两个异常，一个异常类是另外一个的子类，那么只须要写父类

去掉NameNotFoundException异常，对应的javadoc注释异常注释说明也须要去掉

27 Parameter docType should be final. 参数docType应该为final类型  解决方法：在参数docType前面加个final

28 Line has trailing spaces. 多余的空行  解决方法：去掉这行空行

29 Must have at least one statement.  至少一个声明

解决方法：} catch (NumberFormatException nfe) {

LOG.error("Auto Renews the agreement failed", nfe);//异常捕捉里面不能为空，在异常里面加一句话。如打印等等

30 '>' is not followed by whitespace.而且又有 '(' is preceded with whitespace.

定义集合和枚举的时候的时候，最后一个“>”后面要有空格，“（”前面不允许有空格。解决方法：去掉泛型

31 Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag 'SystemException'.缘由：不合理的throws。

解决方法：要确保某些类型，如某些类、接口不被throws。把声明的异常去掉。在实现类中抛出异常

网上参考解决方法：一、这是CheckStyle报的错。一般须要Refreh, clean/build这个Project. 若是不行，能够尝试clean all projects, restart Eclipse.

二、由于编译好的类没有在checkstyle的classpath中.因此, 只要将编译好的class配置到在<checkstyle/>的classpath中就没有这个问题了.另外, 还发现checkstyle的line length好像也有点问题, 明明没有超过120个字符, 却仍是报错.无奈, 我把Eclipse中java > code style > formatter中的Maximum line with改为了100, 而后format一下, 基本就没有问题了

32 File does not end with a newline.解决方法：删掉报错的类，新建一个同名的类，把代码所有复制过去

33 Utility classes should not have a public or default constructor. 接口中的内部类中不该该有公共的或者默认的构造方法

解决方法：在内部类中，定义一个私有的构造方法，而后内部类声明为final类型。若是前面有static，那么final还必须放在static以后

34 Variable 'functionCode' must be private and have accessor methods.变量要改为private而后提供访问的方法

解决方法：给这些变量的修饰符改为private，而后提供set，get方法，并加上对应的方法javadoc注释、参数注释。并在返回值和参数类型前添加final。并把调用了这个变量的地方改为经过方法访问

35   '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变量名字重复。
解决方法：把方法里面的参数名称改变下就能够了public Foo(int newBar)
    {
        this.bar = newBar;
    }。

36 Got an exception - Unexpected character 0xfffd in identifier

这是由于CheckStyle不能识别制定的编码格式。

网上参考解决方法：

一、Eclipse中能够配置，在Other-->checker中能够指定

二、能够修改checkstyle配置文件：

<module name="Checker">

<property name="severity" value="warning"/>

<property name="charset" value="UTF-8"/>

<module name="TreeWalker">

若是是UTF-8的话，就添加加粗斜体的那条语句，就能够了。

37  Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag *whatever*.
网上参考解决方法：选中CheckSytle的JavaDoc --> Method JavaDoc --> logLoadErrors。若是是CheckStyle本身加载时出错的，打个Log就能够了，不要整出Errors吓人。
还有一处也可能包出一样的错误。Coding Problems --> Redundant Throws --> logLoadErrors选中便可

38 Expected @param tag for 'dataManager'. 缺乏dataManager参数的注释   解决方法：在注释中添加@param dataManager DataManager

网上一些其余错误的解答：
1. Parameter X should be final.
public class Foo
{
    private int bar;

    public Foo(int bar)
    {
        this.bar = bar;
    }

    public final int getBar()
    {
        return bar;
    }
}

解释：public Foo(int bar)的局部变量，被认为是不可改变的，检查须要加上final关键字定义public Foo(final int bar)此错误，能够忽略不检查。

2. Redundant 'X' modifier.

public interface CacheHRTreeService extends Manager {

/**
  * Organization Tree
  * @param orgDto
  * @return
  * @throws Exception
  */
public void setOrganization(OrganizationDTO orgDto) throws Exception;

/**
  * Organization Tree
  * @return
  * @throws Exception
  */
public OrganizationDTO getOrganization() throws Exception;
......
}

解释：多余的字段。public OrganizationDTO getOrganization() throws Exception;此时public为多余的字段，由于interface定义的时候，就是public的。

须要检查。

3. - Class X should be declared as final.

解释：对于单例设计模式，要求返回惟一的类对象。可是HRFactory和ContextFactory为优化的两个类，不需求检查。
其余的单例类，依然须要进行检查。

4. - Method 'addChildrenId' is not designed for extension - needs to be
  abstract, final or empty.

解释：经过父类继承的，此类有点特殊能够忽略此类。

5. Variable 'id' must be private and have accessor methods.解释：BaseHRDTO类，为父类，属性给子类继承，比较特殊。可是其余的类，声名须要加上范围'private'关键字。须要检查。

6. -Array brackets at illegal position.解释：代码写法，习惯不同。须要检查，仅仅提示

 

文章参考： http://blog.csdn.net/maritimesun/article/details/7668718                     http://www.cnblogs.com/bluesky4485/archive/2011/11/30/2269198.html