一、《Java开发手册》
《Java开发手册》始于阿里巴巴内部规约,在全球Java开发者共同努力下,已成为业界普遍遵循的开发规范。
《Java开发手册》以Java开发者为中心视角,划分为编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约七大维度,再根据内容特征,细分为若干二级子目录。另外,依据约束力强弱及故障敏感性,规约依次分为强制、推荐、参考三大类。在延伸信息中,“说明”对规约做了适当扩展和解释;“正例”提倡什么样的编码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案例。
修炼一年终出关,2019年06月19日,阿里巴巴发布《Java开发手册》华山版(v1.5.0)。
阿里巴巴《Java开发手册》官网最全版本下载链接:https://developer.aliyun.com/special/tech-java
二、Alibaba Java Coding Guidelines
为了让开发者更加方便、快速将规范推动并实行起来,阿里巴巴基于手册内容,研发了一套自动化的IDE检测插件(IDEA、Eclipse)。
该插件在扫描代码后,将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方,甚至在IDEA上,还基于Inspection机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。对于历史代码,部分规则实现了批量一键修复的功能。
阿里巴巴 AJCG(Alibaba Java Coding Guidelines)辅助插件下载链接:https://github.com/alibaba/p3c