IDEA 使用阿里巴巴 Java 开发规约插件教程

“统一规范标准将有助于提高行业编码规范化水平，帮助行业人员提高开发质量和效率、大大降低代码维护成本”

                                                                                       ——《阿里巴巴Java开发手册》

插件介绍

        《阿里巴巴Java开发手册》自从第一个版本起，倍受业界关注，相信很多人对其中的规则也有了一定的了解，很多人甚至希望能尽快在自己的团队推行起来，这样大家有了一套共同的开发准则。

        但是，如何更好的去遵守规则并且按照手册去开发我们的系统确变得不那么容易，为了让开发者更加方便、快速的将规范推动并实行起来，阿里巴巴基于手册内容，研发了一套自动化的 IDE 检测插件（IDEA、Eclipse）。

        该插件在扫描代码后，将不符合《手册》的代码按 Blocker/Critical/Major 三个等级显示在下方，甚至在 IDEA 上，还基于 Inspection 机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。

        对于历史代码，部分规则实现了批量一键修复的功能，提升代码质量，提高团队研发效能。

        插件是开源的，GitHub：https://github.com/alibaba/p3c

插件下载安装

        这里只介绍 IDEA 使用这个插件的方法。有两种方式，一种方式是在 IDEA 里面搜索安装这个插件；另一种方法是去 GitHub 下载插件的压缩包，手动安装。

搜索插件

在 IDEA 中，打开 Settings，点击 Plugins，搜索 alibaba，点击 install 安装即可。

下载插件

如果这个插件在 IDEA 中下载不下来，可以自己去 GitHub 上下载 zip 包，手动导入 IDEA。下载地址为：https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions ，可以自行选择版本。

导入插件

将下载的 p3c 插件压缩包放在本地，不需要解压。在 IDEA 中打开 Setting，点击 Plugins，然后选择 Install Plugin from Disk 导入插件压缩包即可。

导入完之后，选择 Restart IDE，重启完就可以使用插件了。

使用插件

在 IDEA 中右键，可以选择 代码规约扫描，或者 开启/关闭实时检测功能。

点击代码规约扫描之后，插件会检测代码的问题，然后在下面给出对应提示，可以查看详细问题，双击可以定位到问题的具体位置，插件使用起来很简单。

另外，在 Tools 中还可以切换插件的语言。