阿里开发手册 嵩山版-编程规约 (四)OOP规约-Java程序员必看知识点!!!

2024-01-02 11:32:59

历史版本

前言

《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,经历了多次大规模一线实战的检验及不断完善,公开到业界后,众多社区开发者踊跃参与,共同打磨完善,系统化地整理成册,当前的版本是嵩山版。现代软件行业的高速发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点也会影响到软件的最终交付质量。比如:五花八门的错误码人为地增加排查问题的难度;数据库的表结构和索引设计缺陷带来的系统架构缺陷或性能风险;工程结构混乱导致后续项目维护艰难;没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以 Java 开发者为中心视角,划分为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度,再根据内容特征,细分成若干二级子目录。

另外,依据约束力强弱及故障敏感性,规约依次分为【强制】【推荐】【参考】三大类。在延伸信息中,说明对规约做了适当扩展和解释;“正例”提倡什么样的编码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案例。

手册的愿景是码出高效,码出质量。现代软件架构的复杂性需要协同开发完成,如何高效地协 同呢?无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,没有红绿灯,谁还敢上路行驶?对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,提升协作效率,降低沟通成本。代码的字里行间流淌的是软件系统的血液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升系统稳定性,码出质量。

我们已经在 2017 杭州云栖大会上发布了配套的 Java 开发规约 IDE 插件,下载量达到 162 万人次,阿里云效也集成了代码规约扫描引擎。次年,发布 36 万字的配套详解图书《码出高效》,本书秉持“图胜于表,表胜于言”的理念,深入浅出地将计算机基础、面向对象思想、JVM 探源、数据结构与集合、并发与多线程、单元测试等知识客观、立体地呈现出来。紧扣学以致用、学以精进的目标,结合阿里巴巴实践经验和故障案例,与底层源码解析融会贯通,娓娓道来。《码出高效》和《Java开发手册》稿费所得收入均捐赠公益事情,希望用技术情怀帮助更多的人。

💡

一、编程规约

(四) OOP(面向对象) 规约

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

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

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

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

说明:可变参数必须放置在参数列表的最后。(建议开发者尽量不用可变参数编程)

正例:public List<User> listUsers(String type, Long... 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");

说明:推荐使用 JDK7 引入的工具类 java.util.Objects#equals(Object a, Object b)

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

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

8.【强制】任何货币金额,均以最小货币单位且整型类型来进行存储。

9.【强制】浮点数之间的等值判断,基本数据类型不能用==来比较,包装数据类型不能用 equals 来判断!

说明:浮点数采用“尾数+阶码”的编码方式,类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数,具体原理参考《码出高效》

反例:

floata=1.0F-0.9F;

floatb=0.9F-0.8F;

if(a==b) {

// 预期进入此代码块,执行其它业务逻辑

// 但事实上 a==b 的结果为 false

}

Float x=Float.valueOf(a);

Float y=Float.valueOf(b);

if(x.equals(y)) {

// 预期进入此代码块,执行其它业务逻辑

// 但事实上 equals 的结果为 false

}

正例:

(1) 指定一个误差范围,两个浮点数的差值在此范围之内,则认为是相等的。

floata=1.0F-0.9F;

floatb=0.9F-0.8F;

floatdiff=1e-6F;

if(Math.abs(a-b)<diff) {

System.out.println("true");

}

(2) 使用BigDecimal 来定义值,再进行浮点数的运算操作。

BigDecimal a=newBigDecimal("1.0");

BigDecimal b=newBigDecimal("0.9");

BigDecimal c=newBigDecimal("0.8");

BigDecimal x=a.subtract(b);

BigDecimal y=b.subtract(c);

if(x.compareTo(y) == 0) {

System.out.println("true");

}

10.【强制】如上所示BigDecimal 的等值比较应使用 compareTo()方法,而不是 equals()方法。

说明:equals()方法会比较值和精度(1.0 与 1.00 返回结果为 false),而compareTo()则会忽略精

11.【强制】定义数据对象 DO 类时,属性类型要与数据库字段类型相匹配

正例:数据库字段的bigint 必须与类属性的 Long类型相对应。

反例:某个案例的数据库表 id 字段定义类型 bigint unsigned,实际类对象属性为 Integer,随着 id 越来 越大,超过 Integer 的表示范围而溢出成为负数。

12.【强制】禁止使用构造方法 BigDecimal(double)的方式把double 值转化为BigDecimal 对象

说明:BigDecimal(double)存在精度损失风险,在精确计算或值比较的场景中可能会导致业务逻辑异常。如:BigDecimal g = new BigDecimal(0.1F); 实际的存储值为:0.10000000149

正例:优先推荐入参为 String 的构造方法,或使用BigDecimal 的 valueOf方法,此方法内部其实执行了Double 的 toString,而 Double 的 toString按 double 的实际能表达的精度对尾数进行了截断

BigDecimal recommend1=newBigDecimal("0.1");

BigDecimal recommend2=BigDecimal.valueOf(0.1);

13.关于基本数据类型与包装数据类型的使用标准如下:

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

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

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

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

正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE (空指针)风险

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

14.【强制】定义 DO/DTO/VO 等 POJO 类时,不要设定任何属性默认值

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

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

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

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

17.【强制】POJO 类必须写 toString方法。使用 IDE 中的工具:source> generate toString时,如果继承了另一个 POJO 类,注意在前面加一下super.toString。

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

18.【强制】禁止POJO类中,同时存在对应属性xxxisXxx()getXxx()方法

说明:框架在调用属性 xxx 的提取方法时,并不能确定哪个方法一定是被优先调用到的。

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

说明:

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

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

// 预期大于 3,结果是 3

System.out.println(ary.length);

20.【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起,便

于阅读,此条规则优先于下一条

21.【推荐】类内方法定义的顺序依次是:公有pub方法或保护pro方法 > 私有private方法 > getter / setter方法

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

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

反例:

publicInteger getData() {

if(condition) {

return this.data+100;

}else{

return this.data-100;

}

}

23.【推荐】循环体内,字符串的连接方式,使用StringBuilder 的 append方法进行扩展。

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

反例:

String str="start";

for(inti=0;i<100;i++) {

str=str+"hello";

}

24.【推荐】final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字:

1)不允许被继承的类,如:String 类。

2)不允许修改引用的域对象,如:POJO 类的域变量。

3)不允许被覆写的方法,如:POJO 类的 setter 方法。

4)不允许运行过程中重新赋值的局部变量。

5)避免上下文重复使用一个变量,使用 final 关键字可以强制重新定义一个变量,方便更好地进行重构

25.【推荐】Object 的 clone 方法来拷贝对象。

说明:对象 clone 方法默认是浅拷贝,若想实现深拷贝,需覆写 clone 方法实现域对象的深度遍历式拷贝

26.【推荐】类成员与方法访问控制从严

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成员方法或成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,无限制的到处跑,那么你会担心的。

文章来源:https://blog.csdn.net/m0_67184231/article/details/135333682
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。