提高Java代码质量的Eclipse插件之Checkstyle的使用详解

CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要但是枯燥的任务中解脱出来。

CheckStyle检验的主要内容 
·Javadoc注释 
·命名约定 
·标题 
·Import语句 
·体积大小 
·空白 
·修饰符 
·块 
·代码问题 
·类设计 
·混合检查(包活一些有用的比如非必须的System.out和printstackTrace)

从上面可以看出,CheckStyle提供了大部分功能都是对于代码规范的检查,而没有提供象PMD和Jalopy那么多的增强代码质量和修改代码的功能。但是,对于团队开发,尤其是强调代码规范的公司来说,它的功能已经足够强大。

Checkstyle插件可以集成到Eclipse IDE中去,能确保Java代码遵循标准代码样式。

一、CheckStyle 安装方法

方法一:
 
1.Eclipse中,选择Help->Software Updates->Find and Install
 
2.选择 Search for new features to install 选择Next
 
3.选择 New Remote Site
 
4.输入更新地址:http://eclipse-cs.sourceforge.net/update
 
5. 安装后重启即可
 
方法二:
 
1.下载eclipse插件
 
 
下载后,把里面的两个文件夹plugins和 features下面的文件分别拷贝到eclipse目录下面对应的plugins和features目录
 
2.如果你就这样直接启动eclipse可能会出现ClassNotFoundExceptions 等错误(一般不会出现此类错误),所以必须在启动eclipse的时候加上一个参数 -clean. 这样eclipse就可以更新它当前安装的许多插件信息
比如你得eclipse在d盘,那么就是 d:\eclipse\eclipse.exe -clean 
 
二、CheckStyle 使用
 
安装成功后,选中工程,右键选择checkstyle->check code with checkstyle,检查错误即可
 
 
三、Checkstyle的结果输出
 
检查后会发现代码中出现很多放大镜图标,如下图所示,这就是Checkstyle的输出,具体含义如下:
 
 

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

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

3 Methos 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“}” 
应该与下条语句位于同一行。解决方法:把“}”放到下一行的前面

10 Unused @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” 字符。

14 Redundant “Public” modifier
冗余的“public” 修饰符 。解决方法:去掉“public”修饰符

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

16 Avoid using the “.*” form of import
import格式避免使用“.*”。解决方法:可以先不添加import,再需要用到时直接“ctrl + o”导入即可。

17 Redundant import from the same package
从同一个包中Import内容,多余,删掉即可

18 Unused import-java.util.list
Import进来的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。把声明的异常去掉。在实现类中抛出异常

网上参考解决方法:

1、这是CheckStyle报的错。通常需要Refreh, clean/build这个Project. 如果不行,可以尝试clean all projects, restart Eclipse.

2、因为编译好的类没有在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不能识别制定的编码格式。

网上参考解决方法:

1、Eclipse中可以配置,在Other-->checker中可以指定

2、可以修改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

39 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)此错误,可以忽略不检查。

40 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的。

需要检查。

41 Class X should be declared as final.

解释:对于单例设计模式,要求返回唯一的类对象。但是HRFactory和ContextFactory为优化的两个类,不需求检查。
其他的单例类,依然需要进行检查。

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

解释:通过父类继承的,此类有点特殊可以忽略此类。

43 Variable 'id' must be private and have accessor methods.

解释:BaseHRDTO类,为父类,属性给子类继承,比较特殊。但是其他的类,声名需要加上范围'private'关键字。需要检查。

44 Array brackets at illegal position.

解释:代码写法,习惯不一样。需要检查,仅仅提示

