Skip to content

Java 开发规范 ​

本文档整理自阿里巴巴《Java 开发手册》1.7.0(嵩山版,2020.08.03),版权归原作者所有,仅供学习与团队规范参考。

简介 ​

《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,历经多次大规模一线实战检验及不断完善,系统化地整理成册,当前版本为嵩山版。

手册以 Java 开发者为视角,划分为 编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约 七个维度,再根据内容特征细分为若干二级子目录。

规约级别 ​

依据约束力强弱及故障敏感性,规约依次分为三大类:

级别含义
【强制】必须遵守,违反可能导致严重故障或安全问题
【推荐】建议遵守,有助于提升代码质量与可维护性
【参考】供参考的实践经验,可根据实际情况采用

在延伸信息中:

  • 说明:对规约做适当扩展和解释;
  • 正例:提倡的编码和实现方式;
  • 反例:需要提防的雷区,以及真实的错误案例。

目录 ​

一、编程规约 ​

序号章节文件
1命名风格01.命名风格
2常量定义02.常量定义
3代码格式03.代码格式
4OOP 规约04.OOP规约
5日期时间05.日期时间
6集合处理06.集合处理
7并发处理07.并发处理
8控制语句08.控制语句
9注释规约09.注释规约
10前后端规约10.前后端规约
11其他11.其他

二、异常日志 ​

序号章节文件
1错误码01.错误码
2异常处理02.异常处理
3日志规约03.日志规约

三、单元测试 ​

四、安全规约 ​

五、MySQL 数据库 ​

序号章节文件
1建表规约01.建表规约
2索引规约02.索引规约
3SQL 语句03.SQL语句
4ORM 映射04.ORM映射

六、工程结构 ​

序号章节文件
1应用分层01.应用分层
2二方库依赖02.二方库依赖
3服务器03.服务器

七、设计规约 ​

附录 ​