没有合适的资源?快使用搜索试试~ 我知道了~
首页阿里规约(嵩山版).pdf
资源详情
资源评论
资源推荐

前言
《Java开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,
经历了多次大规模一线实战的检验及不断完善,公开到业界后,众多社区开发者
踊跃参与,共同打磨完善,系统化地整理成册,当前的版本是嵩山版。现代软件
行业的高速发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其
它维度的知识点也会影响到软件的最终交付质量。比如:五花八门的错误码人为
地增加排查问题的难度;数据库的表结构和索引设计缺陷带来的系统架构缺陷或
性能风险;工程结构混乱导致后续项目维护艰难;没有鉴权的漏洞代码易被黑客
攻击等等。所以本手册以Java开发者为中
心视角,划分为编程规约、异常日志、单元测试、安全规约、MySQL数据库、
工程结构、设计规约七个维度,再根据内容特征,细分成若干二级子目录。另
外,依据约束力强弱及故障敏感性,规约依次分为【强制】、【推荐】、【参
考】三大类。在延伸信息中,“说明”对规约做了适当扩展和解释;“正例”提
倡什么样的编码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案
例。
手册的愿景是码出高效,码出质量。现代软件架构的复杂性需要协同开发完
成,如何高效地协同呢?无规矩不成方圆,无规范难以协同,比如,制订交通法
规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,
没有红绿灯,谁还敢上路行驶?对软件来说,适当的规范和标准绝不是消灭代码
内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起
做事,提升协作效率,降低沟通成本。代码的字里行间流淌的是软件系统的血
液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升系统稳定性,码出
质量。
我们已经在2017杭州云栖大会上发布了配套的Java开发规约IDE插件,
下载量达到162万人次,阿里云效也集成了代码规约扫描引擎。次年,发布36
万字的配套详解图书《码出高效》,本书秉持“图胜于表,表胜于言”的理念,
深入浅出地将计算机基础、面向对象思想、JVM探源、数据结构与集合、并发
与多线程、单元测试等知识客观、立体地呈现出来。紧扣学以致用、学以精进的
目标,结合阿里巴巴实践经验和故障案例,与底层源码解析融会贯通,娓娓道

(三)SQL语句
(四)ORM映射
六、工程结构
(一)应用分层
(二)二方库依赖
(三)服务器
七、设计规约
附2:专有名词解释
附3:错误码列表
一、编程规约
(一)命名风格
1.【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或
美元符号结束。
反例:_name/__name/$name/name_/name$/name__
2.【强制】所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直
接使用中文的方式。
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,纯拼音命名方式更
要避免采用。
正例:ali/alibaba/taobao/cainiao/aliyun/youku/hangzhou等国际通用的名称,
可视同英文。
反例:DaZhePromotion[打折]/getPingfenByName()[评分]/Stringfw[福娃]/int某
变量=3
3.【强制】代码和注释中都要避免使用任何语言的种族歧视性词语。
正例:日本人/印度人/blockList/allowList/secondary
反例:RIBENGUIZI/Asan/blackList/whiteList/slave

4.【强制】类名使用UpperCamelCase风格,但以下情形例外:DO/BO/
DTO/VO/AO/PO/UID等。
正例:ForceCode/UserDO/HtmlDTO/XmlService/TcpUdpDeal/TaPromotion
反例:forcecode/UserDo/HTMLDto/XMLService/TCPUDPDeal/TAPromotion
5.【强制】方法名、参数名、成员变量、局部变量都统一使用
lowerCamelCase风格。
正例:localValue/getHttpMessage()/inputUserId
6.【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清
楚,不要嫌名字长。
正例:MAX_STOCK_COUNT/CACHE_EXPIRED_TIME
反例:MAX_COUNT/EXPIRED_TIME
7.【强制】抽象类命名使用Abstract或Base开头;异常类命名使用
Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。
8.【强制】类型与中括号紧挨相连来表示数组。
正例:定义整形数组int[]arrayDemo。
反例:在main参数中,使用Stringargs[]来定义。
9.【强制】POJO类中的任何布尔类型的变量,都不要加is前缀,否则部分框
架解析会引起序列化错误。
说明:在本文MySQL规约中的建表约定第一条,表达是与否的变量采用is_xxx的命名方
式,所以,需要在<resultMap>设置从is_xxx到xxx的映射关系。
反例:定义为基本数据类型BooleanisDeleted的属性,它的方法也是isDeleted(),框架
在反向解析的时候,“误以为”对应的属性名称是deleted,导致属性获取不到,进而抛出
异常。
10.【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单
词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形
式。

正例:应用工具类包名为com.alibaba.ei.kunlun.aap.util、类名为MessageUtils(此规则
参考spring的框架结构)
11.【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采
用完全相同的命名,使可理解性降低。
说明:子类、父类成员变量名相同,即使是public类型的变量也能够通过编译,另外,局
部变量在同一方法内的不同代码块中同名也是合法的,这些情况都要避免。对于非
setter/getter的参数名称也要避免与成员变量名称相同。
反例:
1 publicclassConfusingName{
2 publicintstock;
3 //非setter/getter的参数名称,不允许与本类成员变量同名
4 publicvoidget(Stringalibaba){
5 if(condition){
6 finalintmoney=666;
7 //...
8 }
9 for(inti=0;i<10;i++){
10 //在同一方法体中,不允许与其它代码块中的money命名相同
11 finalintmoney=15978;
12 //...
13 }
14 }
15 }
16 classSonextendsConfusingName{
17 //不允许与父类的成员变量名称相同
18 publicintstock;
19 }
12.【强制】杜绝完全不规范的缩写,避免望文不知义。
反例:AbstractClass“缩写”成AbsClass;condition“缩写”成condi;Function缩
写”成Fu,此类
随意缩写严重降低了代码的可阅读性。
13.【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用
尽量完整的单词组合来表达。
剩余74页未读,继续阅读














小木偶MO
- 粉丝: 5
- 资源: 3
上传资源 快速赚钱
我的内容管理 收起
我的资源 快来上传第一个资源
我的收益
登录查看自己的收益我的积分 登录查看自己的积分
我的C币 登录后查看C币余额
我的收藏
我的下载
下载帮助

会员权益专享
最新资源
- Xilinx SRIO详解.pptx
- Informatica PowerCenter 10.2 for Centos7.6安装配置说明.pdf
- 现代无线系统射频电路实用设计卷II 英文版.pdf
- 电子产品可靠性设计 自己讲课用的PPT,包括设计方案的可靠性选择,元器件的选择与使用,降额设计,热设计,余度设计,参数优化设计 和 失效分析等
- MPC5744P-DEV-KIT-REVE-QSG.pdf
- 通信原理课程设计报告(ASK FSK PSK Matlab仿真--数字调制技术的仿真实现及性能研究)
- ORIGIN7.0使用说明
- 在VMware Player 3.1.3下安装Redhat Linux详尽步骤
- python学生信息管理系统实现代码
- 西门子MES手册 13 OpcenterEXCR_PortalStudio1_81RB1.pdf
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈



安全验证
文档复制为VIP权益,开通VIP直接复制

评论1