俗话说：“工欲善其事必先利其器”，同理，我们在开发之前，最好有个规范或者约定，这样不论是对于我们当前的开发，还是后期的维护，都是很有益的事情。
　　记得大约是在2017年初左右的时候，阿里巴巴Java开发手册开始公布于世，刚开始网上只是有pdf文件，于是大家纷纷下载下来学习。因为是规范性的原则之类的内容，所以这个文件刚出来不久，组里老大也开始要求我们在项目中推广并遵守。随着这个代码规范在业界的推广和使用，手册也在逐渐的完善，阿里在9月底发布了该手册的终极版本，并于10月14日在杭州云栖大会上，正式发布了众所期待的《阿里巴巴Java开发规约》扫描插件！
　　现在Java开发基本上都是使用的IntelliJ IDEA工具，所以这里只重点介绍一下这个插件与IDEA的集成使用方法，Eclipse也类似。

插件安装

通过JetBrain官方仓库安装

1、 打开Settings >> Plugins >> Browse repositories...
如下图：

2、在搜索框中输入“alibaba”即可看到该代码规范插件，如下图：

     由于我已安装过该插件，所以右边有蓝色提示更新插件（“Update plugin”）。若之前没有安装过，则会有绿色提示安装插件（“Install plugin”）。点击安装即可。

3、重启IDEA以便生效。

注：由于该插件安装包托管在JetBrains官方CDN上，所以是从国外的服务器上进行下载的，可能会出现超时的情况，这是可能就要选择使用离线安装包进行安装了。

使用离线安装包安装

1、打开插件下载地址：https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines，下载最新安装包：

2、打开Settings >> Plugins >> Install plugin from disk...，然后选择你刚刚下载好的zip安装包，安装，然后重启你的IDEA使之生效。

插件使用

安装成功之后，打开Tools菜单应该可以看到该插件，可以进行相关的设置，包括代码规范扫描、实时检测、中/英文语言切换等

　　如果之前的手册内容看过的话，对这个插件就比较熟悉了，因为这个插件就是对手册内容的一个开发集成环境的实际体现。比如：

（1）、【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式

（2）、【强制】注释的双斜线与注释内容之间有且仅有一个空格

（3）、【强制】所有的覆写方法，必须加@Override注解。

（4）、【强制】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals等等...
　　点击那个绿色的图标可以对代码进行规范扫描，扫描结束后可以将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方，而且在IDEA上还基于Inspection机制提供了实时检测功能，这样我们在写代码的同时也能快速发现潜在的问题。对于历史代码，部分规则实现了批量一键修复的功能。
插件扫描结果示例：

• 
  

• 　　从上图中可以看到扫描结果共有29个blocker错误、30个Critical错误和323个Major错误。双击可以定位至代码处，右侧窗口还有代码的批量修改功能。可以说，该插件很贴心~

小结

  该插件由阿里巴巴P3C项目组研发，于2017年10月14日在杭州云栖大会上全球首发，发布当天，阿里巴巴大牛天团倾力助阵：毕玄、玄难、索尼、叶渡，淘宝代码第一人多隆、代码规约作者孤尽携手规约项目组成员，以及业界规约生态代表等重磅大咖。使用该插件，可以有效地降低代码的出错率，规范代码，具有重要的意义。

插件下载地址：https://github.com/alibaba/p3c/tree/master/idea-plugin