阿里规约手册转载-官方版仅供学习请支持正版

所需积分/C币:9 2018-04-28 13:59:09 1.5MB PDF
收藏 收藏
举报

阿里规约手册转载-官方版仅供学习请支持正版。可到阿里官方免费下载
《阿里巴巴Java开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经 验总结,经历了多次大规模一线实战的检验及不断的完善,系统化地整理成册, 回馈给广大开发者。现代软件行业的高速发展对开发者的综合索质要求越来越高,囚 为不仅是编程知识点,其它维度的知识点也会影响到软件的最终交付质量。比如:数 据库的表结构和索引设计缺陷可能带米软件上的架构缺陷或性能风险;工程结构混乱 导致后续维护艰难;没有鉴权的漏洞代码易被黑客攻击等等。所以本J册以Java开发 者为屮心视角,划分为编程规约、异常日志、单元测试、安全规约、工程结构、 My SQL 数据库六个维度,再根据内容特征,细分成若干二级子目录。根据约束力强弱及故障 敏感性,规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中,“说 明”对内睿做了适当扩`展和解释;“正例”提倡什么样的编码和实现方式:“反 例”说明需要提防的雷区,以及真实的错误案例。 本手册的愿景是码出高效,码出质量。现代软件架构都需要协同开发完成,高效 协作即降低协同成木,提升沟通效率,所谓无规矩不成方圆,无规范不能协作。众所 周知,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全。试想如 果没有限速,没有红绿灯,谁还敢上路行驶。对软件来说,适当的规范和标准绝不是 消灭代码內容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式 一起做事,提升协作效率。代码的字里行间流淌的是软件生命中的血液,质量的提升 是尽可能少埰坑,杜绝踩重复的坑,切实提升质量意识。 考虑到可以零距离地与众多开发同学进行互动,决定未来在线维护《手卅》内容, 此1.3.1的PDF版本,是对外释放的最终纪念版,铭记发布第一版以来的358天旅程 我们已经在杭州云栖大会上进行了阿里巴巴Java开发规约插件点此下载,阿里云效( 站式企业协同研发云)也集成了代码规约扫描引擎。最后,《码出髙效—阿里巴巴 Java开发手册详解》即将出版,敬请关注。 目录 、编程规约 (一)命名风格 (二)常量定义 (三)代码格式 (四)00P规约 (五)集合处理 469 (六)并发处理 12 (七)控制语句 14 (八)注释规约 16 (九)其它 17 异常日志 ....17 (一)异常处理 17 (二)日志规约 19 三、单元测试 22 四、安全规约 24 五、 MySQL数据库 25 (一)建表规约 25 (二)索引规约 26 (三)SQL语句..28 (四)ORM映射 29 六、工程结构. 31 (-)应用分层 ...31 (二)二方库依赖 ..32 (三)服务器 33 附1:版本历史 35 附2:本手册专有名词 (注:浏览时请使用PDF左侧导航栏 阿里巴巴]ava开发手册 ava开发手册 版本号 制定团队 更新日期 备注 阿里巴巴集团技术团队 2017.11.30 修正部分描述(纪念版) 、编程规约 (一)命名风格 1.【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束 反例:name/_name/$name/name_/name$/name 2。【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式 也要避免采用 正例: alibaba/ taobao/ youku/ hangzhou等国际通用的名称,可视同英文 反例: DaZhe promotion[打折]/ get pingfeng Name()[评分]/int某变量=3 3.【强制】类名使用 Upper Came Case人格,但以卜情形例外:Do/Bo/DT0/V0/A0/ PO等。 IEF: MarcoPolo UserDO / XmLService TcpUdpDeal /TaPromotion KM: macroPoLo/ UserDo/ XMLService TCPUDPDeal TAPromotion 4。【强制】方法名、参数名、成员变量、局部变量都统一使用 ower Camelcase风格,必须遵从 驼峰形式 IeB:Localvalue/gethttpmesSage()/inputUserid 5.【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。 正例 MAX STOCK COUNT 反例: MAX COUNT 6.【强制】抽象类命名使用 Abstract或Base开头:异常类命名使用 EXception结尾:测试类 命名以它要测试的类名开始,以Test结尾。 7.【强制】类型与中括号紧挨相连来定义数组 正例:定义整形数组 int[ array Demo; 反例:在man参数中,使用 String args来定义 8.【强制】P0]0类中布尔类型的变量,都不要加is前缀,否则部分框架解析会引起序列化错误 反例:定义为基本数据类型 Boolean isdeleted:的属性,它的方法也是 isDeleted(),RPC 1/36 阿里巴巴]ava开发手册 框架在反向解析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛 出异常。 9.【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式 正例:应用工具类包名为com, alibaba.ai.utiL、类名为 Messageutils(此规则参考 spring 的框架结构) 1.【强制】杜绝完全不规范的缩写,避免望文不知义。 反例: Abstractclass“缩写”命名成 AbsClass; condition“缩写”命名成 condi,此类随 意缩写严重降低了代码的可阅读性 11.【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合米表达其意。 正例:从远程仓厍拉取代码的类命名为 PullCodeFromRemoteRepository 反例:变量inta;的随意命名方式。 12.【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现岀具体模式 说明:将设计模式伓现在名字中,有利于阅读者快速理解架构设计理念 正例: public class OrderFactory public class LoginProxyi public class Resourceobserver i 13.【推荐】接口类中的方法和属性不要加任何修饰符号( public也不要加),保持代码的简洁 性,并加上冇效的 Javadoc注释。尽量不要在接凵里定义变量,如果·定要定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量 正例:接口方法签名 void f(); 接口基础常量 String COMPANY=" alibaba"; 反例:接口方法定义 public abstract void f(); 说明:jDK8中接口允许有默认实现,那么这个 default方法,是对所有实现类都有价值的默 认实现 14.接口和实现类的命名有两套规则 1)【强制】对于 Service和DAo类,基于S0A的理念,暴露出来的服务一定是接口,内部 的实现类用Imp1的后缀与接口区别 正例: CacheserviceImpl实现 Cacheservice接口。 2)【推荐】如果是形容能力的接凵名称,取对应的形容词为接凵名(通常是-abLe的形式) 正例: Abstracttranslator实现 Translatable 2/36 阿里巴巴]ava开发手册 15.【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开 说眀:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。 正例:枚举名字为 Processstatus enum的成员名称: SUCCESS/ UNKNOWN REASON。 16.【参考】各层命名规约: A) Service/DA层方法命名规约 1)获取单个对象的方法用get作前缀。 2)获取多个对象的方法用1ist作前缀。 3)获取统计值的方法用 count作前缀。 4)插入的方法用save/ insert作前缀。 5)删除的方法用 remove/ delete作前缀。 6)修改的方法用 update作前缀 B)领域模型命名规约 1)数据对象:XXxD0,XX即为数据表名。 2)数据传输对象: XXXI0,xxx为业务领域相关的名称。 3)展示对象:XXXV0,xxX一般为网页名称。 4)PoJo是D0/DTo/BO/vo的统称,禁止命名成ⅹxxP0]0。 (二)常量定义 1.【强制】不允许仁何魔法值(即未经预先定义的常量)直接出现在代码中。 反例: String key="Id# taobao_"+ traded cache put(key, value) 2.【强制】Long或者Long初始赋值时,使用大写的L,不能是小写的1,小写容易跟数字1混 淆,造成误解 说明: Long a=21;写的是数字的21,还是Long型的2? 3.【推荐】不要使用一个常量类维护所有常量,按常量功能进行归类,分开维扩'。 说明:大而全的常量类,非得使用査找功能才能定位到修改的常量,不利于理解和维护。 正例:缓存相关常量放在类 Cacheconsts下:系统配置相关常量放在类 ConfigConsts下。 4.【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。 1)跨应用共享常量:放置在二方库中,通常是 client,jar中的 constant目录下 2)应用内共享常量:放置在一方库中,通常是子模块中的 constant日录下。 反例:易懂变量也要统一定义成应用內共享常量,两位攻城师在两个类中分別定义了表示 是"的变量 类A中: public static final String YES="yes" 3/36 阿里巴巴]ava开发手册 类B中: public static final String YES="y"; A.YEs. equals(B.YES),预期是true,但实际返回为 false,导致线上问题。 3)子工程内部共享常量:即在当前子工程的 constant日录下 4)包内共享常量:即在当前包下单独的 constant目录下。 5)类内共亨常量:直接在类内部 private static fina1定义 5。【推荐】如果变量值仅在·个固定范围内变化用enum类型来定义 说明:如果存在名称之外的延伸属性使用enum类型,下面正例中的数字就是延伸信息,表示 一年中的第几个季节。 正例: public enum Season Enum SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4) int seqi SeasonEnum(int seg) this seq segi (三)代码格式 1.【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果 是非空代码块则: 1)左大括号前不换行。 2)左大括号后换行 3)右大括号前换行 4)右大括号后还有ese等代码则不换行;表示终止的右大括号后必须换行。 2.【强制】左小括号和字符之间不出现空格;同样,石小括号和字符之间也不出现空格。详见 第5条下方正例提小 反例:if(空格a==b空格) 3.【强制】if/for/ while/ switch/do等保留字与括号之间都必须加空格。 4.【强制】任何二日、三日运算符的左右两边都需要加一个空格 说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等 5.【强制】采用4个空格缩进,禁止使用tab字符 说明:如果使用tab缩进,必须设置1个tab为4个空格。IDEA设置tab为4个空格时, 请勿勾选 Use tab character;m在 eclipse中,必须勾选 insert spaces for tabs o 正例:(涉及1-5点) public static void main(String[] args)t /缩进4个空格 4/36 阿里巴巴]ava开发手册 String say ="hello /运算符的左右必须有一个空格 t flag=0 //关键词if与括号之间必须有一个空格,括号内的f与左括号,日与右括号不需要空格 if (flag ==0)t System. out. printin(say) //左大括号前加空格且不换行:左大括号后换行 if (flag System. out. printIn("world"); 右大括号前换行,右大括号后有eLse,不用换行 3 else System. out. println ("ok"); //在右大括号后直接结束,则必须换行 6。【强制】注释的双斜线与注释内容之间有且仅有一个空格。 正例: //这是示例注释,请注意在双斜线之后有一个空格 String ygb= new String(; 7.【强制】单行字符数限制不超过120个,超岀需要换行,换行时遵循如下原贝 1)第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进,参考小例 2)运算符与下文一起换行 3)方法调用的点符号与下文起换行。 4)方法调用时,多个参数,需要换行时,在逗号后进行。 5)在括号前不要换行,见反例。 正例: StringBuffer sb= new StringBuffer(); /超过128个字符的情况下,換行缩进4个空格,点号和方法名称一起换行 sb, append ("zi"). append("xin") append ("huang") append ("huang") Append ("huang"); 反例 StringBuffer sb= new StringBuffer () /超过128个字符的情况下,不要在括号前换行 sb. append("zi"). append (" xin").append luang /参数很多的方法调用可能超过120个字符,不要在逗号前换行 method (args, args, args, args) 8.【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。 正例:下例中实参的"a",后边必须要有一个空格。 thod ("a 5/36 阿里巴巴]ava开发手册 9.【强制】IDE的 text file encoding设冒为UTF-8;IDE中文件的换行符使用Unix格式, 不要使用 Windows格式。 1⊙.【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。 正例: int a = 3: Long b = 4L float c= 5f: StringBuffer sb= new StringBuffer(; 说明:增加sb这个变量,如果需要对齐,则给a、b、c都要增加几个空格,在变量比较多的 情况下,是非常累赘的事情。 11.【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。 说明:没有必要插入多个空行进行隔开 (四)00P规约 1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成 本,直接用类名来访问即可 2.【强制】所有的覆写方法,必须加@ Override注解。 说明: getobject()与 getobject()的问题。一个是字母的0,一个是数字的0,加@ oVerride 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现芡会马上编 译报错。 3.【强制】相同参数类型,相同业务含义,才可以使用]ava的可变参数,避免使用 object。 说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程) IE1: public User getusers(String type, Integer.. ids)[.) 4.【强制】外部正在调用或者二方库依赖的接凵,不允许修改方法签名,避免对接凵调用方生 影响。接口过时必须加@ Deprecated注解,并清晰地说明采用的新接口或者新服务是什么。 5.【强制】不能使用过时的类或方法 说明:java.net, URLDecoder中的方法 decode( String encodestr)这个方法已经过时,应 该使用双参数 decode〔 String source, String encode)。接口提供方既然明确是过时接口 那么有义务同时提供新的接口:作为调用方来说,有义务去考证过时方法的新实现是什么。 6.【强制】 bject的 equals方法容易抛空指针异常,应使用常量或确定冇值的对象来调用 equals 正例 :test.equals(object) 反例: object, equals("test"); 说明:推荐使用ja Va.utiL.0 bjects# equals(DK7引入的工具类 6/36

...展开详情
试读 41P 阿里规约手册转载-官方版仅供学习请支持正版
立即下载 低至0.43元/次 身份认证VIP会员低至7折
    抢沙发
    一个资源只可评论一次,评论内容不能少于5个字
    • GitHub

      绑定GitHub第三方账户获取
    • 签到新秀

      累计签到获取,不积跬步,无以至千里,继续坚持!
    关注 私信 TA的资源
    上传资源赚积分,得勋章
    最新推荐
    阿里规约手册转载-官方版仅供学习请支持正版 9积分/C币 立即下载
    1/41
    阿里规约手册转载-官方版仅供学习请支持正版第1页
    阿里规约手册转载-官方版仅供学习请支持正版第2页
    阿里规约手册转载-官方版仅供学习请支持正版第3页
    阿里规约手册转载-官方版仅供学习请支持正版第4页
    阿里规约手册转载-官方版仅供学习请支持正版第5页
    阿里规约手册转载-官方版仅供学习请支持正版第6页
    阿里规约手册转载-官方版仅供学习请支持正版第7页
    阿里规约手册转载-官方版仅供学习请支持正版第8页
    阿里规约手册转载-官方版仅供学习请支持正版第9页
    阿里规约手册转载-官方版仅供学习请支持正版第10页
    阿里规约手册转载-官方版仅供学习请支持正版第11页
    阿里规约手册转载-官方版仅供学习请支持正版第12页
    阿里规约手册转载-官方版仅供学习请支持正版第13页

    试读已结束,剩余28页未读...

    9积分/C币 立即下载 >