java 开发规约_Java开发代码规范之编程规约（四）——OOP规约

文章通过学习《阿里巴巴Java开发手册》整理。

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

2.所有的覆写方法，必须加@ Override注解。

3.相同参数类型，相同业务含义，才可以使用java的可变参数，避免使用Object。

4.不能使用过时的类或方法。

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

正例："test".equals(object);

反例：object.equals("test");

说明：推荐使用java.util.Objects#equals(jdk7引入的工具类)

6.所有的相同类型的包装类对象之间值的比较，全部用equals方法比较。

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

1)所有的POJO类属性必须使用包装数据类型；

2)RPC方法的返回值和参数必须使用包装数据类型；

3)所有的局部变量使用基本数据类型。

8.定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。

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

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

11.POJO类必须写toString方法。如果继承了另一个POJO类，注意在前面加super.toString。

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

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

String str = "a,b,c,,";

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

//预期大于3，结果为3

System.out.println(ary.length);

13.当一个类有多个构造方法或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。

14.类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。

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

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

17.final可以声明类、成员变量、方法、以及本地变量，下列情况使用final关键字：

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

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

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

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

18.慎用Object的clone方法来拷贝对象。

19.类成员与方法访问控制从严：

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

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

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

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

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

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

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

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

说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。

思考：如果是一个private的方法，想删除就删除，可是一个public的service方法，或者一个public的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。