《阿里巴巴Java开发手册》1-4之OOP规约

编程规约 - OOP规约

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

  2. 【强制】所有的覆写方法,必须加@ Override 注解。
    反例: getObject()get 0 bject() 的问题。一个是字母的 O ,一个是数字的 0,加@ Override
    可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编
    译报错。

  3. 【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object 。
    说明:可变参数必须放置在参数列表的最后。 ( 提倡同学们尽量不用可变参数编程 )
    正例:

    1
    public User getUsers(String type, Integer... ids)
  1. 【强制】对外暴露的接口签名,原则上不允许修改方法签名,避免对接口调用方产生影响。接
    口过时必须加@ Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。

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

  3. 【强制】 Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用
    equals 。
    正例:

    1
    " test " .equals(object);

    反例:

    1
    object.equals( " test " );

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

  4. 【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。
    说明:对于 Integer var =? 在-128 至 127 之间的赋值, Integer 对象是在
    IntegerCache . cache 产生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行
    判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑,
    推荐使用 equals 方法进行判断。

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

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

  7. 【强制】序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败 ; 如
    果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。
    说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

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

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

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

1
2
3
4
String str = "a,b,c,,";
String[] ary = str.split(",");
//预期大于 3,结果是 3
System.out.println(ary.length);
  1. 【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,
    便于阅读。

  2. 【推荐】 类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter / setter
    方法。
    说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好 ; 保护方法虽然只是子类
    关心,也可能是“模板设计模式”下的核心方法 ; 而私有方法外部一般不需要特别关心,是一个
    黑盒实现 ; 因为方法信息价值较低,所有 Service 和 DAO 的 getter / setter 方法放在类体最
    后。

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

1
2
3
4
5
6
7
public Integer getData(){
if(true) {
return data + 100;
} else {
return data - 100;
}
}
  1. 【推荐】循环体内,字符串的联接方式,使用 StringBuilder 的 append 方法进行扩展。
    反例:
1
2
3
4
5
String str = "start";
for(int i=0; i<100; i++){
str = str + "hello";
}

说明:反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行
append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。

  1. 【推荐】 final 可提高程序响应效率,声明成 final 的情况:
    1 ) 不需要重新赋值的变量,包括类属性、局部变量。
    2 ) 对象参数前加 final ,表示不允许修改引用的指向。
    3 ) 类方法确定不允许被重写。

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

  3. 【推荐】类成员与方法访问控制从严:
    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 的成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视
    线内,变量作用域太大,如果无限制的到处跑,那么你会担心的。

以上内容均整理自《阿里巴巴Java开发手册》

下载

提供Gitbook在线阅读和pdf下载:查看福利

谢谢大爷~

  • 微信打赏二维码

    微信

  • 支付宝打赏二维码

    支付宝



目录
  1. 1. 编程规约 - OOP规约
  2. 2. 下载
本站访问量   |   您是第 位.