阿里巴巴Java 开发手册编程规约之控制语句

Posted 2020-09-30

1. 【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止； 在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使它什么代码也没有。
2. 【强制】在 if/else/for/while/do 语句中必须使用大括号。 即使只有一行代码，避免使用单行的形式： if (condition) statements;
3. 【推荐】 表达异常的分支时， 少用 if-else 方式， 这种方式可以改写成：

if (condition) {
    ...
    return obj;
}
// 接着写 else 的业务逻辑代码;

说明： 如果非得使用 if()...else if()...else...方式表达逻辑，【强制】 避免后续代码维护困难， 请勿超过 3 层。
正例： 逻辑上超过 3 层的 if-else 代码可以使用卫语句，或者状态模式来实现。 卫语句示例
如下：  

public void today() {
    if (isBusy()) {
        System.out.println(“change time.”);
        return;
    }
    if (isFree()) {
        System.out.println(“go to travel.”);
        return;
    }
    System.out.println(“stay at home to learn Alibaba Java Coding Guideline.”);
    return;
}

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

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

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

反例：

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

5. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外） 。
6. 【推荐】接口入参保护，这种场景常见的是用于做批量操作的接口。
7. 【参考】 下列情形，需要进行参数校验：
1） 调用频次低的方法。
2） 执行时间开销很大的方法。 此情形中， 参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
3） 需要极高稳定性和可用性的方法。
4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。
5） 敏感权限入口。
8. 【参考】 下列情形， 不需要进行参数校验：
1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 DAO 的参数校验，可以省略。
3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参
数已经做过检查或者肯定不会有问题，此时可以不校验参数