IntelliJ IDEA 插件 —— P3C 详细教程

Rambo 2020年06月18日 372次浏览

一、场景引入

  《阿里巴巴Java开发手册》,2017 年年初,首次公开的阿里官方 Java 代码规范标准手册可以说是引起了 IT 界代码规范的热潮,相信这个手册很多行业内的朋友都比较熟悉,毕竟有 大厂光环,想低调都难。

这个手册的愿景是:

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

二、最新版本

点击此处获取最新版本的源码和 PDF 手册,截止本文档更新,最新版本为《阿里巴巴Java开发手册v1.5.0(华山版).pdf》

三、插件的安装

  1. 通过 FileSettingsPlugins,然后点击 Marketplace 标签页,输入 Alibaba Java Coding Guidelines 查询安装

    mark

  2. 安装完成后,重启一下 IDEA

四、插件的使用

  1. 在文件或者工程目录右击鼠标,即可点击绿色的按钮(编码规约扫描Ctrl + Alt + Shift + J)即可开始扫描代码

    mark

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

    mark

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

    mark

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

    mark

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

    mark