阿里巴巴的《Java开发规范》是团体协作的经验只谈,是降低多人协作编码的法宝。尤其是经历过百人以上开发团队的,会对一些规则有深刻的体会。
前言
《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,经历了多次大规模一线实战的检验及不断完善,公开到业界后,众多社区开发者踊跃参与,共同打磨完善,系统化地整理成册,当前的版本是嵩山版。现代软件行业的高速发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点也会影响到软件的最终交付质量。比如:五花八门的错误码人为地增加排查问题的难度;数据库的表结构和索引设计缺陷带来的系统架构缺陷或性能风险;工程结构混乱导致后续项目维护艰难;没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以 Java 开发者为中心视角,划分为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度,再根据内容特征,细分成若干二级子目录。另外,依据约束力强弱及故障敏感性,规约依次分为【强制】、【推荐】、【参考】三大类。在延伸信息中,“说明”对规约做了适当扩展和解释;
“正例”提倡什么样的编码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案例。
手册的愿景是码出高效,码出质量。现代软件架构的复杂性需要协同开发完成,如何高效地协
同呢?无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,没有红绿灯,谁还敢上路行驶?对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,提升协作效率,降低沟通成本。代码的字里行间流淌的是软件系统的血液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升系统稳定性,码出质量。
我们已经在 2017 杭州云栖大会上发布了配套的 Java 开发规约 IDE 插件,下载量达到 162 万人次,阿里云效也集成了代码规约扫描引擎。次年,发布 36 万字的配套详解图书《码出高效》,本书秉持“图胜于表,表胜于言”的理念,深入浅出地将计算机基础、面向对象思想、JVM 探源、数据结构与集合、并发与多线程、单元测试等知识客观、立体地呈现出来。紧扣学以致用、学以精进的目标,结合阿里巴巴实践经验和故障案例,与底层源码解析融会贯通,娓娓道来。《码出高效》和《Java 开发手册》稿费所得收入均捐赠公益事情,希望用技术情怀帮助更多的人。
版本历史
版本号 | 版本名 | 发布日期 | 备注 |
---|---|---|---|
— | — | 2016.12.07 | 试读版本首次对外发布 |
1.0.0 | 正式版 | 2017.02.09 | 阿里巴巴集团正式对外发布 |
1.0.1 | — | 2017.02.13 | 1) 修正 String[]的前后矛盾。 2) vm 修正成 velocity。 3) 修正 countdown 描述错误。 |
1.0.2 | — | 2017.02.20 | 1) 去除文底水印。 2) 数据类型中引用太阳系年龄问题。 3) 修正关于异常和方法签名的部分描述。 4) 修正 final 描述。 5) 去除 Comparator 部分描述。 |
1.1.0 | — | 2017.02.27 | 1) 增加前言。 2) 增加<? extends T>描述和说明。 3) 增加版本历史。 4) 增加专有名词解释。 |
1.1.1 | — | 2017.03.31 | 修正页码总数和部分示例。 |
1.2.0 | 完美版 | 2017.05.20 | 1) 根据云栖社区的“聚能聊”活动反馈,对手册的页码、排版、描述进行修正。 2) 增加 final 的适用场景描述。 3) 增加关于锁的粒度的说明。 4) 增加“指定集合大小”的详细说明以及正反例。 5) 增加卫语句的示例代码。 6) 明确数据库表示删除概念的字段名为 is_deleted |
1.3.0 | 终极版 | 2017.09.25 | 增加单元测试规约,阿里开源的 IDE 代码规约检测插件:点此下载 |
1.3.1 | 纪念版 | 2017.11.30 | 修正部分描述;采用和 P3C 开源 IDE 检测插件相同的 Apache2.0 协议。 |
1.4.0 | 详尽版 | 2018.05.20 | 增加设计规约大类,共 16 条。 |