编程规约之OOP规约

【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成
本，直接用类名来访问即可。
【强制】所有的覆写方法，必须加@Override 注解。
【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。 说明:可变参数必须放置在参数列表的最后。( 倡同学们尽量不用可变参数编程)
正例:public User getUsers(String type, Integer… ids) {…}

---

【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。
正例:”test”.equals(object);
反例:object.equals(“test”);
说明:推荐使用 java.util.Objects#equals(JDK7 引入的工具类)
【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

---

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

---

【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
反例:POJO类的gmtCreate默认值为new Date();但是这个属性在数据 取时并没有置入具 体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。
【强制】POJO 类必须写 toString 方法。使用 IDE 的中工具:source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。 说明:在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排 查问题。

---

【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败;如 果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。
说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。
【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

---

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

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

---

【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起， 便于阅读，此条规则优先于第 15 条规则。
【推荐】 类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。
【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在
getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。
【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字:
1) 不允许被继承的类，如:String 类。
2) 不允许修改引用的域对象，如:POJO 类的域变量。
3) 不允许被重写的方法，如:POJO 类的 setter 方法。
4) 不允许运行过程中重新赋值的局部变量。
5) 避免上下文重复使用一个变量，使用 final 述可以强制重新定义一个变量，方便更好 地进行重构。

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

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