阿里巴巴Java开发规范——编程规约（5）

阿里巴巴Java开发规范——编程规约（5）

编程规约

（七）控制语句

1. 【强制】在if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if (condition) statements;

2. 【推荐】除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以高可读性。

说明: 很多if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么
样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？
正例：

// 伪代码如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
    ...
}

反例：

if ((file.open(fileName, "w") != null) && (...) || (...)) {
    ...
}

3. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch 操作（这个try-catch 是否可以移至循环体外）。

4. 【推荐】避免采用取反逻辑运算符。

说明： 取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。
正例： 使用if (x < 628) 来表达 x 小于628。
反例： 使用if (!(x >= 628)) 来表达 x 小于628。

5.【参考】下列情形，需要进行参数校验：

1） 调用频次低的方法。
2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参
数错误导致中间执行回退，或者错误，那得不偿失。
3） 需要极高稳定性和可用性的方法。
4） 对外供的开放接口，不管是 RPC/API/HTTP 接口。
5） 敏感权限入口。

6. 【参考】下列情形，不需要进行参数校验：

1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底
层才会暴露问题。一般 DAO 层与Service 层都在同一个应用中，部署在同一台服务器中，所
以DAO 的参数校验，可以省略。
3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参
数已经做过检查或者肯定不会有问题，此时可以不校验参数。

（八）注释规约

1.【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用 /*内容/ 格式，不得使用// xxx 方式。

说明： 在IDE 编辑窗口中，Javadoc 方式会示相关注释，生成 Javadoc 可以正确输出相应注
释；在IDE 中，工程调用方法时，不进入方法即可悬浮示方法、参数、返回值的意义，高
阅读效率。

2.【强制】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明： 对子类的实现要求，或者调用注意事项，请一并说明。

3.【强制】所有的类都必须添加创建者和创建日期。

4.【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

5.【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

6.【推荐】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

7. 推荐】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。

说明： 代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

8.【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

9. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）
表示需要实现，但目前还未实现的功能。
2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）
在注释中用FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况