软件准备
IDE:Eclipse
Checkstyle插件:
net.sf.eclipsecs-updatesite_5.6.0.201209221626-bin.zip
注意:checkstyle不同版本的自定义规则写法不同,我们使用统一版本,方便统一修改和升级。
其他:CreatePluginsConfig工程(协助安装插件的)
youku_Checkstyle_Checks.xml(自定义checkstyle检查规则配置文件)
安装步骤
在eclipse安装文件夹内创建myplugins文件夹(路径、文件夹名称可以随便定义,这里建议),如下图:
![创建myplugins文件夹 创建myplugins文件夹](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124134839.jpg)
创建myplugins文件夹
在myplugins文件夹下创建checkstyle文件夹,并将net.sf.eclipsecs-updatesite_5.6.0.201209221626-bin.zip解压到该文件夹内
![解压checkstyle包 解压checkstyle包](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124135304.jpg)
解压checkstyle包
导入CreatePluginsConfig工程,打开类CreatePluginsConfig.java
修改下图所示路径,
![修改checkstyle插件路径 修改checkstyle插件路径](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124135743.jpg)
修改checkstyle插件路径
运行该main方法,控制台会输出一段字符
![输出一段字符 输出一段字符](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124140228.jpg)
输出一段字符
将该段字符添加到bundles.info文件末尾
![添加到bundles.info 添加到bundles.info](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124140405.jpg)
添加到bundles.info
重启eclipse,查看window->preferences下是否出现checkstyle,下图为安装正确
![验证安装成功 验证安装成功](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124140548.jpg)
验证安装成功
checkstyle的配置
在上图打开的checkstyle界面中,点击new按钮,按照图中所示配置,完成后点击OK。在上图的界面中将刚配置的自定义规则选择为默认。
![checkstyle配置 验证安装成功](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124141043.jpg)
验证安装成功
选择某一工程,右键选择properties,按照下图,选择适当项。
![开启checkstyle的检查 开启checkstyle的检查](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124141239.jpg)
开启checkstyle的检查
验证配置是否正确
打开java文件,如下图所示,黄色部分就是checkstyle检查出来的问题
![验证checkstyle是否开启 验证checkstyle是否开启](https://www.tianhailong.com/wp-content/uploads/2013/01/QQ截图20130124141448.jpg)
验证checkstyle是否开启