编程规约之OOP规约

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

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

  说明：getObject（）与get0bject的问题。一个字母是o，一个数字是0，加@Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

3.【强制】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用object。

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

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

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

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

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

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

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

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

  3）【强制】所有的局部变量使用基本数据类型。

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

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

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

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

12.【强制】POJO类必须写toString方法。使用IDE的工具：source>generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。

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

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

  说明

String str = "a,b,c,,";
String[] ary = str.split(",");
//预期大于3，结果是3
System.out.println(ary.length);

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

15.【推荐】类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。

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

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

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

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

  1）不允许被继承的类，如：String类

  2）不允许修改引用的域对象，如：POJO类的域变量

  3）不允许被重写的方法，如：POJO类的setter方法

  4）不允许运行过程中重新被赋值的局部变量

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

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

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

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

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

  2）工具类不允许有public或default构造方法。

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

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

  5）类static成员变量如果仅在本类中使用，必须是private。

  6）若是static成员变量，必须考虑是否为final。

  7）类成员方法只供类内部调用，必须是private。

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