控制语句规约
(八) 控制语句
1.【强制】 在一个 switch 块内,每个 case 要么通过 continue / break / return 等来终止,要么注释说明程序将继续执行到哪一个 case 为止;在一个 switch 块内,都必须包含一个 default 语句并且放在最后,即使它什么代码也没有。 说明:注意 break 是退出 switch 语句块,而 return 是退出方法体。
2.【强制】 当 switch 括号内的变量类型为 String 并且此变量为外部参数时,必须先进行 null 判断。
3.【强制】 在 if / else / for / while / do 语句中必须使用大括号。 说明:即使只有一行代码,也要采用大括号的编码方式。
4.【强制】 三目运算符 condition ? 表达式 1:表达式 2 中,高度注意表达式 1 和 2 在类型对齐时,可能抛出因自动拆箱导致的 NPE 异常。 说明:如果表达式 1 或 2 的值只要有一个是原始类型,或类型不一致,会强制拆箱升级。
5.【强制】 在高并发场景中,避免使用"等于"判断作为中断或退出的条件。 说明:使用大于或小于的区间判断条件来代替。
6.【推荐】 当方法的代码总行数超过 10 行时,return / throw 等中断逻辑的右大括号后需要加一个空行。 说明:这样做逻辑清晰,有利于代码阅读时重点关注。
7.【推荐】 表达异常的分支时,少用 if-else 方式,这种方式可以改写成:
if (condition) {
...
return obj;
}
// 接着写 else 的业务逻辑代码;
说明:如果非使用 if()...else if()...else... 方式表达逻辑,避免后续代码维护困难,请勿超过 3 层。
8.【推荐】 除常用方法(如 getXxx / isXxx)等外不要在条件判断中执行其它复杂的语句,将复杂逻辑判断的结果赋值给一个有意义的布尔变量名。
9.【推荐】 不要在其它表达式(尤其是条件表达式)中,插入赋值语句。 说明:赋值点类似于人体的穴位,对于代码的理解至关重要。
10.【推荐】 循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、获取数据库连接,进行不必要的 try-catch 操作。
11.【推荐】 避免采用取反逻辑运算符。 正例:使用 if(x < 628) 来表达 x 小于 628。 反例:使用 if(!(x >= 628)) 来表达 x 小于 628。
12.【推荐】 公开接口需要进行入参保护,尤其是批量操作的接口。
13.【参考】 下列情形,需要进行参数校验: 1)调用频次低的方法。 2)执行时间开销很大的方法。 3)需要极高稳定性和可用性的方法。 4)对外提供的开放接口。 5)敏感权限入口。
14.【参考】 下列情形,不需要进行参数校验: 1)极有可能被循环调用的方法。 2)底层调用频度比较高的方法。 3)被声明成 private 只会被自己代码所调用的方法。