阿里巴巴Java开发手册：代码规范提升开发质量

需积分: 0 35 浏览量更新于2024-06-15 收藏 4.59MB DOCX 举报

《Java开发手册-代码规范》是一本由阿里巴巴集团编写的实用指南，专为Java开发者设计，旨在提升代码质量和可维护性。该手册涵盖了以下几个核心主题： 1. 命名规范：详细规定了类名、方法名、变量名以及常量的命名规则，强调一致性，使代码易于理解和识别。例如，变量名应反映其用途，使用驼峰命名法或下划线分隔法，并避免使用过于通用的名称。 2. 代码风格：涵盖了编码风格，如正确的缩进、空格使用和换行标准，以及注释的书写规范，确保代码整洁，提高阅读体验。例如，建议使用4个空格进行缩进，避免过度复杂的嵌套。 3. 异常处理：介绍了处理异常的最佳实践，包括如何恰当地捕获、记录和处理异常，以增强代码的健壮性。手册强调了使用try-catch-finally语句结构，并提倡使用自定义异常来提高可读性。 4. 并发编程：针对多线程编程提供了详细规范，包括如何正确使用锁、避免死锁，以及同步和并发控制的最佳实践。这有助于编写高效的并发代码并确保数据一致性。 5. 安全性：手册关注代码安全，讲解如何防止代码受到恶意攻击，如何妥善处理敏感信息，以及遵循安全编码原则，如输入验证和加密。 6. 性能优化：提供关于代码执行效率和资源管理的指导，如避免不必要的计算、合理使用数据结构和算法，以及如何进行有效的内存管理。手册不仅注重编程技巧，还强调了软件开发中的其他重要方面，如错误码管理、数据库设计、工程结构组织、权限管理等，以全面提高软件交付质量。此外，手册还提供了【强制】、【推荐】和【参考】不同级别的规约，以及丰富的实例和案例分析，以帮助开发者避免常见陷阱。通过遵循《Java开发手册-代码规范》，开发者能够创建出高效、可维护、高质量的代码，同时也体现了阿里巴巴团队对技术共享和社会责任的承诺。手册的发布得到了广泛支持，如配套IDE插件和书籍《码出高效》的出现，进一步推动了规范在实际开发中的应用。

Java开发手册

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 = new BigDecimal("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 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。

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

19.【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容

的检查，否则会有抛 IndexOutOfBoundsException 的风险。

说明：

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

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

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

System.out.println(ary.length);

9/59

Java开发手册

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

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

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

方法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可

能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载

的信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体最后。

22.【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在

getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。

反例：

public Integer getData () {

if (condition) {

return this.data + 100;

} else {

return this.data - 100;

}

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

说明：下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append

操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。

反例：

String str = "start";

for (int i = 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。

10/59

Java开发手册

5）类 static 成员变量如果仅在本类使用，必须是 private。

6）若是 static 成员变量，考虑是否为 final。

7）类成员方法只供类内部调用，必须是 private。

8）类成员方法只对继承类公开，那么限制为 protected。

说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考：如果

是一个 private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不

得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你

会担心的。

(五) 日期时间

1. 【强制】日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

说明：日期格式化时，yyyy 表示当天所在的年，而大写的 YYYY 代表是 week in which year（JDK7 之后

引入的概念），意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的 YYYY

就是下一年。

正例：表示日期和时间的格式如下所示：

new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")

2. 【强制】在日期格式中分清楚大写的 M 和小写的 m，大写的 H 和小写的 h 分别指代的意义。

说明：日期格式中的这两对字母表意如下：

1）表示月份是大写的 M；

2）表示分钟则是小写的 m；

3） 24 小时制的是大写的 H；

4） 12 小时制的则是小写的 h。

3. 【强制】获取当前毫秒数：System.currentTimeMillis(); 而不是 new Date().getTime()。

说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime 的方式。在 JDK8 中，针对统计时间

等场景，推荐使用 Instant 类。

4. 【强制】不允许在程序任何地方中使用：1）java.sql.Date。 2）java.sql.Time。

3）java.sql.Timestamp。

说明：第 1 个不记录时间，getHours()抛出异常；第 2 个不记录日期，getYear()抛出异常；第 3 个在构造

方法 super((time/1000)*1000)，在 Timestamp 属性 fastTime 和 nanos 分别存储秒和纳秒信息。

反例： java.util.Date.after(Date)进行时间比较时，当入参是 java.sql.Timestamp 时，会触发 JDK

BUG(JDK9 已修复)，可能导致比较时的意外结果。

5. 【强制】不要在程序中写死一年为 365 天，避免在公历闰年时出现日期转换错误或程序逻辑

错误。

11/59

剩余61页未读，继续阅读

sky-line

粉丝: 145
资源: 10

阿里巴巴Java开发手册：代码规范提升开发质量

Java开发编码规范手册

Java代码开发规范

Java 代码 规范

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

Java开发手册-20220401

java开发手册-通用

Java 开发手册-1.5.0

Java开发手册-阿里

Java开发手册-华山版

java开发手册-嵩山版

最新资源

Java 代码规范