阿里巴巴Java开发手册学习-OOP规约

OOP规约

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

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

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

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

    说明：可变参数必须防止在参数列表的最后。（提倡同学们尽量不用可变参数编程）

    正例：public User getUsers(String type,Integer... ids){...}

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

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

    说明：java.net.URLDecoder中的方法decode(String encodeStr)这个方法已经过时，应该使用双参数decode(String     source,String encode)。接口提供方法既然明确是过时接口，那么有义务同时提供新的接口：作为调用方来说，有    义务去考证过时方法的新实现是什么。

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

    正例：“test”.equals(object);

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

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

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

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

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

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

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

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

    说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行复制，任何NPE问题，或者入库检查，都由使用者来保证。

    正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。

    反例：比如显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的RPC服务，调用不成功时，返回的是默认值，页面显示为0%，这是不合理的，应该显示成中划线。所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

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

    反例：POJO类的gmtCreate默认值为new Date()；但是这个属性在数据提取时并没有置入具体值，在更新其他字段时又附带更新了此字段，导致创建时间被修改成当前时间。

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

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