阿里Java开发手册：提升协作效率，保障软件质量

需积分: 0 70 浏览量更新于2024-07-15 1 收藏 1.52MB PDF 举报

《阿里巴巴-Java开发手册(泰山版).pdf》是一本由阿里巴巴集团技术团队精心编撰的Java开发指南，它集结了该团队多年的技术积累和实践经验，旨在帮助开发者提升编程质量和效率。手册针对Java开发者的实际需求，从以下几个关键维度进行了系统性的讲解： 1. 编程规约：强调命名风格的重要性，包括变量、方法和类的命名规则，以便于代码的可读性和维护性。这部分涵盖了常量定义，如使用全大写或下划线表示常量，以及代码格式规范，如缩进、空格和注释的使用。 2. 异常日志：指导开发者如何有效地记录和处理程序运行中的异常，确保软件的健壮性和故障排查能力。 3. 单元测试：提倡编写单元测试以验证代码的正确性，减少错误并提高软件质量。 4. 安全规约：提供关于代码安全的最佳实践，防止常见的安全漏洞，如未授权访问和数据泄露。 5. MySQL数据库：涉及数据库设计和优化，强调表结构和索引设计对系统性能的影响，确保数据的高效存储和查询。 6. 工程结构：强调项目结构的清晰度，如何组织代码模块，便于团队协作和后期维护。 7. 设计规约：涵盖面向对象设计原则、设计模式等内容，帮助开发者创建可扩展和易于理解的软件架构。 8. 规约分类：手册中的规约按照约束力和故障敏感性分为强制、推荐和参考三大类，引导开发者区分不同级别的最佳实践。手册还配套了IDE插件和详细图书《码出高效》，这些工具和资源进一步强化了学习效果，将理论知识与阿里巴巴的实际项目经验和底层源码解析相结合，使得读者能在实践中不断精进。此外，所有书籍收入均用于公益事业，体现了阿里巴巴的技术情怀，希望通过这种方式回馈社会，帮助更多人。《阿里巴巴-Java开发手册(泰山版).pdf》不仅是一本技术手册，更是一份全面的开发者指南，它鼓励开发者遵循规范，提高编程素养，同时注重团队协作和软件质量，是每一个Java开发者提升自身能力的宝贵资源。

Java 开发手册

8/57

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

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

来判断。

说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进

制无法精确表示大部分的十进制小数，具体原理参考《码出高效》。

反例：

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)) {

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

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

}

正例：

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

float a = 1.0f - 0.9f;

float b = 0.9f - 0.8f;

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);

if (x.equals(y)) {

System.out.println("true");

}

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

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

反例：某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来

越大，超过 Integer 的表示范围而溢出成为负数。

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

说明：BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。

Java 开发手册

9/57

如：BigDecimal g = new BigDecimal(0.1f); 实际的存储值为：0.10000000149

正例：优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，此方法内部其实执行了

Double 的 toString，而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。

BigDecimal recommend1 = new BigDecimal("0.1");

BigDecimal recommend2 = 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. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便

于阅读，此条规则优先于下一条。

Java 开发手册

10/57

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。

剩余60页未读，继续阅读

码农架构

粉丝: 1w+
资源: 76

阿里Java开发手册：提升协作效率，保障软件质量

阿里Java开发手册【泰山版】.pdf

JAVA开发手册（泰山版）.zip

Java开发手册泰山版.pdf.zip

阿里巴巴Java开发手册泰山版.pdf

阿里巴巴-Java开发手册(嵩山版) .pdf

阿里巴巴-Java开发手册 (2020嵩山版).pdf

阿里Java开发手册泰山版.pdf

阿里巴巴Java开发手册--2021.pdf.zip

Java开发手册泰山版.pdf

阿里巴巴Java开发手册v1.3.1.pdf

最新资源