提高Java代码质量的Eclipse插件之Checkstyle的使用详解的更多相关文章

  1. 提高Java代码质量的Eclipse插件之Checkstyle的使用具体解释

    CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发者遵守某些编码规范的工具.它可以自己主动化代码规范检查过程.从而使得开发者从这项重要可是枯燥的任务中解脱出来. Ch ...

  2. 阿里巴巴Java开发手册及Java代码规约扫描eclipse插件

    一.github地址: https://github.com/alibaba/p3c 二..eclipse插件的安装 此处示例采用eclipse,版本为 Neon.1 Release RC3 (4.6 ...

  3. 提高Java代码质量:使用枚举定义常量(转)

    一.分析  常量的声明是每一个项目中不可或缺的,在Java1.5之前,我们只有两种方式的声明:类常量和接口常量.不过,在1.5版之后有了改进,即新增了一种常量声明方式,枚举常量.代码如下: enum ...

  4. 阿里p3c(代码规范,eclipse插件、模版,idea插件)

    阿里p3c 一.说明 代码规范检查插件p3c,是根据<阿里巴巴Java开发手册>转化而成的自动化插件. (高级黑:P-3C“Orion”,反潜巡逻机,阿里大概取p3c先进,监测,发现潜在问 ...

  5. 拔高你的Java代码质量吧:推荐使用枚举定义常量(转)

    提高你的Java代码质量吧:推荐使用枚举定义常量 一.分析 常量的声明是每一个项目中不可或缺的,在Java1.5之前,我们只有两种方式的声明:类常量和接口常量.不过,在1.5版之后有了改进,即新增了一 ...

  6. 提高Objective-C代码质量心机一:简化写法

    提高OC代码质量的小心机 一.OC特性 OC 为 C 语言添加了面向对象特性,是其超集; OC 使用动态绑定的消息结构,也就是,在运行时才会检查对象类型; 接收一条消息后,究竟应执行何种代码,由运行期 ...

  7. Java 性能优化手册 — 提高 Java 代码性能的各种技巧

    转载: Java 性能优化手册 - 提高 Java 代码性能的各种技巧 Java 6,7,8 中的 String.intern - 字符串池 这篇文章将要讨论 Java 6 中是如何实现 String ...

  8. JAVA Eclipse使用Maven构建web项目详解(SSM框架)

    tips: 启动项目后,welcome-file的链接即为测试用例 部署maven web项目 Eclipse使用Maven构建web项目详解 pom.xml添加webapp依赖: <depen ...

  9. 前端html、CSS快速编写代码插件-Emmet使用方法技巧详解

    前端html.CSS快速编写代码插件-Emmet使用方法技巧详解   Emmet的前身是大名鼎鼎的Zen coding,如果你从事Web前端开发的话,对该插件一定不会陌生.它使用仿CSS选择器的语法来 ...

随机推荐

  1. getch()和getchar()之再讨论

    原文:getch()和getchar()之再讨论 在C语言的字符处理函数中,getch()和getchar()是经常让人迷惑的两个函数,他们都有一些“奇怪的”特点让初学者摸不着头脑.两个函数有很多相似 ...

  2. 浅析深究什么是SOA?

    浅析深究什么是SOA? http://blog.vsharing.com/fengjicheng/A1059842.html 金蝶中间件有限公司总经理 奉继承 博士 阅读提示: 本文探讨SOA概念背后 ...

  3. Appium Android Bootstrap源码分析之简介

    在上一个系列中我们分析了UiAutomator的核心源码,对UiAutomator是怎么运行的原理有了根本的了解.今天我们会开始另外一个在安卓平台上基于UiAutomator的新起之秀--Appium ...

  4. Oralce 导出脚本命令,定时执行

    原文:Oralce 导出脚本命令,定时执行 @echo off @echo ================================================ @echo  window ...

  5. 让低版本的IE浏览器 强制渲染为IE8 或者 以上 浏览器模式

    让低版本的IE浏览器 强制渲染为IE8 或者 以上 浏览器模式 那么就要用下面的方法:让网页兼容ie9 复制代码 代码如下: <!–[if lte IE 8]> <meta http ...

  6. 定制openwrt的根文件

    都在package文件夹之中 1 ssh登陆欢迎文字,在package/base-files/files/etc/banner中 2 路由器的默认机器名字,在package/base-files/fi ...

  7. [译]ava 设计模式之享元

    (文章翻译自Java Design Pattern: Flyweight) 享元模式用于最小化内存开销.它做的就是使用其他相似的对象尽可能多的分享数据. 1.享元模式类图 2.享元模式Java代码 / ...

  8. JavaScript中对数组的操作

    原文:JavaScript中对数组的操作 一:数组的使用 1.定义:JavaScript中对数组的定义有两种形式.如: .var arr = [12,3,5,8]; .var arr = new Ar ...

  9. 曲演杂坛--一条DELETE引发的思考

    原文:曲演杂坛--一条DELETE引发的思考 场景介绍: 我们有一张表,专门用来生成自增ID供业务使用,表结构如下: CREATE TABLE TB001 ( ID ,) PRIMARY KEY, D ...

  10. 使用winform控件注意线程绘制界面冲突

    在用.NET Framework框架的WinForm构建GUI程序界面时,如果要在控件的事件响应函数中改变控件的状态,例如:某个按钮上的文本原先叫“打开”,单击之后按钮上的文本显示“关闭”,初学者往往 ...