《阿里巴巴Java开发规约》插件安装及使用

简介

经过247天的持续研发，阿里巴巴于10月14日在杭州云栖大会上，正式发布众所期待的《阿里巴巴Java开发规约》扫描插件！

该插件由阿里巴巴P3C项目组研发。P3C是世界知名的反潜机，专门对付水下潜水艇，寓意是扫描出所有潜在的代码隐患。这个项目组是阿里巴巴开发爱好者自发组织形成的虚拟项目组，把《阿里巴巴Java开发规约》强制条目转化成自动化插件，并实现部分的自动编程。
该插件在扫描代码后，将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方，甚至在IDEA上，还基于Inspection机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。对于历史代码，部分规则实现了批量一键修复的功能，如此爽心悦目的功能是不是很值得拥有？提升代码质量，提高团队研发效能，插件将会一路同行。
下面再附上一张公众号文章的一张扫描结果图：

在昨天阿里技术公众号推送了该插件的信息，公众号二维码如下：

Eclipse安装及使用

Eclipse版插件支持4.2（Juno，JDK1.8+）及以上版本，可以通过 Help >> Install New Software 然后输入https://p3c.alibaba.com/plugin/eclipse/update 即可看到安装列表。可以通过 Help >> Check for Udates 进行插件新版检测。

选择需要安装的插件，按照提示直至完成安装。安装完成后，我们可以在工具栏看到插件的按钮。

工具栏左边的按钮可以进行规约扫描，右边的按钮可以切换语言版本，我们可以先选中要扫描的项目或文件，然后点击阿里规约扫描按钮，即可进行扫描。
如果不使用工具栏上面的按钮，我们也可以在项目或文件上面直接右击选择阿里规约扫描菜单也可以实现同样的效果。

如果我们正在编辑一个文件，只想扫描当前文件不想切换到项目列表，也可以直接在编辑区右击选择阿里规约扫描菜单，还是挺方便的。
扫描结束后，如何查看结果呢？也是很简单的，该插件也为我们提供了相关的窗口。

通过该窗口，我们可以方便的查看当前扫描的代码中不符合规约的说明，选中中一条扫描纪录，将窗口切换到Rule Detail界面，可以查看问题详情，以便于我们更好地理解问题。

扫描出来问题了，也知道原因了，接下来就需要解决问题了，双击指定的问题，可以直接定位到不符合规约的代码。我们可以按照提示对代码进行修改。

是不是很方便呢？不要着急，阿里巴巴Java开发规约插件还为我们提供了部分不符合规约代码的自动修复功能，选中不符合规约的记录，点击右上角的Quick Fix按钮就可以了。

修复后就变成这个样子了

如果扫描的结果我们不想处理，看着错误提示又很不爽，我们可以点击Quick FIx按钮左边的Clear Markers按钮清除相关错误标记。

IDEA安装及使用

目前，IDEA版的插件也已经发布至IDEA官方仓库中(最低支持版本14.1.7，JDK1.7+)。只需打开 Settings >> Plugins >> Browse repositories 输入 Alibaba 搜索，看到对应插件后即可安装。

在IDEA中，我们可以在Tools菜单中找到阿里编码规约菜单

同样的在项目上面右击也可以进行扫描，具体的用法这里就不再做说明了，大家可以参考Eclipse的摸索一下吧，使用还是挺简单的。