java规范之checkstyle

1. 概述

随着中心的代码规范的建立和实施，项目组对代码规范要求，以及软件工程师们对自身代码的编写规范重要性的认知，“代码规范”已经成为了中心的一个“热词”。然后怎么才能写出有规范的代码，怎么才能养成编码规范习惯？相信很多人都知道Checkstyle这个编码规范工具，本文讲述了Checkstyle在eclipse中的安装过程，以及使用方法。希望通过本文，让大家能简单快速的掌握Checkstyle。

2. 认识Checkstyle

CheckStyle是SourceForge下的一个项目，提供了一个帮助Java开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名，方法体的最大行数，重复代码检查等等。

如果你的项目经理开会时说：“我希望我们写出来的代码就象一个人写的!”，那么用Checkstyle绝对是正确选择！

3. 资源说明

Checkstyle：http://sourceforge.net/projects/eclipse-cs/

 

本篇是在eclipse4.4.2上面安装最新版的checkstyle插件为例。

Eclipse的位置在D:\java\eclipse，checkstyle下载后在D:\java\plugin\checkstyle\net.sf.eclipsecs-updatesite_5.7.0.201402131929-bin.zip，其中

使用的checkstyle规则文件在D:\java\plugin\checkstyle\style_template.xml

资源下载地址：

http://download.csdn.net/detail/ccboy2009/7521353

4. Checkstyle插件安装

下面讲解checkstyle在eclipse上的两种安装方式。

 离线安装

①　下载checkstyle离线安装包；

http://sourceforge.net/projects/eclipse-cs/

 

 

②　下载完成后将压缩包中features文件夹和plugins文件夹的复制到eclipse中的根目录中进行覆盖；

 

③　打开eclipse，Window-->Preferences,如果列表中出现了checkstyle的菜单，则表示安装成功了。

 

 

注意：如果启动eclipse时，提示ClassNotFoundException等异常信息，则启动时加上一个“-clean”参数启动即可。

 

Ø 在线安装

注意在安装过程中保持网络畅通，如果网络不稳定可能会导致安装失败。

Help --> Install New Software

CheckStyle插件地址：http://eclipse-cs.sourceforge.net/update

 

Next-->next-->选择 I accept... Finish。Checkstyle插件就开始安装。

在安装过程中，可能会出现警告提示，选择ok即可。

 

安装完成后，根据提示重启eclipse，checkstyle即安装完成。

5. Checkstyle全局配置

Window -->Preferences,选择checkstyle菜单，增加项目组统一的规则文件，并设置为默认规则。如下图：

 

 

到此全局配置已经完成。

6. Checkstyle项目配置

项目 --> 右键Properties

 

到此项目配置已经完成。成功的话，checkstyle已经开始工作了。

 

此次发现项目上有很多红叉叉，说明是代码符合规范造成的。

 

根据提示信息修改后，则没有有红色的提示。

 

 

7. 其它操作

在项目右键菜单中，checkstyle还有一些快捷操作，如下图所示：

 

8. 结语

通过本文的阅读和学习，相信你对Checkstyle这个编码规范工具有了一定的认识和熟悉。但要想规范自己的代码编写规则，项目组要统一组内代码规范，只依靠这个工具是不行的，需要大家坚持使用这个工具，逐渐的就会形成一种习惯，最终抛弃Checkstyle照样能写出规范的代码。