一、   checkstyle介绍:

CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查,从而规范化代码。

Checkstyle提供了许多可以应用于源代码的检查。下面是按字母顺序排列的参考,网站导航菜单提供按功能组织的参考。

三、 checkstyle应用

按照代码的生命周期,因而可以从以下两个方面进行代码规范化限制:

(一)、代码编写过程中

代码编写过程中,开发人员就可以按照一定规范进行编写,从而避免不规范代码产生。但为了更尺度化可以采用checkstyle的插件实现,即在开发工具

eclipse中安装checkstyle插件,在编写代码过程中将代码规范化:

eclipse安装checkstyle插件有以下两种方式,任选其一即可:

方法一:离线安装

1.下载checkstyle安装包

2.下载完成后将压缩包中features文件夹和plugins文件夹的复制到eclipse中的根目录中进行合并;

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

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

方法二:在线安装

1.Help --> Install New Software

输入以下网址回车

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

在安装过程中,可能会出现警告提示,选择ok即可。安装完成后,根据提示重启eclipse,checkstyle即安装完成。

2.Checkstyle项目配置:项目 --> 右键Properties

IDEA配置checkstyle插件

IDEA对checkstyle的支持比eclipse好。

注意:记得将IDEA的自动将import超过5来自于同一个包下就合并成 * 的改成多一点,不然你会烦的要死。

步骤一:下载checkstyle插件。在最上方的菜单栏中找到File中的settings,plugins即是下载插件的地方,我们再点击下方的Browse repositories,在其中查找checkstyle,并点击install就可以等待下载成功了

步骤二:接着在settings>>Other settings>>checkstyles的Configration file最右边有一个加号,点击它来添加配置文件,项目应该默认sun配置文件,如果想添加自己的规则则需要自己创建。

最后,在IDEA最底端工具栏就能使用checkstyle了。

到此项目配置已经完成。成功的话,checkstyle已经开始工作了,代码中会有很多红叉叉,说明是代码符合规范造成的,修改代码规范即可。

(二)代码提交到远程仓库过程中

提交过程中,由于项目版本管理使用的git,因此可以借用git的hook进行配合检查,具体原理可以查看相关资料,下面介绍自己项目中如何使用:

2.将pre-commit文件复制到项目.git目录下hooks文件夹下即可

3.提交代码会检查不符合规则代码

以上就是代码规范检查checkstyle的介绍。

如果想自己定义代码检查规约,可以在本地磁盘的任何一个地方新建checkstyle.xml文件。

Checkstyle配置模块需要在checker根模块下。大部分模块是TreeWalker子模块。TreeWalker通过将每个Java源文件分别转换为抽象语法树,然后将结果交给每个子模块进行操作检查。例如典型的配置如下: