阿里巴巴Java开发规约插件

Posted 2020-11-02 Shaw_喆宇

内容源自：阿里巴巴Java开发规约插件p3c详细教程及使用感受

 

至今为止已更迭了三个版本，2017年9月25日，《阿里巴巴Java开发手册（终极版）》正式发布,也是阿里官方对外发布的最后一个PDF版本。最新版下载地址在这里。

 

插件介绍

阿里巴巴基于手册内容，研发了一套自动化的IDE检测插件（IDEA、Eclipse）， 该插件在扫描代码后，将不符合《手册》的代码按Blocker/Critical/Major三个等级显示在下方，甚至在IDEA上，还基于Inspection机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。对于历史代码，部分规则实现了批量一键修复的功能，提升代码质量，提高团队研发效能。

代码已经开源，GitHub：https://github.com/alibaba/p3c

我们来体验一下吧！

 

插件使用简易教程(基于IDEA)

搜索插件

打开IDEA，选择Preferences - Plugins - Browse repositories后，在输入框中输入"alibaba"，可以看到返回结果中有"Alibaba Java Coding Guidelines"。

 

安装插件

点击插件详情中的"install"按钮，按照其提示即可完成安装，安装完成后需重启IDEA。

 

功能体验

安装后完成后，需要重启IDEA，重启后就可以在菜单栏中看到它的功能按钮，有三种方式可以扫描代码:

• 在项目目录上右键点击也会出现这两个功能按钮，点击绿色的按钮即可开始扫描代码,或者在工程目录上右键也会出现检测的功能按钮。

 

• 如果不想全部扫描，只扫描当前编辑的文件的话，在当前文件面板中点击右键也会出现此功能按钮。

 

• 前面说的两种方式是手动检测，插件也提供了实时监测的功能，此功能默认开启，一旦开启则会在你编写代码时就会实时监测，一旦有不符合规范的语句就会出现错误提示。

 

扫描代码后，不符合规约的代码会按Blocker/Critical/Major三个等级显示在下方面板中，如图:

 

左边是扫描出的不符合规范的代码，依次点进去可以看到是代码的多少行出现了规约问题以及哪一个规约问题，右边则是规约的详细描述及实例代码。

 

不仅如此，右侧还有quick fix的按钮，点击后直接可以改正代码，但是并不是所有的问题都有此按钮，有些问题还是需要手动修改。

支持版本

IDEA官方仓库：最低支持版本14.1.7，JDK1.7+
Eclipse版插件：支持4.2（Juno，JDK1.8+）及以上版本

检测更新

可以通过 Help >> Check for Udates 进行插件新版检测

插件卸载

在插件面板点击"uninstall"即可。