eclipse中checkstyle的安装使用

checkstyle是代码格式检查工具，根据已经设置好的编码规则（一个xml文件）来自动检查代码，比如:方法的行数、方法和变量的命名等。目的是规范代码，通俗点讲就是让代码看起来像一个人写的。

下面讲下如何使用这个工具。

一、工具安装

方式一：window --> preferences，没有安装checkstyle的时候这个弹出如下：

打开eclipse, help->Install New Software...    然后填入：CheckStyle - http://eclipse-cs.sourceforge.NET/update

选中上图的两个文件,依次点击 Next -->Next,选中I accept .....，Finish

 

 点击Install anyway 

 点击重启，生效。 

再次打开 Preferences这个弹窗

以上是在eclipse 4.9.0 + jdk1.8.0_181的下安装工具的过程，但是，不是所有环境都能按照以上按照方法解决的。比如，在eclipse4.2.0 + jdk1.7.0_45的环境下，按照以上方式去安装，Preferences弹窗没有checkstyle显示。

原因是自动安装的checkstyle工具对jdk的版本有要求，参考【Eclipse Checkstyle Plugin】

可以尝试下下面的方法

方式二：下载链接：【Ckeckstyle.rar】，提取码：dt87 

打开eclipse安装路径，然后新建一个文件夹checkstyle(文件夹名字可以随意取)，然后将下载文件中的features和plugins文件夹拷贝过来，如下图所示

 

 

然后在eclipse安装目录的文件下  新建一个txt文件，比如checkstyle.txt（这个文件名字也是可以随意取），.txt修改为.link，加入path=D:\\(wjhl)eclipse-juno-with-toolset\\checkstyle，这个路径是新建checkstyle的路径，注意是两个\

然后重新打开eclipse的Preferences弹窗，如下所示

如果这两种方式都没有效果，可以在网上找下其他的安装方式。 

二、导入checkstyle的规范

规范文件是一个xml文件，没有的话，可以使用以下文件或者在网上找一个，然后根据自己公司的规范略加修改，比如：我建了一个company-checkstyle.xml文件，内容如下

 将规范文件放到某个路径下，比如放到eclipse的工作空间下

 打开eclipse,新建一个规范的配置，如下所示

 配置checkstyle，点OK后弹出窗确定即可

启动配置 

右键项目 --> properties --> Checkstyle

 也可以右键项目 -->然后找到Checkstyle的标签，选中后出现二级菜单

 举个例子：

加上注解后 

 【Eclipse部分设置参考链接】

 

 

如果有写的不对的地方，请大家多多批评指正，非常感谢！