文档介绍：前言
《阿里巴巴 Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总
结,经历了多次大规模一线实战的检验及不断的完善,系统化地整理成册,反馈给广
大开发者。现代软件行业的高速发展对开发者的综合素质要求越来越高,因为不仅是
编程知识点,其它维度的知识点也会影响到软件的最终交付质量。比如:数据库的表
结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险;工程结构混乱导致后续
维护艰难;没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以 Java 开发者为中心
视角,划分为编程规约、异常日志、单元测试、安全规约、工程结构、MySQL 数据库六
个维度,再根据内容特征,细分成若干二级子目录。根据约束力强弱及故障敏感性,
规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中,“说明”对内
容做了适当扩展和解释;“正例”提倡什么样的编码和实现方式;“反例”说明需要
提防的雷区,以及真实的错误案例。
本手册的愿景是码出高效,码出质量。现代软件架构都需要协同开发完成,高效
协作即降低协同成本,提升沟通效率,所谓无规矩不成方圆,无规范不能协作。众所
周知,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全。试想如
果没有限速,没有红绿灯,谁还敢上路行驶。对软件来说,适当的规范和标准绝不是
消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式
一起做事,提升协作效率。代码的字里行间流淌的是软件生命中的血液,质量的提升
是尽可能少踩坑,杜绝踩重复的坑,切实提升质量意识。
考虑到可以零距离地与众多开发同学进行互动,决定在线维护《手册》内容,此
版本号为 的 PDF 版本,是对外释放的终极版;其次,我们会在 2017 年 10 月 14
日杭州云栖大会上,进行阿里巴巴 Java 开发规约插件全球首发,插件点此下载,阿里
巴巴云效(一站式企业协同研发云)也会集成代码规约扫描引擎。最后,《码出高效
——阿里巴巴 Java 开发手册详解》即将出版,敬请关注。
目录
前言
一、编程规约......................................................................... 1
(一) 命名风格................................................................... 1
(二) 常量定义................................................................... 3
(三) 代码格式................................................................... 4
(四) OOP 规约................................................................... 6
(五) 集合处理................................................................... 9
(六) 并发处理.................................................................. 12
(七) 控制语句.................................................................. 14
(八) 注释规约.................................................................. 16
(九) 其它...................................................................... 17
二、异常日志........................................................................ 18
(一) 异常处理.................................................................. 18
(二) 日志规约.................................................................. 19
三、单元测试....................................