代码审查，从己做起——使用阿里巴巴Java编码规范插件

Code Review在项目开发中是一个老生常谈的问题，作为项目成员，你是否有过很多次想做Code Review却最终没有做的遗憾？因为业务复杂、项目进度紧张等原因耽搁了，想找组内成员帮忙review下，偏偏有时候大家都很忙，导致本该开发做的事情错过了，只能在以后想办法弥补，但现实情况却是很多时候可能只是想想。

实际上，无论其他同事是否能帮助自己做代码检查，我们首先要保证的是自己开发的代码在基本层面没有问题，这里面不谈业务逻辑问题，先看代码编写质量的问题。除了根据自己的开发经验发现代码存在的问题以外，有时候我们需要借助一些工具来帮助我们做代码检查，正所谓“工欲善其事，必先利其器”。在业界《阿里巴巴Java开发手册》应该是编程规范的标杆了，对应这本书阿里还开发一个插件，这个插件应该是这本书的践行版了。

8.目录

1.插件介绍

官方介绍如下：

为了让开发者更加方便、快速将规范推动并实行起来，阿里巴巴基于手册内容，研发了一套自动化的IDE检测插件（IDEA、Eclipse）。该插件在扫描代码后，将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方，甚至在IDEA上，我们还基于Inspection机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。对于历史代码，部分规则实现了批量一键修复的功能，如此爽心悦目的功能是不是很值得拥有？提升代码质量，提高团队研发效能，插件将会一路同行。

用了这个插件，可以帮助我们做最基本的代码审查，使Java开发更高效，提高代码开发质量并降低代码维护成本。即使我们有时间进行代码检查，安装了这个插件也可以让代码检查事半功倍。

2.插件安装

插件链接点击IDEA插件链接，Eclipse插件链接，本文主要介绍IDEA插件的安装。

1.在IDEA插件管理界面搜索“Alibaba Java Coding Guidelines”，点击Install进行安装。

1.插件安装

2.在菜单tool下，可以看到新安装的这个插件，可以开启或者关闭，还可以切换语言。

2.开关

3.插件使用

3.1 插件检测模式

a.实时检测
打开实时开关，实时检测功能就会对在开发的代码进行实时检测。如果有不规范的语句，
就会出现错误提示。

3.实时检测

使用场景：新项目开发
b.手动检测

• 按项目检测
  全局检测，点击项目右键，弹出菜单中找到“编码规范扫描”如图所示，

  
  4.手动检测

• 按文件检测
  在要检查的文件上点击右键，与按项目检测一样。
  使用场景：检查以前写过的项目和接手他人交接的项目

3.2 扫描结果

插件的检测结果分级为Blocker、Critical、Major。默认按等级分组，方便统计每个级别错误的数量。从下图感叹号能看出来，Blocker阻塞，其次为Critica关键的，这两个级别尽快处理掉。

5.扫描结果

4.常见问题

• 中文乱码问题
  在File->Settings ->Appearance&Behavior -> Appearance中，设置字体。

  
  6.中文乱码问题

• 约束选择
  如果公司或者项目组对手册里的规范有一些不同见解，可以对检测约束进行选择，File-> Settings ->Inspections，如图所示。

6.选择约束

5.总结

总的来说，使用这个插件的几点体会。

1. 插件能够检测出平时开发的一些细节问题，插件给出来了详细的提示和解释，甚至有的问题还可以quick fix，可以说优点非常多。
2. 用了插件之后能够让我们代码中少一些Bug吗？虽然真正编写代码的还是开发人员，但插件检测起到了对编码质量的提示作用，我相信有编码规范会让开发人员避免出现低级错误，使代码审查更高效。
3. 为什么要用这个插件？就是为了提高代码质量。以前总听说一个词—字如其人，意思是从一个人写的字中能看出这个人的个性和精神状态。对于软件开发人员来说，写代码如同写字，从一个人平时写的的代码中也许能看出一个开发人员的基本素养和性格特点。写出易读易用的代码，写出执行效率高的代码应该是每一个开发人员的追求。

参考文献：
1.https://github.com/alibaba/p3c
2.https://mp.weixin.qq.com/s/KcPtgFbnU6CS3L49EKcnDg