阿里巴巴Java开发手册（开发规范）——编程规约笔记

2.常量规约

【推荐】如果变量值仅在一个范围内变化用Enum类。

如果还带有名称之外的延伸属性，必须使用Enum类，

下面正例中的数字就是延伸信息，表示星期几。

正例：

public Enum{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}

3.格式规约

IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用windows格式。

4.OOP规约

【强制】对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }
span.s2 { font: 11.5px Courier }

【强制】所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。 说明：对于Integer var=?在-128至127之间的赋值，Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 11.5px Courier }
span.s2 { font: 10.5px SimSun }
span.s3 { font: 10.5px Courier }

【强制】关于基本数据类型与包装数据类型的使用标准如下： 1） 所有的POJO类属性必须使用包装数据类型。 2） RPC方法的返回值和参数必须使用包装数据类型。 3） 所有的局部变量【推荐】使用基本数据类型。 说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。 正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。 反例：比如显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的RPC服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划线-。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

【强制】定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }
span.s2 { font: 10.5px SimSun }

【强制】序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。 说明：注意serialVersionUID不一致会抛出序列化运行时异常。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }

构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }
span.s2 { font: 11.5px Courier }

【强制】POJO类必须写toString方法。使用IDE的中工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。 说明：在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
p.p3 { margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Courier }
p.p4 { margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px SimSun }
span.s1 { font: 10.5px Courier }
span.s2 { font: 9.0px Courier }

【推荐】使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。

说明：

String str = "a,b,c,,";

String[] ary = str.split(",");

//预期大于3，结果是3

System.out.println(ary.length);

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Courier; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }
span.s2 { font: 11.5px Courier }

setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/setter方法中，尽量不要增加业务逻辑，增加排查问题的难度。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }
span.s2 { font: 11.5px Courier }
span.s3 { font: 10.5px SimSun }

【推荐】final可提高程序响应效率，声明成final的情况： 1） 不需要重新赋值的变量，包括类属性、局部变量。 2） 对象参数前加final，表示不允许修改引用的指向。 3） 类方法确定不允许被重写。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }

【推荐】慎用Object的clone方法来拷贝对象。 说明：对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现属性对象的拷贝。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 11.5px Courier }
span.s2 { font: 10.5px SimSun }
span.s3 { font: 10.5px Courier }

【推荐】类成员与方法访问控制从严： 1） 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。 2） 工具类不允许有public或default构造方法。 3） 类非static成员变量并且与子类共享，必须是protected。 4） 类非static成员变量并且仅在本类使用，必须是private。 5） 类static成员变量如果仅在本类使用，必须是private。 6） 若是static成员变量，必须考虑是否为final。 7） 类成员方法只供类内部调用，必须是private。 8） 类成员方法只对继承类公开，那么限制为protected。 说明：任何类、方法、参数、变量，严控访问范围。过宽泛的访问范围，不利于模块解耦。思考：如果是一个private的方法，想删除就删除，可是一个public的Service方法，或者一个public的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，如果无限制的到处跑，那么你会担心的。

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 10.5px Courier }
span.s1 { font: 11.5px SimSun }
span.s2 { font: 11.5px Courier }
p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Courier; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 10.5px Courier }
span.s1 { font: 11.5px SimSun }
span.s2 { font: 11.5px Courier }
p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }
p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px SimSun; min-height: 14.0px }
p.p2 { margin: 0.0px 0.0px 0.0px 0.0px; font: 11.5px SimSun }
span.s1 { font: 10.5px Courier }
span.s2 { font: 11.5px Courier }