01_编程规约——OOP规约

1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，避免增加编译器解析成本，直接用“类名.变量名”访问即可。

2.【强制】所有的覆盖方法，必须加@Override注解

说明：加@Override可以准确判断是否覆盖成功，另外如果在抽象类中对方法签名进行修改，对应的实现类会马上报编译错误。

3.【强制】相同的参数类型，相同业务含义，才可以使用Java的可变参数（Integer... ids），避免使用Object。（注意：尽量不要用可变参数编程）

说明：可变参数必须放在参数列表的最后。

非得使用的话，例子：public User getUsers(String type, Integer... ids){...}

4.【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。

5.【强制】不能使用过时的类和方法。

6.【强制】Object的equals方法容易抛空指针异常，应该使用常量或者确定有值的对象来调用equals方法。

正例："test".equals(object)

反例：object.equals("test")

说明：推荐使用java.util.Objects#equals

7.【强制】所有的相同类型的包装类对象之间的值比较，全部使用equals方法比较。

说明：对于Integer var= ? 在-128至127范围内的赋值，Integer对象是在IntegerCache.cache产生， 产生，会复用已有对象，在这个区间的值可以直接使用==进行判断，但是这个区间之外的数据，都会在堆上产生，并不会复用已有对象，是一个大坑，推荐使用equals方法进行判断。

8.关于数据基本类型与包装数据类型的使用标准如下：

　　8.1【强制】所有的POJO类属性必须使用包装数据类型。

　　8.2【强制】RPC方法的返回值和参数必须使用包装数据类型。

　　8.3【推荐】所有的局部变量使用基本数据类型。

说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收会有NPE风险。

反例：比如成交总额的涨跌情况，即为±x%，x为基本数据类型，在调用RPC服务，调用不成功时，返回的是默认值，页面显示为±0%，这是不合理的，应该显示成中划线-，所以包装数据类型的null值，能够表示额外的信息，如远程调用失败，异常退出。

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

反例：POJO类的gmtCreate默认值为new Date()，但是这个属性在数据提取时并没有置入具体值，在更新其他字段时又附带更新了此字段，导致创建时间被修改成当前时间。

10.【强制】序列化类新增属性时，不要修改serialVersionUID字段，避免反序列化失败：如果完全不兼容升级，避免反序列化混乱，那么修改serialVersionUID值。

说明：注意serialVersionUID不一致会抛出序列化运行时异常。

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

12.【推荐】POJO类必须写toString()方法。

如果继承了另一个POJO类时，注意在前面加一下super.toString()。

说明：在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。

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

说明：String str = "a,b,c,,";

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

　　System.out.println(ary.length); //预期是大于3，但是结果是3。

14.【推荐】当一个类由多个构造方法，或者多个同名方法，这些方法应该按顺序放在一块，便于阅读。（此规则优先于第15条规则）

15.【推荐】类内方法的定义的放置顺序依次是：public/protected方法>private方法>getter/setter方法。

说明：public方法是类的调用者和维护者最关心的方法，首屏展示最好。

protected方法虽然只是子类关心，但是也有可能是“模板设计模式”下的核心方法。

private方法外部一般不需要特别关心，是一个黑盒实现。

16.【推荐】setter方法中，参数名称与类成员变量名称保持一致，this.成员变量=参数名。

在getter/setter方法中，尽量不要增加业务逻辑，增加排查问题的难度。

17.【推荐】循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展。

说明：反编译出的字节码文件显示使用String时，每次循环都会new出一个新的StringBuilder对象，然后进行append操作，最后toString方法会返回String对象，造成内存资源的浪费。

反例：

String str = "start";

for(int i=0;i<100;i++){

　　str = str + "hello";

}

18.【推荐】final可以声明类，成员变量，方法，以及本地变量，下列情况使用final关键字：

　　18.1 不允被继承的类，如String类。

　　18.2 不允许修改引用的域对象，如POJO类的域对象。

　　18.3 不允许被重写的方法，如POJO类的setter方法。

　　18.4 不允许运行过程汇总重新赋值的局部变量。

　　18.5 避免上下文重复使用一个一个变量，使用final描述可以强制重新定义一个变量，方便更好地进行重构。

19.【推荐】谨慎使用Object的clone方法来拷贝对象。

说明：对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法数显属性对象的拷贝。

20.【推荐】类成员变量与方法访问控制从严：

　　20.1 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。

　　20.2 工具类不允许有public或default构造方法（工具类一般所有方法都是静态方法）。

　　20.3 类非static 成员变量并且与子类共享，必须是protected。

　　20.4 类非static成员变量并且仅在本类使用，必须是private

　　20.5 类static 成员变量如果尽在本类使用，必须是private

　　20.6 若是static成员变量，必须考虑是否为final

　　20.7 类成员方法只供类内部使用，必须是private

　　20.8 类成员方法只对继承公开，那么限制为protected