阿里巴巴Java开发手册.pdf
《阿里巴巴Java开发手册.pdf》由会员分享,可在线阅读,更多相关《阿里巴巴Java开发手册.pdf(37页珍藏版)》请在文库网上搜索。
1、 目录 前言 . 1 一 、 编程规约 . 2 (一 ) 命名规约 . 2 (二 ) 常量定义 . 4 (三 ) 格式规约 . 5 (四 ) OOP规约 . 7 (五 ) 集合处理 . 11 (六 ) 并发处理 . 13 (七 ) 控制语句 . 16 (八 ) 注释规约 . 17 (九 ) 其它 . 18 二、异常日志 . 20 (一 ) 异常处理 . 20 (二 ) 日志规约 . 21 三、 MySQL规约 . 23 (一 ) 建表规约 . 23 (二 ) 索引规约 . 25 (三 ) SQL规约 . 27 (四 ) ORM规约 . 28 四、工程规约 . 29 (一 ) 应用分层 . 29
2、 (二 ) 二方库规约 . 30 (三 ) 服务器规约 . 32 五、安 全规约 . 33 附 1:版本历史 . 34 附 2:本规约专有名词 . 34 附 3:法律声明 . 34 (注 : 全 文 浏览 时请使用 PDF左侧导航栏) 阿里巴巴 Java开发手册 禁止用于商业用途,违者必究 1 / 37 前言 阿里 巴 巴 Java 开发手册是阿里 巴巴 集团 技术 团队的集体 经验总结 ,经历了多次大规模一线实战 的 检验及 不断 的 完善,反馈 给广大开发 者。 现代 软件行业 的 高速发展对于开发 者的综合 素质要求越来越高 , 因为 不仅 是 编 程 知识 点 ,其它维度的知识点 也
3、会影响到 软件 的 最终 交付质量 。 比如 : 数据库的表 结构和 索引设计缺陷可能 带 来软件 上的架构缺陷或性能风险 ; 工程结构混乱导致维护困难 ;没有鉴权 的 漏洞 代码被黑客 攻击 等 等 。 所以 本 手册以 Java 开发者为中心视角,划 分为 编程规约、异常日 志规约、 MySQL 规约、工程规约、安全规约 五大块,再根据内容特 征,细分成若干二级子目录。根据约束力强弱及 故障敏感性,规约依次分为强制、推荐、参考三大类。 对于规约里的内容 ,“ 说明 ” 对内容做了引申和解释; “ 正例 ” 提倡 什么样的编码 和 实现 方式 ; “ 反例 ” 说明 需要提防的雷区 , 以及
4、 真实的 错误案例 。 本 手册 的愿景 是 码出质量、码出高效 。 代码 的字里行间 流淌 的 是 软件 生命中的血液, 质量 的提升 是尽 可能少踩坑 , 杜绝 踩重复的坑, 切实 提升质量意识 。另 外, 现代软件架构都需要协同 开 发完成,高效 考虑的 是降低协同成本 ,所谓无规矩不成方圆,无规范不 能协作。 众所周知,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全。试想如果没有限速,没有红绿灯,没有规定靠右行驶,谁还敢上路行驶。对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的 统一 方式一起做事,提升协作效率。 阿里巴
5、巴 Java 开发手册 ,开放 包容 地 认 真总结 社区 、博客、论坛的反馈,及时修正, 保持 与时俱进。请 关注手册 末页的 “ 阿里技术 ” 和 “ 云栖 社区 ” 公 众 号 获取最 新版 。 阿里巴巴 Java开发手册 禁止用于商业用途,违者必究 2 / 37 Java 开发 手册 版本号 制定团队 更新日期 备注 1.1.0 阿 里巴巴 集团 技术团队 2017.2.27 增加前 言 和专有 名词 说明 , 修正部分描述。 一 、 编程规约 (一 ) 命名规约 1. 【强制】 代码中的 命名均不能以 下划线或美元符号 开始,也不能以 下划线或美元符号 结束。 反例: _name /
6、 _name / $Object / name_ / name$ / Object$ 2. 【强制】 代码中的 命名 严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明: 正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。 反例: DaZhePromotion 打折 / getPingfenByName() 评分 / int 某 变量 = 3 正例: alibaba / taobao / youku / hangzhou 等国际通用的名称, 可 视 同 英文。 3. 【强制】类名使用 UpperCamelCase风格,必须遵从驼峰形式,但以
7、下 情形例外: ( 领域模型的相关命名 ) DO / BO / DTO / VO等。 正例: MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例: macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase风格,必须遵从驼峰形式。 正例: localValue / getHttpMessage() / inputUserId 5. 【 强制】常量命名 全部大写,单词间用下划线隔
8、开,力求语义表达完整清楚,不要嫌名字长。 正例: MAX_STOCK_COUNT 反例: MAX_COUNT 6. 【强制】抽象类命名使用 Abstract或 Base开头 ; 异常类命名使用 Exception结尾 ; 测试类命名以它要测试的类的名称开始,以 Test结尾。 7. 【强制】中括号是数组类型的一部分,数组定义如下: String args; 反例: 使用 String args的方式来 定义 。 阿里巴巴 Java开发手册 禁止用于商业用途,违者必究 3 / 37 8. 【强制】 POJO类中 布尔类型的变量,都不要加 is,否则部分框架解析 会引起序列化错误。 反例: 定义为
9、基本数据类型 Boolean isSuccess; 的属性,它的方法也是 isSuccess(), RPC框架在反向解析的时候, “以为 ”对应的属性名称是 success,导致属性获取不到,进而抛出异常。 9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数 形式,但是类名如果有复数含义,类名可以使用复数形式。 正例: 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils( 此规则参考spring的框架结构 ) 10. 【强制】杜 绝完全不规范的缩写, 避免望文不知义 。 反例: AbstractClass“
10、缩写 ” 命名成 AbsClass; condition“ 缩写 ” 命名成 condi,此类随意缩写严重降低了代码的可阅读性。 11. 【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。 说明: 将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。 正例: public class OrderFactory; public class LoginProxy; public class ResourceObserver; 12. 【推荐】 接口类中的方法和属性不要加任何修饰符号 ( public 也不要加 ) ,保持代码的简洁性,并加上有效的 Javadoc注释。尽量不要在接口里
11、定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。 正例: 接口方法签名: void f(); 接口基础常量表示: String COMPANY = “alibaba“; 反例: 接口方法定义: public abstract void f(); 说明: JDK8中接口允许有默认实现,那么这个 default方法,是对所有实现类都有价值的默认实现。 13. 接口和 实现类的命名有两套规则: 1) 【强制】对于 Service和 DAO类,基于 SOA的理念,暴露出来的服务一定是接口,内部的实现类用 Impl的后缀与接口区别。 正例: CacheServiceImpl
12、实现 CacheService接口。 2) 【推荐】 如果是形容能力的接口名称,取对应的形容词做接口名 ( 通常是 able的形式 ) 。 正例: AbstractTranslator实现 Translatable。 14. 【参考】枚举类名建议带上 Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。 说明: 枚举其实就是特殊的常 量类,且构造方法被默认强制是私有。 正例: 枚举名字: DealStatusEnum, 成员名称: SUCCESS / UNKOWN_REASON。 阿里巴巴 Java开发手册 禁止用于商业用途,违者必究 4 / 37 15. 【参考】各层命名规约: A)
13、Service/DAO层方法命名规约 1) 获取单个对象的方法用 get做前缀。 2) 获取多个对象的方法用 list做前缀。 3) 获取统计值的方法用 count做前缀。 4) 插入的方法 用 save( 推荐 ) 或 insert做前缀。 5) 删除的方法 用 remove( 推荐 ) 或 delete做前缀。 6) 修改的方 法 用 update做前缀。 B) 领域模型命名规约 1) 数据对象: xxxDO, xxx即为数据表名。 2) 数据传输对象: xxxDTO, xxx为业务领域相关的名称。 3) 展示对象: xxxVO, xxx一般为网页名称。 4) POJO是 DO/DTO/B
14、O/VO的统称,禁止命名成 xxxPOJO。 (二 ) 常量定义 1. 【强制】不允许出现任何魔法值 ( 即未经定义的常量 ) 直接出现在代码中。 反例: String key = “Id#taobao_“+tradeId; cache.put(key, value); 2. 【强制】 long或者 Long初始赋值时,必须使用大写的 L,不能是小写的 l,小写容易跟数字1混淆,造成误解。 说明: Long a = 2l; 写的是数字的 21,还是 Long型的 2? 3. 【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存相关的常量放在类: CacheCons
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 阿里巴巴 Java 开发 手册