Java开发规范-编程规范之OOP规约

Java编程规约（OOP规约）

内容源自阿里巴巴Java开发手册（华山版）

• 【强制】 避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用"类名."形式来访问即可。
• 【强制】 所有的覆写方法，必须加@Override注解。
• 【强制】 相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。（提倡尽量不用可变参数编程）
• 【强制】 外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。
• 【强制】 不能使用过时的类或方法。
• 【强制】 Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals()。
• 【强制】 所有整型包装类对象之间值的比较，全部使用equals方法比较。
  • 【说明】对于Integer var = ? 在-128至127范围内的赋值，Integer对象是在 IntegerCache.cache产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。
• 【强制】 浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用equals来判断。
  • 【说明】浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小。
  • 【正例】浮点数使用应BigDecimal类进行运算。
• 【强制】 定义数据对象DO类时，属性类型须与数据库字段类型相匹配。
• 【强制】 为了防止精度损失，禁止使用构造方法BigDecimal(double)的方式把double值转化为BigDecimal对象。
  • 【说明】BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。如：BigDecimal g = new BigDecimal(0.1f); 实际的存储值为：0.10000000149
  • 【正例】优先推荐入参为String的构造方法，或使用BigDecimal的valueOf方法，此方法内部其实执行了Double的toString，而Double的toString按double的实际能表达的精度对尾数进行了截断。
• 【强制】 所有的POJO类属性必须使用包装数据类型。
• 【强制】 RPC方法的返回值和参数必须使用包装数据类型。
• 【强制】 所有的局部变量使用基本数据类型。
• 【强制】 定义DO/DTO/VO等POJO类时，不要为任何属性设置默认值。
• 【强制】 序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，再修改serialVersionUID值。
• 【强制】 构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。
• 【强制】 POJO类必须写toString方法。使用IDE中的工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。
• 【强制】 禁止在POJO类中，同时存在对应属性xxx的isXxx()和getXxx()方法。
  • 【说明】框架在调用属性xxx的提取方法时，并不能确定哪个方法一定是被优先调用到。
• 【推荐】 使用索引访问用String通过split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。
• 【推荐】 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于下一条。
• 【推荐】 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter 方法。
• 【推荐】 setter方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在getter/setter方法中，不要增加业务逻辑，否则会增加排查问题的难度。
• 【推荐】 循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展。不要使用string和+连接符（造成内存资源浪费）。
• 【推荐】 final可以声明类、成员变量、方法、以及本地变量，下列情况使用final关键字：
  1. 不允许被继承的类，如：String类。
  2. 不允许修改引用的域对象。
  3. 不允许被覆写的方法，如：POJO类的setter方法。
  4. 不允许运行过程中重新赋值的局部变量。
  5. 避免上下文重复使用一个变量，使用final可以强制重新定义一个变量，方便更好地进行重构。
• 【推荐】 慎用Object的clone方法来拷贝对象（默认为浅拷贝）。
• 【推荐】 类成员与方法访问控制从严：
  1. 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
  2. 工具类不允许有public或default构造方法。
  3. 类非static成员变量并且与子类共享，必须是protected。
  4. 类非static成员变量并且仅在本类使用，必须是private。
  5. 类static成员变量如果仅在本类使用，必须是private。
  6. 若是static成员变量，考虑是否为final。
  7. 类成员方法只供类内部调用，必须是private。
  8. 类成员方法只对继承类公开，那么限制为protected。
  • 【说明】任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。可用范围越小，耦合性越小。