阿里Java开发规约— 业界公开版.pdf

所需积分/C币:49 2017-01-21 20:41:42 627KB PDF
收藏 收藏
举报

阿里巴巴 JAVA 开发手册,阿里巴巴集团技术部 2016年12月7日首次向 Java 业界公开~
阿里巴巴JAVA开发手册 2)【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是-able的形 式)。 正例: Abstracttranslator实现 Translatable 14.【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。 说眀:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。 正例:枚举名字: Dealstatusenum;成员名称: SUCCESS/ UNKOW REASON。 15.【参考】各层命名规约: A) Service/DAO层方法命名规约 1)获取单个对象的方法用get做前缀 2)获取多个对象的方法用list做前缀 3)获取统计值的方法用 count做前缀。 1)插入的方法用save(推荐)或 lnsert做前缀。 5)删除的方法用 remove(推荐)或 delete做前缀。 6)修改的方法用 update做前缀 B)领域模型命名规约 1)数据对象:xxDO,xxx即为数据表名 2)数据传输对象: XXXDT0,xxx为业务领域相关的名称。 3)展小对象:xxY0,xxx一般为网页名称。 4)POJ0是 DO/DTO/BO/VO的统称,禁止命名成ⅹ KXPOJO (二)常量定义 1.【强制】不允许岀现任何魔法值(即未绎定义的常量)直接出现在代码中。 反例: String key="Id# taobao"+ traded; cache put(k ey, value) 2.【强制】long或者Long初始赋值时,必须使用大写的L,不能是小写的1,小写容易跟数字1 混淆,造成误解。 说明: Long a-21;写的是数字的21,还是Lng型的2? 3.【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存 相关的常量放在类: CacheConsts下;系统配置相关的常量放在类: ConfigConsts下。 说明:大而全的常量类,非得ctrl艹f才定位到修改的常量,不利于理解,也不利于维扩。 3/32 阿里巴巴JAVA开发手册 4.【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量 1)跨应用共享常量:放置在二方库中,通常是 client.jar中的 const日录下 2)应用内共享常量:放置在一方库的 modules中的 const目录下。 反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分别定义了表示 “是”的变量: 类A中: public static final String YES="yes 类B中: public static final String YES A.YES. equals(B.YES),预期是true,但实际返回为alse,导致产生线上问题 3)子工程内部共享常量:即在当前子工程的 const目录下 4)包内共享常量:即在当前包下单独的 cons t目录下 5)类内共享常量:直接在类内部 private static fina定义。 5.【推荐】如果变量值仅在一·个范围内变化用Enum类。如果还带有名称之外的延伸属性,必须 使用Enum类,下面正例中的数字就是延伸信息,表示星期几。 IEv]: public Enum MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5) SATURDAY(6), SUNDAY(7); J (三)格式规约 1.【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成即可,不需要换行;如果 是非空代码块则: 1)左大括号前不换行 2)左大括号后换行。 3)右大括号前换行。 1)右大括号后还有else等代码则不换行;表小终止右大括号后必须换行。 2.【强制】左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空 格。详见第5条下方正例提示。 3.【强制】if/for/ while/ switch/do等保留字与左右括号之间都必须加空格。 4.【强制】任何运算符左右必须加一个空格 说明:运算符包括赋值运算符=、逻辑运算符&、加减乘除符号、三目运行符等。 5.【强制】代码块缩进4个空格,如果使用tab缩进,请设置成1个tab为4个空格。 正例:(涉及1-5点) 4/32 阿里巴巴JAVA开发手册 public static void main(String args //缩进4个空格 String say- hello //运算符的左右必须有一个空格 It flag=0 //关键词if'与括号之间必须有一个空格,括号内f与左括号,1与右括号不需要空格 f(flag==0) System. out. println(say) //左大括号前加空格且不换行;左大括号后换行 if (flag--1) System. out. printIn( world") //右大括号前换行,右大括号后有else,不用换行 System. out. printIn("ok") //右大括号做为结束,必须换行 6.【强制】单行字符数限制不超过120个,超出需要换行,换行时,遵循如下原则: 1)换行时相对上一行缩进4个空格。 2)运算符与下文一起换行。 3)方法调用的点符号与下文一起换行 4)在多个参数超长,逗号后进行换行 5)在括号前不要换行,见反例。 正例 StringBuffer sb- new StringBuffer /超过120个字符的情况下,换行缩进4个空格,并且方法前的点符号一起换行 sb. append( zi ) append(" xin"). 反例 StringBuffer sb new StringBuffer O //超过120个字符的情况下,不要在活号前换行 sb. append( zi ). append( xin )-append (huang /参数很多的方法调用也超过120个字符,逗号后才是换行处 method (args, args2, args 7.【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。 正例:下例中实参的"a",后边必须要有一个空格。 thod( a","b 5/32 阿里巴巴JAVA开发手册 8.【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐 正例: int a long b=1L float C-5F StringBuffer sb= new StringBuffer 说明:增加sb这个变量,如果需要对齐,则给a、b、c都要增加几个空格,在变量比较多的 情况下,是一种累赘的事情 9.【强制】IDE的 text file encoding设置为UF-8;IDE中文件的换行符使用Unix格式,不 要使用 windows格式 10.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之 间插入一个空行。相同业务逻辑和语义之间不需要插入空行。 说明:没有必要插入多行空格进行隔开。 (四)00P规约 1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成 本,直接用类名来访问即可 2.【强制】所有的覆写方法,必须加@ verride注解 反例: getObjecL(与 ge oBject(的问题。一个是字母的0,一个是数字的0,加@0 override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类公马上编 译报错 3.【强制】相同参数类型,相同业务含义,才可以使用Java的可变参数,避免使用 Object 说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程) IE) public User ge uSers(String type, Integer .. ids) 4.【强制】对外暴露的接口签名,原则上不允许修改方法签名,避免对接口调用方产生影响。接 口过时必须加@ deprecated注解,并清晰地说明采用的新接口或者新服务是什么。 5.【强制】不能使用过时的类或方法 说明:java.net. LRLDecoder中的方法 decode( String encodestr)这个方法已经过时,应该 使用双参数 decode( String source, String encode)。接口提供方既然明确是过时接口,那 么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么。 6.【强制】 bject的 equals方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals 正例:"test". equals( object); 6/32 阿里巴巴JAVA开发手册 反例: object. equals("test"); 说明:推荐使用java.uti1.0 bjects# equals(JDK7引入的工具类) 7.【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals方法比较 说明:对于 Integer var-?在-128至127之间的赋值, Integer对象是在 Integercache. cache 产生,会复用已有对象,这个区间内的 Integer值可以直接使用=进行判断,但是这个区间之 外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,推荐使用 equals方 法进行判断 8.【强制】关于基本数据类型与包装数据类型的使用标准如 1)所有的POJ0类属性必须使用包装数据类型。 2)RPC方法的返回值和参数必须使用包装数据类型 3)所有的局部变量推荐使用基本数据类型。 说明:POJ0炎属性没有初值是提醒使用者在需要使用时,必须自口显式地进行赋值,任何 NPE问题,或者入库检查,都由使用者来保证。 正例:数据库的查询结果可能是nul1l,因为自动拆箱,用基本数据类型接收有NE风险。 反例:某业务的交易报表上显示成交总额涨跌情况,即正负x%,x为基本数据类型,调用的 RPC服务,调用不成功时,返回的是默认值,页面显示:0%,这是不合理的,应该显示成中划 线。所以包装数据类型的null值,能够表示额外的信息,如:远程调用失败,异常退出 9.【强制】定义D0DT0/0等POJ0类时,不要设定任何属性默认值。 反例:某业务的D0的 gmtCreate默认值为 new Date();但是这个属性在数据提取吋并没有置 入具体值,在更新其它字段时又刚带更新∫此字段,导致创建时间被修改成当前时间。 10.【强制】序列化类新增属性时,请不要修改 serialversionuid字段,避免反序列失败;如果 完全不兼容升级,避免反序列化混乱,那么请修改 serialversionuID值。 说明:注意 serialversionuiD不一致会抛出序列化运行时异常。 .【强制】构造方法里面禁止加入仼何业务逻缉,如果有初始化逻缉,请放在iit方法中。 12.【强制】POJ0类必须写 tostring方法。使用工具类 source> generate tostring时,如果继 承了另一个POJ0类,注意在前面加下 super. tostring 说明:在方法执行抛出异常时,可以直接调用POJ0的 toString(方法打印其属性值,便于排 查问题。 13.【推荐】使用索引访问用 String的 split方法得到的数组时,需做最后一个分隔符后有无内 容的检查,否则会有抛 IndexOutOfBoundsException的风险。 7/32 阿里巴巴JAVA开发手册 说明 String str-a, b, c,, Strin ary- str split(,) //预期大于3,结果是3 System. out. printIn (ary length 14.【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便 于阅读。 15.【推荐】类内方法定义顺序依次是:公有方法或保护方法〉私有方法> getter/ setter方 法 说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类 关心,也可能是“模板设计模式”下的核心方法;而私有方法外部一般不需要特別关心,是 个黑盒实现;因为方法信息价值较低,所有 Service和DA0的 getter/ setter方法放在类体最 16.【推荐】 setter方法中,参数名称与类成员变量名称一致,this.成员名=参数名。在 getter/ setter方法中,尽量不要增加业务逻辑,増加排查问题难度。 反例: oublic Integer get Datai f(true) I return return data -100 17.【推荐】循环体内,字符串的联接方式,使用 StringBuilder的 append方法进行扩展 反例 String str= start for ( int i=0: i<100: i++i tr= str hello 说明:反编译出的字节码文件显示每次循环都会new出一个 StringBuilder对象,然后进行 append操作,最后通过 tostring方法返回 String对象,造成内存资源浪费 18.【推荐】inal可提高程序响应效率,声明成 final的情况: 1)不需要重新赋值的变量,包括类属性、局部变量。 2)对象参数前加fina1,表示不允许修改引用的指向。 3)类方法确定不允许被重写。 19.【推荐】慎用 Object的 clone方法来拷贝刈象。 说明:对象的 clone方法默认是浅拷贝,若想实现深拷贝需要重写 clone方法实现属性对象的 拷贝 8/32 阿里巴巴JAVA开发手册 20.【推荐】类成员与方法访问控制从严 1)如果不允许外部直接通过new来创建对象,那么构造方法必须是 private。 2)工具类不允许有 public或 default构造方法。 3)类非 static成员变量并且与子类共享,必须是 protected 4)类非 static成员变量并且仅在木类使用,必须是 private。 5)类 static成员变量如果仅在本类使用,必须是 private。 6)若是 static成员变量,必须考虑是否为 final。 7)类成员方法只供类内部调用,必须是 private 8)类成员方法只对继承类公开,那么限制为 protecled 说眀:任何类、方法、参数、变量,严控访问范围。过宽泛的访问范围,不利于模块解耦。思 考:如果是一个 private的方法,想删除就删除,可是一个 public的 Service方法,或者 个 public的成员变量,删除一下,不得手心冒点汁吗?变量像自己的小孩,尽量在自己的视 线内,变量作用域太大,如果无限制的到处跑,那么你会担心的。 (五)集合处理 1.【强制】Map/Set的key为自定义对象时,必须重写 hashCode和 equals。 正例: String重写了 hashCode和 equals方法,所以我们可以非常愉快地使用 String对象作 为key来使用。 2.【强制】 Arraylist的 sublist结果不可强转成 Arraylist,否则会抛出 ClasscastException FR: java util. RandomAccessSubList cannot be cast to java. util. ArrayList 说明: sublist返回的是 Arraylist的内部类 Sublist,并不是 Arraylist,而是 Arraylist 的一个视图,对于 Sublist子列表的所有操作最终会反映到原列表上。 3.【强制】在 sublist场景中,高度注意对原集合元素个数的修改,会导致子列表的遍历、增加、 删除均产生 ConcurrentModificationException异常 4.【强制】使用集合转数组的方法,必须使用集合的 toArray( TU array),传入的是类型完全 一样的数组,大小就是1ist.size(。 反例:直接使川 toarray无参方法存在问题,此方法返回值以能是 Object]类,若强转其它 类型数组将出现 ClassCastException错误 正例 List<String> list new ArrayList<String>(2) list, add( guan") list. add(bao) [ () array= list. toArray (array) 9/32 阿里巴巴JAVA开发手册 说明:使用 toArray带参方法,入参分配的数组空间不够大时, toArray方法内部将重新分配 内存空间,并返回新数组地址;如果数组元素大于实际所需,下标为[1ist.size()]的数组 元素将被置为nul1,其它数组元素保持原值,因此最好将方法入参数组大小定义与集合元素 个数一致 5.【强制】使用工具类 Arrays. asListo把数组转换成集合时,不能使用其修改集合相关的方法, 它的add/ remove/ clear方法会抛出 UnsupportedoperationException异常。 说明: aslist的返回对象是一个 Arrays内部类,并没有实现集合的修改方法。 Arrays. aslist 体现的是适配器模式,只是转换接口,后台的数据仍是数组。 Stringl str= new String[[a,b"j List list- Arrays. asList(str) 第一种情况:1ist.add("c");运行时异常。 第二种情况:str[0]=" guJin";那么list.get(0)也会随之修改。 6.【强制】泛型通配符<? extends t>来接收返回的数据,此写法的泛型集合不能使用add方法 说明:苹果装箱后返回一个<? extends fruits>对象,此对象就不能往里加任何水果,包括苹 果 7.【强制】不要在 Toreach循环里进行元素的 remove/ad操作。 remove元素请使用 Iterator 方式,如果并发操作,需要对 Iterator对象加锁 反例: List<String> a- new ArrayList<String)O) a.add("1") a.add("2") for (String temp: a) f(l" equals(temp))i a remove(temp) 说明:这个例子的执行结果会出乎大家的意料,那么试一下把“1”换成“2”,会是同样的结 果吗? 正例 Iterator<String> it- a iterator o) while(it. hasNext o) String temp= it. nexto f(删除元素的条件){ it remove o 10/32

...展开详情
试读 32P 阿里Java开发规约— 业界公开版.pdf
立即下载 低至0.43元/次 身份认证VIP会员低至7折
一个资源只可评论一次,评论内容不能少于5个字
yanyouning 正品,点赞
2017-02-04
回复
  • GitHub

    绑定GitHub第三方账户获取
关注 私信 TA的资源
上传资源赚积分,得勋章
最新推荐
阿里Java开发规约— 业界公开版.pdf 49积分/C币 立即下载
1/32
阿里Java开发规约— 业界公开版.pdf第1页
阿里Java开发规约— 业界公开版.pdf第2页
阿里Java开发规约— 业界公开版.pdf第3页
阿里Java开发规约— 业界公开版.pdf第4页
阿里Java开发规约— 业界公开版.pdf第5页
阿里Java开发规约— 业界公开版.pdf第6页
阿里Java开发规约— 业界公开版.pdf第7页

试读结束, 可继续读3页

49积分/C币 立即下载 >