Java开发手册(泰山版).pdf
《Java开发手册(泰山版).pdf》由会员分享,可在线阅读,更多相关《Java开发手册(泰山版).pdf(61页珍藏版)》请在咨信网上搜索。
1、前言 Java 开发手册是阿里巴巴集团技术团队的集体智慧结晶和经验总结,经历了多次大规模一线实战的检验及不断完善,公开到业界后,众多社区开发者踊跃参与,共同打磨完善,系统化地整理成册,当前的版本是泰山版。现代软件行业的高速发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点也会影响到软件的最终交付质量。比如:数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险;工程结构混乱导致后续维护艰难;没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以 Java 开发者为中心视角,划分为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度,再
2、根据内容特征,细分成若干二级子目录。另外,依据约束力强弱及故障敏感性,规约依次分为强制、推荐、参考三大类。在延伸信息中,“说明”对规约做了适当扩展和解释;“正例”提倡什么样的编码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案例。手册的愿景是码出高效,码出质量。现代软件架构的复杂性需要协同开发完成,如何高效地协同呢?无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,没有红绿灯,谁还敢上路行驶?对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,提升协作效
3、率,降低沟通成本。代码的字里行间流淌的是软件系统的血液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升系统稳定性,码出质量。我们已经在 2017 杭州云栖大会上发布了配套的 Java 开发规约 IDE 插件,下载量达到 152 万人次,阿里云效也集成了代码规约扫描引擎。次年,发布 36 万字的配套详解图书码出高效,本书秉持“图胜于表,表胜于言”的理念,深入浅出地将计算机基础、面向对象思想、JVM 探源、数据结构与集合、并发与多线程、单元测试等知识客观、立体地呈现出来。紧扣学以致用、学以精进的目标,结合阿里巴巴实践经验和故障案例,与底层源码解析融会贯通,娓娓道来。码出高效和Java开发手册书
4、籍版所得收入均捐赠公益事情,希望用技术情怀帮助更多的人。目录 前 言.一、编程规约.1(一)命名风格.1(二)常量定义.4(三)代码格式.5(四)OOP 规约.7(五)日期时间.11(六)集合处理.12(七)并发处理.17(八)控制语句.20(九)注释规约.24(十)其它.25 二、异常日志.27(一)错误码.27(二)异常处理.28(三)日志规约.30 三、单元测试.33 四、安全规约.35 五、MySQL 数据库.36(一)建表规约.36(二)索引规约.37(三)SQL 语句.39(四)ORM 映射.40 六、工程结构.42(一)应用分层.42(二)二方库依赖.43(三)服务器.44 七、
5、设计规约.46 附 1:版本历史.49 附 2:专有名词解释.51 附 3:错误码列表.52 (注:浏览时请使用PDF左侧导航栏)Java 开发手册 1/57 一、编程规约(一)命名风格 1.【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反例:_name/_name/$name/name_/name$/name_ 2.【强制】所有编程相关的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,纯拼音命名方式更要避免采用。正例:ali/alibaba/taobao/cainiao/aliyu
6、n/youku/hangzhou 等国际通用的名称,可视同英文。反例:DaZhePromotion 打折/getPingfenByName()评分/int 某变量=3 3.【强制】类名使用 UpperCamelCase 风格,但以下情形例外:DO/BO/DTO/VO/AO/PO/UID 等。正例:ForceCode /UserDO /HtmlDTO /XmlService /TcpUdpDeal/TaPromotion 反例:forcecode /UserDo /HTMLDto /XMLService /TCPUDPDeal/TAPromotion 4.【强制】方法名、参数名、成员变量、局部变
7、量都统一使用 lowerCamelCase 风格。正例:localValue/getHttpMessage()/inputUserId 5.【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。正例:MAX_STOCK_COUNT/CACHE_EXPIRED_TIME 反例:MAX_COUNT/EXPIRED_TIME 6.【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。7.【强制】类型与中括号紧挨相连来表示数组。正例:定义整形数组 int arrayDe
8、mo;反例:在 main 参数中,使用 String args来定义。8.【强制】POJO 类中的任何布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。说明:在本文 MySQL 规约中的建表约定第一条,表达是与否的值采用 is_xxx 的命名方式,所以,需要在设置从 is_xxx 到 xxx 的映射关系。版本号 制定团队 更新日期 备注 1.6.0 阿里巴巴与 Java 社区开发者 2020.04.22 泰山版,首次发布错误码统一方案 Java 开发手册 2/57 反例:定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted(),
9、框架在反向解析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。9.【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。正例:应用工具类包名为 com.alibaba.ei.kunlun.aap.util、类名为 MessageUtils(此规则参考 spring 的框架结构)10.【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可读性降低。说明:子类、父类成员变量名相同,即使是 public 类型的变量也是能够通过编译,而局部变量在同一
10、方法内的不同代码块中同名也是合法的,但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。反例:public class ConfusingName public int stock;/非 setter/getter 的参数名称,不允许与本类成员变量同名 public void get(String alibaba)if(condition)final int money=666;/.for(int i=0;i 10;i+)/在同一方法体中,不允许与其它代码块中的 money 命名相同 final int money=15978;/.class Son ex
11、tends ConfusingName /不允许与父类的成员变量名称相同 public int stock;11.【强制】杜绝完全不规范的缩写,避免望文不知义。反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。12.【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达。正例:在 JDK 中,对某个对象引用的 volatile 字段进行原子更新的类名为:AtomicReferenceFieldUpdater。反例:常见的方法内变量为 int a;的定义方式。J
12、ava 开发手册 3/57 13.【推荐】在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。正例:startTime/workQueue/nameList/TERMINATED_THREAD_COUNT 反例:startedAt/QueueOfWork/listName/COUNT_TERMINATED_THREAD 14.【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。正例:public class OrderFactory;public class LoginProxy;public cla
13、ss ResourceObserver;15.【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,确定与接口方法相关,并且是整个应用的基础常量。正例:接口方法签名 void commit();接口基础常量 String COMPANY=alibaba;反例:接口方法定义 public abstract void f();说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默认实现。16.接口和实现类的命名有两套规则:1)【强制】对于
14、 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用Impl 的后缀与接口区别。正例:CacheServiceImpl 实现 CacheService 接口。2)【推荐】如果是形容能力的接口名称,取对应的形容词为接口名(通常是able 的形容词)。正例:AbstractTranslator 实现 Translatable 接口。17.【参考】枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCES
15、S/UNKNOWN_REASON。18.【参考】各层命名规约:A)Service/DAO 层方法命名规约 1)获取单个对象的方法用 get 做前缀。2)获取多个对象的方法用 list 做前缀,复数结尾,如:listObjects。3)获取统计值的方法用 count 做前缀。4)插入的方法用 save/insert 做前缀。5)删除的方法用 remove/delete 做前缀。6)修改的方法用 update 做前缀。B)领域模型命名规约 1)数据对象:xxxDO,xxx 即为数据表名。2)数据传输对象:xxxDTO,xxx 为业务领域相关的名称。Java 开发手册 4/57 3)展示对象:xxx
16、VO,xxx 一般为网页名称。4)POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。(二)常量定义 1.【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。反例:/本例中同学 A 定义了缓存的 key,然后缓存提取的同学 B 使用了 Id#taobao 来提取,少了下划线,导致故障。String key=Id#taobao_+tradeId;cache.put(key,value);2.【强制】在 long 或者 Long 赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数字混淆,造成误解。说明:Long a=2l;写的是数字的 21,还是 L
17、ong 型的 2。3.【推荐】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解,也不利于维护。正例:缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 ConfigConsts 下。4.【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1)跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。2)应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下。反例:易懂变量也
18、要统一定义成应用内共享常量,两位工程师在两个类中分别定义了“YES”的变量:类 A 中:public static final String YES=yes;类 B 中:public static final String YES=y;A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致线上问题。3)子工程内部共享常量:即在当前子工程的 constant 目录下。4)包内共享常量:即在当前包下单独的 constant 目录下。5)类内共享常量:直接在类内部 private static final 定义。5.【推荐】如果变量值仅在一个固定范围内变化用 enu
19、m 类型来定义。说明:如果存在名称之外的延伸属性应使用 enum 类型,下面正例中的数字就是延伸信息,表示一年中的第几个季节。正例:public enum SeasonEnum SPRING(1),SUMMER(2),AUTUMN(3),WINTER(4);private int seq;SeasonEnum(int seq)this.seq=seq;public int getSeq()Java 开发手册 5/57 return seq;(三)代码格式 1.【强制】如果是大括号内为空,则简洁地写成即可,大括号中间无需换行和空格;如果是非空代码块则:1)左大括号前不换行。2)左大括号后换行。3
20、)右大括号前换行。4)右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。2.【强制】左小括号和右边相邻字符之间不出现空格;右小括号和左边相邻字符之间也不出现空格;而左大括号前需要加空格。详见第 5 条下方正例提示。反例:if(空格 a=b 空格)3.【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。4.【强制】任何二目、三目运算符的左右两边都需要加一个空格。说明:包括赋值运算符=、逻辑运算符&、加减乘除符号等。5.【强制】采用 4 个空格缩进,禁止使用 tab 字符。说明:如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格
21、。IDEA 设置 tab 为 4 个空格时,请勿勾选 Use tab character;而在 eclipse 中,必须勾选 insert spaces for tabs。正例:(涉及 1-5 点)public static void main(String args)/缩进 4 个空格 String say=hello;/运算符的左右必须有一个空格 int flag=0;/关键词 if 与括号之间必须有一个空格,括号内的 f 与左括号,0 与右括号不需要空格 if(flag=0)System.out.println(say);/左大括号前加空格且不换行;左大括号后换行 if(flag=1)S
22、ystem.out.println(world);/右大括号前换行,右大括号后有 else,不用换行 else System.out.println(ok);/在右大括号后直接结束,则必须换行 Java 开发手册 6/57 6.【强制】注释的双斜线与注释内容之间有且仅有一个空格。正例:/这是示例注释,请注意在双斜线之后有一个空格 String commentString=new String();7.【强制】在进行类型强制转换时,右括号与强制转换值之间不需要任何空格隔开。正例:long first=1000000000000L;int second=(int)first+2;8.【强制】单行字
23、符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:1)第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。2)运算符与下文一起换行。3)方法调用的点符号与下文一起换行。4)方法调用中的多个参数需要换行时,在逗号后进行。5)在括号前不要换行,见反例。正例:StringBuilder sb=new StringBuilder();/超过 120 个字符的情况下,换行缩进 4 个空格,并且方法前的点号一起换行 sb.append(zi).append(xin).append(huang).append(huang).append(huang);反例:StringBui
24、lder sb=new StringBuilder();/超过 120 个字符的情况下,不要在括号前换行 sb.append(you).append(are).append (lucky);/参数很多的方法调用可能超过 120 个字符,逗号后才是换行处 method(args1,args2,args3,.,argsX);9.【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。正例:下例中实参的 args1,后边必须要有一个空格。method(args1,args2,args3);10.【强制】IDE 的 text file encoding 设置为 UTF-8;IDE 中文件的换行符使
25、用 Unix 格式,不要使用 Windows 格式。11.【推荐】单个方法的总行数不超过 80 行。说明:除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80 行。正例:代码逻辑分清红花和绿叶,个性和共性,绿叶逻辑单独出来成为额外方法,使主干代码更加清晰;共性逻辑抽取成为共性方法,便于复用和维护。Java 开发手册 7/57 12.【推荐】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。正例:int one=1;long two=2L;float three=3F;StringBuilder sb=new StringBuilder();
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- Java 开发 手册 泰山
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【Stan****Shan】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【Stan****Shan】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。