阿里java手册
一些命名、规范等，一些命名、规范等，一些命名、规范等，一些命名、规范等，阿里巴巴JAVA开发手册2)【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是-able的形式)。正例: Abstracttranslator实现 Translatable14.【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开说眀:枚举其实就是特殊的常量类,且构造方法被默认强制是私有正例:枚举名字: Dealstatus enum;成员名称: SUCCESS/ UNKOW REASON。15.【参考】各层命名规约:A) Service/DAO层方法命名规约1)获取单个对象的方法用get做前缀。2)获取多个对象的方法用1ist做前缀。3)获取统计值的方法用 count做前缀。1)插入的方法用save(推荐)或 insert做前缀5)删除的方法用 remove(推荐)或 delete做前缀。6)修改的方法用 update做前缀。B)领域模型命名规约1)数据对象: XXXDO,xxx即为数据表名。2)数据传输对象: XXXDT0,xx为业务领域相关的名称。3)展小对象:xxV0,xxx一般为网页名称。4)POJ0是DO/DTO/BOVO的统称,禁止命名成 XXXPOJO(二)常量定义1.【强制】不允许出现任何魔法值(即未绐定义的常量)直接出现在代码中。反例: String key=Id# taobao"+ tradedcache put(key, value2.【强制】long或者Long初始赋值时,必须使用大写的L,不能是小写的1,小写容易跟数字1混淆,造成误解说明: Long a-21;写的是数字的21,还是Long型的2?3.【推荐】不要使用一个常量类维护所有常量,应该按常量功能进行归类,分开维护。如:缓存相关的常量放在类: CacheConsts下;系统配置相关的常量放在类: Configconsts下。说明:大而全的常量类,非得ctr14f才定位到修改的常量,不利于理解,也不利于维扩3/32阿里巴巴JAVA开发手册4.【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共亨常量、类内共亨常量1)跨应用共享常量:放置在二方库中,通常是 client.jar中的 const日录下。2)应用內共享常量:放置在一方库的 modules中的 const目录下反例:易懂变量也要统·定义成应用内共享常量,两位攻城师在两个类中分别定义了表是”的变量类A中: public static final String YES="yes";类B中: public static final String YESA.YES. equals(B.YES),预期是true,但实际返回为 False,导致产生线上问题3)子工程内部共享常量:即在当前子工程的 cons t目录下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);(三)格式规约1.【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成即可,不需要换行;如果是非空代码块则1)左大括号前不换行。2)左大括号后换行。3)右大括号前换行。4)右大括号后还有else等代码则不换行;表小终止右大括号后必须换行。2.【强制】左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空格。详见第5条下方正例提示3.【强制】if/for/ while/ switch/do等保留字与左右括号之间都必须加空格。4.【强制】任何运算符左右必须加一个空格说明:运算符包括赋值运算符=、逻辑运算符&、加减乘除符号、三目运行符等。5.【强制】代码块缩进4个空格,如果使用tab缩进,请设置成1个tab为4个空格正例:(涉及15点)4/32阿里巴巴JAVA开发手册public static void main(String args[])//缩进4个空格String say -hello//运算符的左右必须有一个空格int fl//关键词if与括号之间必须有一个空格,括号内f与左括号,1与右括号不需要空格if (flaIt println(say)//左大括号前加空格且不换行;左大括号后换行(flag -- 1)System. out. println( world")//右大括号前换行,右大括号后有else,不用换行ut, print lp//右大括号做为结束,必须换行6.【强制】单行字符数限制不超过120个,超出需要换行,换行时,遵循如下原则:1)换行吋相对上·行缩进4个空格。2)运算符与下文一起换行。3)方法调用的点符号与下文一起换行4)在多个参数超长,逗号后进行换行5)在括号前不要换行,见反例正例StringBuffer sb- new StringBuffer O/超过120个字符的情况下,换行缩进4个空格,并且方法前的点符号一起换行sb. append( zi"). append(" xin").append( huang反例StringBuffer sb= new StringBuffer O//超过120个字符的情况下,不要在活号前换行sb. append(zi ). append(xin)-append(huang")/参数很多的方法调用也超过120个字符,逗号后才是换行处method (args, args2, args7.【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格正例:下例中实参的"a",后边必须要有一个空格。method(a,b,c)5/32阿里巴巴JAVA开发手册8.【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。正例:int a- 3ongfloat c-5FStringBuffer sb= new StringBuffer O说明:增加sb这个交量,如果需要对齐,则给a、b、c都要增加几个空格,在交量比较多的情况下,是·种累赘的事情9.【强制】IDE的 text file encoding设置为UTF-8;IDE中文件的换行符使用Unix格式,不要使用 windows格式。10.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。说明:没有必要插入多行空格进行隔开。(四)00P规约1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可2.【强制】所有的覆写方法,必须加@0 verride注解。反例: getObject(与 ge ject(的问题。一个是宇母的0,一个是数字的0,加0 override可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错3.【强制】相同参数类型,相同业务含义,才可以使用Java的可变参数,避免使用 Object说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)IE M] public User getUsers(String type, Integer.. ids4.【强制】对外暴露的接口签名,原则上不允许修改方法签名,避兔对接口调用方产生影响。接口过时必须加@ Deprecated注解,并清晰地说明采用的新接口或者新服务是什么。5.【强制】不能使用过时的类或方法。说明:java.net. URLDecoder中的方法 decode( String encodestr)这个方法已经过吋,应该使用双参数 decode( String source, String encode)。接口提供方既然明确是过时接口,那么有义务同时提供新的接口:作为调用方来说,有义务去考证过时方法的新实现是什么。6.【强制】 Object.的 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产生,会复用已有对象,这个区间内的 nteger值可以直接使用=进行判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,推荐使用 equals方法进行判断。8.【强制】关于基本数据类型与包装数据类型的使用标准如下:1)所有的POJ0类属性必须使用包装数据类型。2)RPC方法的返回值和参数必须使用包装数据类型3)所有的局部变量推荐使用基本数据类型。说明:POJ0类属性没有初值是提醒使用者在需要使用时,必须自口显式地进行赋值,任何NPE问题,或者入库检查,都出使用者来保证。正例:数据库的查询结果可能是nul1l,因为自动拆箱,用基本数据类型接收有NE风险。反例:某业务的交易报表上显示成交总额涨跌情况,即正负x%,ⅹ为基本数据类型,调用的RPC服务,调用不成功时,返回的是默认值,页面显示:0%,这是不合理的,应该显示成中划线。所以包装数据类型的null值,能够表示额外的信息,如:远程调用失败,异常退出9.【强制】定文D0/DT0/V0等POJ0类时,不要设定任何属性默认值反例:某业务的D0的 gmtCreate默认值为 new Date();但是这个属性在数据提取吋并没有置入具体值,在吏新其它字段时又附带更新了此字段,导致创建时间被修改成当前时间。10.【强制】序列化类新增属性时,请不要修改 serialversionuid字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改 serialversionuid值。说明:注意 serialversionulD不一致会抛出序列化运行时异常。11.【强制】构造方法里面禁止加入任何业务逻缉,如果有仞始化逻辑,请放在iit方法中12.【强制】POJ0类必须写 toString方法。使用工具类 source> generate tostring时,如果继承了另个POJ0类,注意在前面加下 super. tostring.说明:在方法执行抛出异常时,可以直接调用PJ0的 toString(方法打印其属性值,便于排查问题。13.【推荐】使用索引访问用 String的 split方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛 IndexOutOfBoundsException的风险7/32阿里巴巴JAVA开发手册说明String str -a, b,C,, String] ary -str split(",//预期大于3,结某是3System. out. printIn(ary. length)14.【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便于阅读。15.【推荐】类内方法定义顺序依次是:公有方法或保护方法>私有方法〉 getter/ setter方法。说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类关心,也可能是“模板设计模式”下的核心方法;而私有方法外部一般不需要特別关心,是个黑盒实现;因为方法信息价值较低,所有 Service和DA0的 getter/ setter方法放在类体最16.【推荐】 setter方法中,参数名称与类成员变量名称一敛,this.成员名-参数名。在getter/ setter方法中,尽量不要增加业务逻辑,增加排查问题难度。反例public Integer get(if(true) Ireturn data 100e sereturn data-10017.【推荐】循环体内,字符串的联接方式,使用 StringBuilder的 append方法进行扩展、反例gfor int 1=0; i<100: i++istr str +hello说明:反编译出的字节码文件显示每次循环都会new出个 StringBuilder刈象,然后进行append操作,最后通过 tostring方法返回 String对象,造成内存资源浪费。18.【推荐】 final可提高程序响应效率,声明成 final的情况:1)不需要重新赋值的变量,包括类属性、局部变量。2)对象参数前加 final,表示不允许修改引用的指向。3)类方法桷定不允许被重写。19.【推荐】慎用 Object的 clone方法来拷贝对象说明:对象的 clone方法默认是浅拷叭,若想实现深拷以需要重写 clonc方法实现属性对象的拷贝8/32阿里巴巴JAVA开发手册20.【推荐】类成员与方法访问控制从严1)如果不允许外部直接通过new来创建对象,那么构造方法必须是 private。2)工具类不允许有 public或 default构造方法。3)类非 static成员变量并且与子类共享,必须是 protected4)类非 static成员变量并且仅在木类使用,必须是 private5)类 static成员变量如果仅在本类使用,必须是 private6)若是 static成员变量,必须考虑是否为 final。7)类成员方法只供类内部调用,必须是 private。8)类成员方法只对继承类公开,那么限制为 protected说眀:任何类、方法、参数、变量,严控访问范围。过宽泛的访问范围,不利于模块解耦。思考:如果是一个 private的方法,想删除就删除,可是一个 public的 Service方法,或者个 public的成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,如果无限制的到处跑,那么你会担心的。(五)集合处理1.【强制】Map/Set的key为自定义对象时,必须重写 hashCode和 equals。正例: String重写了 hashCode和 equals方法,所以我们可以非常愉快地使用 String对象作为key来使用2.【强制】 Arraylist的 sublist结果不可强转成 Arraylist,否则会抛出 Class CastExceptionFA: java util. RandomAccess SubList cannot be cast to java. util. ArrayList说明: sublist返回的是 Arraylist的内部类 Sublist,并个是 Arraylist,而是 Arraylist的一个视图,对于 Sublist子列表的所有操作最终会反映到原列表上。3.【强制】在 sublist场景中,高度注意对原集合元素个数的修改,会导致子列表的遍历、增加、删除均产生 ConcurrentModificationLxception异常。4.【强制】使用集合转数组的方法,必须使用集合的 toArray(T[] array),传入的是类型完全样的数组,大小就是list.size()。反例:直接使用 toarray无参方法存在问题,此方法返回值以能是0 b ject类,若强转其它类型数组将出现 Class CastException错误。正例:List
