CheckStyle7.6 for eclipse安装配置

    每个研发团队都有自己的代码规范，规范开发人员代码、提高代码质量。建立代码审查机制是保证软件质量的重要方式之一，全部依赖人工检测不太现实，使用静态检查工具可以加快代码审查，从而有效降低成本，使之可行。有一些分析工具可以辅助我们做这件事。checkstyle是一个检查java代码规范的工具，并且具有很强的配置性，足以满足大部分场景。

    项目主页：http://checkstyle.sourceforge.net/

    规则详解参考官网文档：http://checkstyle.sourceforge.net/checks.html

一、在线安装

Eclipse>>Help>>Eclipse Marketplace，在search中输入checkstyle，找到Checkstyle Plug-in 7.6.0，点击install，安装完毕后重启eclipse。

二、本地安装

Checkstyle for eclipse plugin：net.sf.eclipsecs-updatesite_7.6.0.201703111252.zip

下载地址：https://sourceforge.net/projects/eclipse-cs/files/latest/download

Eclipse>>Help>>Install New Software...，点击Add...

点击Archive...，在文件浏览窗口选择下载到本地的压缩文件net.sf.eclipsecs-updatesite_7.6.0.201703111252.zip

安装完毕后重启eclipse。

三、插件配置

默认的Google Checks和Sun Checks检查配置较为严格，未必适合每个研发团队，可根据实际情况自定义代码检查规则。

Eclipse>>Preferences>>Checkstyle

方式一：引入外部配置文件

选择“Type”为“External Configuration File”（外部配置文件），在“Location”行点击【Browse】按钮，在文件浏览器窗口选择自定义的检查规则文件，点击【OK】

将自定义检查规则设置为默认，点击【OK】，即完成配置。

方式二：使用插件配置工具自定义检查规则

在“name"处填写规则名称，点击【OK】

在规则配置窗口，选择左侧检测项，点击【Add...】

例如，此处设置检查每个方法不能超过50行代码（不包括空白行）

依次在左侧规则树中选择设置所需检测规则后，点击【OK】

将刚才创建的自定义检查规则“My Checks”设置为默认，点击【OK】，即完成配置。

四、使用CheckStyle

选中某个项目，右键选择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 violations视图，可以看见所有未通过检查规则的信息。

Checkstyle violations chart视图，使用饼形图表展示未通过检查规则的数据统计，方便对所有代码质量进行整体分析。

Checkstyle使用简单易上手，基于代码静态分析效率也很高，有利于培养良好的编码习惯和风格。

设置适合自己团队的代码检查规则，权衡质量、效率、成本，是成功应用Checkstyle工具的重要环节。

 

转载于:https://my.oschina.net/u/2399373/blog/897194