阿里java开发手册阅读- 编程规约[OOP规约]

编程规约
（四）OOP规约（面向对象）

1. 【强制项目】不要使用类的对象引用来访问这个类的静态变量或者静态方法。直接使用类名访问。
2. 【强制项目】复写方法都加@Override注解，@Override注解可以判断是否覆盖成功。
3. 【强制项目】相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。另外可变参数必须放在参数列表最后。
4. 【强制项目】外部调用二方库接口库，不允许修改方法签名，避免对接口调用方产生影响，接口过时必须加上@Deprecated注解，（方法名称+参数列表，就是方法签名）
5. 【强制项目】不能使用过时的类或方法
6. 【强制项目】Object的equals方法容易抛出空指针异常，应使用常量或确定有值的对象来调用equals
7. 【强制项目】所有整型包装类对象之间的值比较，全部使用equals方法比较 -128到127之间可以使用==对比，但是不是这个范围的并不会复用已有对象所以使用equals来进行判断。
8. 【强制项目】浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用equals 来判断。

(1) 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。
 float a = 1.0f - 0.9f;
 float b = 0.9f - 0.8f;
 float diff = 1e-6f;
 if (Math.abs(a - b) < diff) {
 System.out.println("true");
 }
(2) 使用 BigDecimal 来定义值，再进行浮点数的运算操作。
 BigDecimal a = new BigDecimal("1.0");
 BigDecimal b = new BigDecimal("0.9");
 BigDecimal c = new BigDecimal("0.8");
 BigDecimal x = a.subtract(b);
 BigDecimal y = b.subtract(c);
 if (x.equals(y)) {
 System.out.println("true");
 }

9. 【强制项目】定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。
   正例：数据库字段的 bigint 必须与类属性的 Long 类型相对应。
   反例：某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来
   越大，超过 Integer 的表示范围而溢出成为负数

10. 【强制项目】为了防止精度损失，禁止使用构造方法BigDecimal（double）的方式将值转换成BigDecimal对象
    使用BigDecimal的valueOf的方法进行double转换BigDecimal

11. 关于基本数据类型与包装数据类型的使用标准如下
    1）强制）所有的pojo类属性都必须使用包装数据类型
    2）强制）RPC方法的返回值和参数都必须使用包装数据类型。
    3）推荐）所有的局部变量使用基本数据类型
    数据库有null因为自动拆箱，用基本数据类型有NPE空指针风险

12. 【强制项目】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
    反例：POJO 类的 createTime 默认值为 new Date()，但是这个属性在数据提取时并没有置入具体值，在
    更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

13. 【强制项目】序列化类新增属时，请不要修改serialVersionUID字段，避免反序列化失败；
    如果完全不兼容升级，避免反序列混乱，请修改serialVersionUID
    serialVersioinUID不一致抛出序列化运行时异常。

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

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

16. 【强制项目】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。

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

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

18. 【推荐项目】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，
    便于阅读，此条规则优先于下一条

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

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

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

22. 【推荐项目】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：
    1） 不允许被继承的类，如：String 类。
    2） 不允许修改引用的域对象。
    3） 不允许被覆写的方法，如：POJO 类的 setter 方法。
    4） 不允许运行过程中重新赋值的局部变量。
    5） 避免上下文重复使用一个变量，使用 final 可以强制重新定义一个变量，方便更好地进行重构

23. 【推荐项目】慎用 Object 的 clone 方法来拷贝对象，对象 clone 方法默认是浅拷贝，若想实现深拷贝需覆写 clone 方法实现域对象的深度遍历式拷贝。

24. 【推荐项目】类成员与方法访问控制从严：
    1） 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。
    2） 工具类不允许有 public 或 default 构造方法。
    3） 类非 static 成员变量并且与子类共享，必须是 protected。
    4） 类非 static 成员变量并且仅在本类使用，必须是 private。
    5） 类 static 成员变量如果仅在本类使用，必须是 private。
    6） 若是 static 成员变量，考虑是否为 final。
    7） 类成员方法只供类内部调用，必须是 private。
    8） 类成员方法只对继承类公开，那么限制为 protected