阿里Java代码规范 P3C插件

1 阿里开发手册

1.1 说明

2017年年初，首次公开的阿里官方Java代码规范标准手册可以说是引起了全民(IT界)代码规范的热潮，相信这个手册很多行业内的朋友都比较熟悉，毕竟有"大厂光环"，想低调都难，这个手册的主旨是:
“码出高效，码出质量。统一规范标准，提高行业编码规范化水平，帮助行业人员提高开发质量和效率、降低代码维护成本”

1.2 开发手册

《阿里巴巴 Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结，经历了多次大规模一线实战的检验及不断完善，系统化地整理成册，回馈给广大开发者。现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致后续维护艰难；没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以 Java 开发者为中心视角，划为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度，再根据内容特征，细分成若干二级子目录。根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中，“说明”对规约做适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。

本手册的旨在码出高效，码出质量。现代软件架构的复杂性需要协同开发完成，如何高效地协同呢？无规矩不成方圆，无规范难以协同，比如，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全，试想如果没有限速，没有红绿灯，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。代码的字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升系统稳定性，码出质量。考虑到可以零距离地与众多开发同学进行互动，决定未来在线维护《手册》内容，此 1.4.0 的 PDF 版本，是最为详尽的版本，新增设计规约大章节，并增加若干条目；我们已经在 2017 杭州云栖大会上发布了阿里巴巴 Java 开发规约插件，阿里云效也集成了代码规约扫描引擎。

手册最新版下载：http://click.aliyun.com/m/1000019584/
开发手册背后的故事：https://v.youku.com/v_show/id_XMzgzNzIwOTgxNg==.html?spm=a2h0k.11417342.soresults.dtitle
在这里插入图片描述

2 阿里P3C

2.1 说明

代码规范检查插件P3C，是根据《阿里巴巴Java开发手册》转化而成的自动化插件。

2.2 P3C是啥

P3C原是海上途海上巡逻机的型号。宽大机身可携带大量电子设备，翼下有十个武器外挂点，机腹下有八个内部炸弹舱，可携带AGM-65空地导弹、AGM-84反舰导弹、MK-46/50鱼雷和MU-90鱼雷以及深水炸弹、水雷等；被用来执行侦察、反潜、反水面、监视巡逻等海上任务。代码的世界里专治新手小毛病、老油条的各种不服。

2.3 插件介绍

《阿里巴巴Java开发手册》自从第一个版本起，倍受业界关注，相信很多人对其中的规则也有了一定的了解，很多人甚至希望能尽快在自己的团队推行起来，这样大家有了一套共同的开发准则。但是，如何更好的去遵守规则并且按照手册去开发我们的系统确变得不那么容易，为了让开发者更加方便、快速的将规范推动并实行起来，阿里巴巴基于手册内容，研发了一套自动化的IDE检测插件（IDEA、Eclipse），该插件在扫描代码后，将不符合《手册》的代码按Blocker/Critical/Major三个等级显示在下方，甚至在IDEA上，还基于Inspection机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。对于历史代码，部分规则实现了批量一键修复的功能，提升代码质量，提高团队研发效能。

3 IDEA和Eclipse安装插件

3.1 IDEA安装方法一（推荐）

打开IDEA，File-> Setteings->Plugins->Browse Repositories,在Browse Repositories搜索栏搜索Alibaba,然后安装
在这里插入图片描述
安装完后点击，Restart IntelliJ IDEA

3.2 IDEA使用安装好的插件

安装好了，使用方法是：打开IDEA，点击tools—>安装的阿里编码规约，可以选择中英文切换，项目右键选择编码规约扫描就可以进行查看自己编码哪些地方不够好，可以快速定位进行修改。
在这里插入图片描述

如果觉得阿里的提示太过严格了，我们也可以对检查约束进行选择哦，File->Settings->Editor->inspections,可以根据自己要求进行选择约束

3.3 创键类时自动生成注释

阿里手册上面有明确说明，每个类都需要注释作者，万一代码哪里出问题了或是不规范，一下子就能逮到编写的程序员。如果你的代码足够优秀，也很容易在团队里脱颖而出。
在这里插入图片描述
3.4 保存时自动格式化代码

3.5 IDEA安装插件方法二

插件下载：http://click.aliyun.com/m/1000019585/ 单独下载好插件后导入IDEA，重启IDEA就可以了。详细操作略

3.6 Eclipse安装插件

IDEA功能台强大了，本人已经很久没使用eclipse了。对于还没用过IDEA的小伙伴，建议你尝试一下，肯定会喜欢上IDEA的。下面的图均来自其他博客，可以参考下。导入代码样式格式化
源码下载：https://github.com/alibaba/p3c/tree/master/p3c-formatter
在这里插入图片描述