编码规范（二）之CheckStyle配置

CheckStyle检验的主要内容包括：Javadoc注释、命名约定、标题、Import语句、体积大小、空白、修饰符、块、代码问题、类设计、混合检查。

要使用CheckStyle，首先必须安装Eclipse插件，可以从sourceforge网站下载插件，网址如下：

http://sourceforge.net/projects/eclipse-cs/files/Eclipse%20Checkstyle%20Plug-in/

安装checkstyle插件的方法主要有如下三种：

1、在Eclipse下使用link方式链接插件

在某个目录（eg. D:\Program Files (x86)\externalplugins）创建checkstyle\eclipse子目录，将之前下载的插件下的features和plugins两个文件下拷贝到该目录下（eg: D:\Program Files (x86)\externalplugins\checkstyle\eclipse）。

接着在eclipse的links目录下新建checkstyle.link文件，在该文件中添加一行写上需要链接的插件地址，例如：path=D:/Program Files (x86)/externalplugins/checkstyle。

【说明】此种方式便于管理外部Eclipse插件。

2、下载checkstyle插件文件夹后拷贝到Eclipse的和features和plugins目录

此种方式将下载的checkstyle插件的features目录下的内容拷贝到Eclipse下的features目录，将将下载的checkstyle插件的plugins目录下的内容拷贝到Eclipse下的plugins目录。

3、使用“Software Updates”->“Find and install”指定网址安装插件。

点击Eclipse或MyEclipse的“Help”->“Software Updates”->“Find and Install”，在弹出的窗口中选择“Search for new features to install”单选框，接着在“Update sites to visit”窗口点击“New Remote Site”按钮，在该窗口输入插件名称和插件下载地址后点击“OK”按钮完成下载。

 

Checkstyle插件安装成功后，在Eclipse中打开Windows-->Preferences能发现左侧栏里有一个Checkstyle的选项。

 

CheckStyle配置具体步骤如下：

1、在Eclipse中打开Windows-->Preferences-->Checkstyle，如下图所示：

 

通过界面我们可以发现，Checkstyle插件中默认内置有2个执行代码检查的配置文件：Sun Checks、Sun Checks(Eclipse)。这两个配置文件中分别定义了Checkstyle需要检查的选项配置。一般项目组都会根据项目需求自定义一个配置文件，然后通过import的方式导入到Eclipse中。今天，我们主要介绍这一种方式。

2.点击New，在弹出的界面中Type下拉框选择External Configuration File，然后引入我们自定义的配置检查xml文件，Name可以自定义，这里我们引入自定义的模板文件名为huaxia_checks_v1.1.xml如下图所示：

 

点击OK保存，然后我们在前一个界面中就能看到我们刚刚导入的配置了。就是下图中的

huaxia_checks_v1.1.xml

 

我们可以鼠标选中该行，然后点击右边的Set as Default按钮，这样Checkstyle就已经配置好了。

3、也可以通过右键点击Porject中，PropertiesàCheckstyle，在Configure选项中配置相应的模板文件，并勾选Checkstyle active for this project如下图：

 

或者也可以通过  选择某个项目，点击右键选择“Checkstyle”，会出现如下菜单：

   1） Configure project(s) from blueprint：指定工程加入Checkstyle检查；

   2） Activate Checkstyle：激活Checkstyle；

   3） Deactivate Checkstyle：取消激活Checkstyle；

   4） Check code with Checkstyle：使用Checkstyle检查代码；

   5） Clear Checkstyle violations：去掉Checkstyle的检查提示。

  选择“Check code with Checkstyle”对所选中的项目进行检查，检查后对有问题的类会使用警告或错误标识。参考提示信息如下：

 

左侧会显示小圆圈，将鼠标移动到上面时将给出提示信息。

         使用checkstyle后，注释、变量命名规范性、类中变量、构造函数、方法的顺序的检查、行的长度、文件的长度、方法的长度等都不需要手工进行检查，只需要在代码评审时使用Checkstyle检查即可。因此，让代码评审人员将侧重点放在checkstyle检查不出来的一些代码的优化问题。

 

对于Checkstyle检查选项的详细配置，我们可以在Eclipse中进行配置修改，如下图，选中huaxia_checks_v1.1.xml

 

双击选中的行或者点击右边的Configure按钮，弹出下面的界面

 

上图中，左边的菜单项代表我们可以进行配置的选项，每一个菜单项都可以展开为多个子菜单项。我们可以分别进行配置。其中菜单项上标了绿色对勾的表示该项以及所有子项已经添加到了检查项中。如果子项没有全部添加，则父菜单项不会显示绿色对勾。

 

 

如果我们需要添加某个配置项，可以点击选中某个菜单项，然后点击下方的Add按钮，选择OK后该项的子菜单项会显示在右边区域，我们可以通过勾选菜单项前的复选框对具体的项进行配置。如下图所示

 

具体项目的含义，从名称基本能看懂。

 

各种参数配置参见官方文档：

http://checkstyle.sourceforge.net/availablechecks.html

 

配置文件