阿里巴巴Java开发手册(第2版)-第1章(4)

简介: 本章是传统意义上的代码规范,包括变量命名、代码风格、控制语句、代码注释、前后端规约等基本的编程习惯,以及从高并发场景中提炼出来的集合处理技巧与并发多线程的注意事项。

1.4 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(StringencodeStr)已经过时,应该使用双参数decode (String source, String encode)。接口提供方既然明确是过时接口,那么有义务同时提供新的接口;作为调用方,有义务考证过时方法的新实现是什么。

6

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

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

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

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

(Object a, Object b)。

7

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

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

8

【强制】对于任何货币金额,均以最小货币单位且整型类型存储。

9

【强制】浮点数之间的等值判断,基本数据类型不能用==进行比较,包装数据类型不能用equals 方法判断。

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

反例:

float a = 1.0f - 0.9f;

float b = 0.9f - 0.8f;


if (a == b) {

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

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

}


Float x = Float.valueOf(a);

Float y = Float.valueOf(b);

if (x.equals(y)) {

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

    // 但事实上equalsx.equals(y)的结果为false

}

正例:

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

float a = 1.0f - 0.9f;

float b = 0.9f - 0.8f;

// 10 的−6 次方

float diff = 1e-6f;


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

    System.out.println("true");

}


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

BigDecimal a = new BigDecimal("1.0");

BigDecimal b = new BigDecimal("0.9");

BigDecimal c = new BigDecimal("0.8");


BigDecimal x = a.subtract(b);

BigDecimal y = b.subtract(c);

/**

* BigDecimal 的等值比较应使用 compareTo()方法,而不是 equals()方法。

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

* 而 compareTo()则会忽略精度。

**/

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

    System.out.println("true");

}

10

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

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

反例:数据库表id 字段定义类型bigint unsigned,实际类对象属性为Integer。随着id 越来越大,超过Integer 的表示范围而溢出成为负数, 此时数据库id 不支持存入负数抛出异常。

11

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

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

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

BigDecimal good1 = new BigDecimal("0.1");

BigDecimal good2 = BigDecimal.valueOf(0.1);

12

基本数据类型与包装数据类型的使用标准如下。

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

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

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

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

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

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

13

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

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

14

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

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

15

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

16

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

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

17

【强制】禁止在POJO 类中同时存在对应属性xxx 的isXxx()和getXxx()方法。

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

18

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

说明:

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

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

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

System.out.println(ary.length);

19

【推荐】当一个类有多个构造方法,或者多个同名方法时,这些方法应该按顺序放置在一起,便于阅读,此条规则优先于第条规则。

20

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

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

21

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

反例:

public Integer getData () {

      if (condition) {

          return this.data + 100;

      } else {

           return this.data - 100;

      }

}

22

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

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

反例:

String str = "start";

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

      str = str + "hello";

}

23

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

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

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

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

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

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

24

【推荐】慎用Object 的clone 方法拷贝对象。

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

25

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

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 的成员变量,那么删除时手心不得冒点汗吗?变量像自己的小孩儿,尽量让它在自己的视线内。变量作用域太大,如果任其无限制地到处跑,你会担心的。

相关文章
|
2月前
|
Java
Java开发实现图片URL地址检验,如何编码?
【10月更文挑战第14天】Java开发实现图片URL地址检验,如何编码?
79 4
|
15天前
|
Java API Maven
如何使用Java开发抖音API接口?
在数字化时代,社交媒体平台如抖音成为生活的重要部分。本文详细介绍了如何用Java开发抖音API接口,从创建开发者账号、申请API权限、准备开发环境,到编写代码、测试运行及注意事项,全面覆盖了整个开发流程。
58 10
|
2月前
|
监控 Java 测试技术
Java开发现在比较缺少什么工具?
【10月更文挑战第15天】Java开发现在比较缺少什么工具?
36 1
|
2月前
|
Java
Java开发实现图片地址检验,如果无法找到资源则使用默认图片,如何编码?
【10月更文挑战第14天】Java开发实现图片地址检验,如果无法找到资源则使用默认图片,如何编码?
62 2
|
22天前
|
SQL 安全 Java
安全问题已经成为软件开发中不可忽视的重要议题。对于使用Java语言开发的应用程序来说,安全性更是至关重要
在当今网络环境下,Java应用的安全性至关重要。本文深入探讨了Java安全编程的最佳实践,包括代码审查、输入验证、输出编码、访问控制和加密技术等,帮助开发者构建安全可靠的应用。通过掌握相关技术和工具,开发者可以有效防范安全威胁,确保应用的安全性。
44 4
|
23天前
|
缓存 监控 Java
如何运用JAVA开发API接口?
本文详细介绍了如何使用Java开发API接口,涵盖创建、实现、测试和部署接口的关键步骤。同时,讨论了接口的安全性设计和设计原则,帮助开发者构建高效、安全、易于维护的API接口。
57 4
|
1月前
|
开发框架 JavaScript 前端开发
HarmonyOS UI开发:掌握ArkUI(包括Java UI和JS UI)进行界面开发
【10月更文挑战第22天】随着科技发展,操作系统呈现多元化趋势。华为推出的HarmonyOS以其全场景、多设备特性备受关注。本文介绍HarmonyOS的UI开发框架ArkUI,探讨Java UI和JS UI两种开发方式。Java UI适合复杂界面开发,性能较高;JS UI适合快速开发简单界面,跨平台性好。掌握ArkUI可高效打造符合用户需求的界面。
91 8
|
29天前
|
SQL Java 程序员
倍增 Java 程序员的开发效率
应用计算困境:Java 作为主流开发语言,在数据处理方面存在复杂度高的问题,而 SQL 虽然简洁但受限于数据库架构。SPL(Structured Process Language)是一种纯 Java 开发的数据处理语言,结合了 Java 的架构灵活性和 SQL 的简洁性。SPL 提供简洁的语法、完善的计算能力、高效的 IDE、大数据支持、与 Java 应用无缝集成以及开放性和热切换特性,能够大幅提升开发效率和性能。
|
29天前
|
存储 Java 关系型数据库
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践,包括连接创建、分配、复用和释放等操作,并通过电商应用实例展示了如何选择合适的连接池库(如HikariCP)和配置参数,实现高效、稳定的数据库连接管理。
52 2
|
29天前
|
监控 Java 数据库连接
在Java开发中,数据库连接管理是关键问题之一
在Java开发中,数据库连接管理是关键问题之一。本文介绍了连接池技术如何通过预创建和管理数据库连接,提高数据库操作的性能和稳定性,减少资源消耗,并简化连接管理。通过示例代码展示了HikariCP连接池的实际应用。
20 1