checkstyle安装和使用

Eclipse 中CheckStyle安装和使用指南
1      概述
1.1      在软件开发的过程中，以下几种情形随处可见
1.1.1      软件维护时间长，而且维护人员的积极性不高
做过软件维护的开发人员，尤其是在接手不是自己开发产品的源码的时候，即使有良好的文档说明，仍然会对代码中冗长、没有注释的段落"叹为观止"。理解尚且如此困难，何况要修改或者增加新的功能。因此，很多开发人员不愿意进行软件维护的工作。
1.1.2      新的开发人员融入团队的时间比较长
除了没有良好的培训、文档等有效的机制以外，每个人一套的编码风格，也容易造成新成员对于已有代码的理解不够，甚至出现偏差。

编码规范，作为解决以上问题的方案已经得到了很长时间的应用。而在产品或者项目实际开发的过程中，仅有Code Conventions是不能解决Code的问题的。它往往和Code Review配合，作为代码质量保证的手段。
1.2      Code Review的层次与内容
1.2.1Code Review的层次与内容
Code Review就是审查代码的质量。根据形式分为两种，一种是交叉代码审查，就是自己的代码由他人来检查，就象检查作业一样；另一种是代码会审，就是以会议的形式，大家共同审核代码的质量。
1.1.3      Code Review 的目的
      在项目早期就能够发现代码中的BUG
      帮助初级开发人员学习高级开发人员的经验，达到知识共享
      避免开发人员犯一些很常见，很普通的错误； 保证项目组人员的良好沟通；项目或产品的代码更容易维护
1.1.4      一般情况下，Code Review的内容与层次如下
      编码风格与代码规范一致性：检查代码是否符合编码规范，确保所有人写的代码基本一致
      代码满足基本的功能要求：检查代码的逻辑实现，以及单元测试的编写策略，确认实现功能性需求
      代码满足性能等非功能性需求：非功能性需求一般不便于测试，需要借助一定的工具和Review人员的素质，针对编码中对于性能影响的瓶颈给出解决方案
      去除冗余，提高代码可读性：适当使用 Refactorying技术，去除代码中的Bad Smell；如果有需要，可以Refactorying to Pattern
2      CheckStyle安装

在Eclipse当中安装CheckStyle插件非常方便,我们可以参照以下五个步骤进行:

2.1在Eclipse当中分别打开一下菜单 Help->Software Updates->Find and Install

2.2选择 Search for new features to install 选项然后点击 Next

2.3新建一个 New Remote Site...

2.4输入名称(比如:Checkstyle Plug-in) 和下面的的 URL: http://eclipse-cs.sourceforge.net/update

2.5开始安装

3CheckStyle使用方法

3.1查看

安装好CheckStyle以后,不符合CheckStyle编码规范的信息将会出现在”问题(problem)”视图当中:

 

可以点击问题视图的”过滤器:;配置显示内容:

CheckStyle的检查规则包含在XML格式的配置文件里。CheckStyle默认的sun规范检查文件是：sun_checks.xml

3.2配置

CheckStyle: Windows ==> perference ==> checkstyle 配置的导入/导出就在配置界面右侧

 

我们也可以导出以后,经过修改量身定做自己的规范,比如我们已经按照规范做好了一个代码规范文件,并且取名为中企动力,那么我们可以把这个规范导入,在location中加入自定义的xml文件

Type选择External Configuration File,名称填上:中企动力,然后填上相应的描述,然后点击browse按钮找到相应的配置文档,点击ok就可以了.
这样checkstyle当中又多了一个叫做中企动力的规范

 

标准配置的导入/导出功能可以大大降低开发人员针对以上工具的学习时间，对于大部分开发者来说不需要详细了解其中所有的选项配置，只要知道将标准配置导入就可以了。

3.3使用

    CheckStyle是一个非常复杂的代码风格检查过程：包括缩进，命名规范等，因此缺省是Disable的，启动针对一个项目的CheckStyle需要在点：项目的properties==>CheckStyle==>Checkstyle active for this project勾上

 
同时我们可以对该项目的checkstyle制定代码规范,可以点击右边的add按钮,弹出编辑窗口,然后下拉(Check Configuration)条选定指定相应的规范,这里用那个我们刚才已经配置写的那个叫做”中企动力”的规范

 

这样,我们就能使用CheckStyle对文档进行规范了,下面这个例子是使用CheckStyle以后,在eclipse中对不符合规范的代码进行标注,这样我们就可以按照”中企动力”规范对代码进行约束了.
下图当中左边的放大镜图标表示此行代码不符合规范,当鼠标悬停在上面的时候,会显示这行代码的问题所在.

 当然，在使用jalopy之后，可以使你根据CheckStyle修改的problem少一些。当然，eclipse中的formate也有同样的功能，但是在符合sun CheckStyle的要求上，jalopy相对好一些

 

4结论

我们可以利用CheckStyle可以方便的对于编码的Code Conventions进行检查，同时，也有效地减少了Code Review的工作，使得开发人员的精力更多的集中到逻辑和性能检查。同时, 修改、定型CheckStyle的配置文件：按照基本配置文件执行一段时间（2～3周），听取开发人员的反馈意见，修改配置信息.