eclipse插件checkstyle的使用教程

Checkstyle是一个代码开发工具，可以帮助程序员检查自己的代码是否满足某种规范，这样可以大大减轻程序员对代码规范的检查的压力。同时具有高度的自由配置性，几乎可以支持任何编码标准。甚至你可以自己写出属于自己的代码规范的配置文件。

Checkstyle十分强大，可以检查包括：各种命名规范，注释格式，import语句的字典顺序，类的设计，方法设计，代码布局等。

下面说明如何在eclipse中使用checkstyle：
首先在eclipse的marketplace中搜索下载checkstyle：

安装第二个的插件，然后重启eclipse即可使用。可以看见其拥有极高的使用量。

然后在eclipse的window->preference中打开checkstyle：

选择google规范然后apply，右下角框可以选择需要checkstyle的具体项目。

然后在需要checkstyle的地方右键开始check：

这样就会在每行代码前提示style错误，并且有信息提示：

但是错误太多了，我们怎么能改得过来呢？
这时就需要用到eclipse强大的功能了。

我们需要先下载配置文件：
这里给出google代码规范配置文件：https://github.com/codeset/google-java-styleguide
下载eclipse的google规范即可：

然后进入window->preference->Java->Code Style->Formatter:

选择刚刚下载好的配置文件，但需要注意，在google规范中缩进是两个空格，因此最好进入Edit里面查看一下是否是2个空格，我就被坑过（诶）。然后点apply即可。

然而你会发现没有任何变化，因为还差最后一步，对代码进行格式化。在对应文件上右键找到Formatter点击：

这样就会自动将代码缩进进行调整了。
然而有的朋友可能会报很多style错误，比如缩进问题，因为google规范里要求的是两个空格缩进，而Formatter之后的缩进可能换成两个空格长的tab键，如果手动更改十分麻烦。
但是eclipse自带的功能能将所有tab键转换为两个空格：
进入window->preference->General->Editors->Text Editors，选择Insert spaces for tabs：

然后再进行Formatter即可。此时已经将缩进和注释方面的格式问题进行了修正。剩下的style错误也不多了，只需进行手动调整即可。

笔者踩过的坑：有时候eclipse会产生bug，正常来说当你保存文件后，checkstyle会自动进行第二轮检查，然而有时会依旧显示前面的提示，这时只能手动右键文件选择checkstyle了。

最后附上google规范：https://google.github.io/styleguide/javaguide.html