IDEA中添加Google CheckStyle 完美指南

所谓“一千个读者就有一千个哈姆雷特”，不同的程序员，有着截然不同的代码风格。譬如抛出使用空格键还是TAB键的问题，就足以让程序员演化成风格迥异的不同色系。但在真正的产品开发中，如何写出高质量、易维护、强可读的代码尤为重要，这就需要一个普遍认可的编码规范，今天就和大家一块学习如何在IDEA中添加Google CheckStyle来保证项目代码的和谐一致。

一.在IntelliJ IDEA中安装插件

1.选择”File”菜单组下的”Settings”菜单项:

2.选择”Plugins”菜单项,并点击中下方的”Browse repositories…”按钮:

3.搜索并安装所需要的插件:

4. 若有需要,可以配置代理以加快下载速度或解决下载失败的问题.

二.在IntelliJ IDEA中配置Google Java Code Style及代码格式化快捷键
1.从 https://raw.githubusercontent.com/google/styleguide/gh-pages/intellij-java-google-style.xml 下载Google Java Code Style在IntelliJ中的配置文件
2.选择”File”菜单组下的”Settings”菜单项:
3.选择”Editor->Code Style”菜单项,并点击图示的”Intellij IDEA code style XML”导入第1步中下载的配置文件(可修改导入的配置名,此处使用默认的”GoogleStyle”):

4.将当前项目的”Schema:”设置为第3步中导入的”GoogleStyle”

5.此时,在源代码中可以使用快捷键将代码依照Google Java Style Guide进行格式化:

1. Ctrl + Alt + L 格式化代码
2. Ctrl + Alt + I 自动缩进
3. Ctrl + Alt + O 整理import

三.在IntelliJ IDEA中安装和使用”CheckStyle-IDEA”插件
1.按”说明一”中的步骤,安装”CheckStyle-IDEA”插件:

* 最新版本已经默认集成了Google Checks,旧版本需要手动导入规则文件*
2.安装成功后,IntelliJ IDEA的下方Tab页中会出现”CheckStyle”的Tab:

3.选择”Google Checks”作为”Rules”,并根据需要点击左侧的四个按钮对代码进行检查,其作用分别为:
1. 检查当前文件
2. 检查当前模块
3. 检查整个项目
4. 检查未提交的代码

注1: CheckStyle检查的是代码的格式、是否缺少文档,而非其中的缺陷.
注2: Google Java Style Guide中(目前)没有对MagicNumber作要求.但若有要求, MagicNumber的检查也应该由CheckStyle完成,因为MagicNumber不属于缺陷,而类似于缺少文档
注3: CheckStyle检查可能会作为代码复审的一个步骤.若检查不通过,代码就可能被退回修改.

四.在IntelliJ IDEA中安装和使用”FindBugs-IDEA”插件

• 按”说明一”中的步骤,安装” FindBugs -IDEA”插件
• 安装成功后,IntelliJ IDEA的下方Tab页中会出现”FindBugs-IDEA”的Tab：
• 与”CheckStyle”插件类似,通过左侧的按钮对代码作检查

• 还可以通过”Settings”对需要检查的Bug进行勾选、排除或新建自定义的检查规则:

• FindBugs通过Bug Pattern检查”.class”文件来寻找问题
  附: FindBugs提供的Bug大类:

• Bad practice 不好的习惯

• Correctness 代码的正确性
• Dodgy 小问题
• Malicious code vulnerability 恶意代码
• Internationalization 国际化问题
• Performance 性能问题
• Security 安全性问题
• Multithreaded currectness 线程问题
• Experrimental 实验性问题

五.在IntelliJ IDEA中进行单元测试时使用”Coverage”插件进行覆盖率的记录
1. 使用”Coverage”按钮运行单元测试:

2. 会展示覆盖率的报表,在被测代码中,未被覆盖的代码前方会用红色柱状体标注:

3. 运行多个不同的单元测试时,可以选择将覆盖率报表合并: