阿里巴巴修炼秘籍让码农成为程序员:第一章 控制语句
2017年开春之际,阿里诚意献上重磅大礼:阿里巴巴Java开发手册,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。
小编摘抄了大部分开发语言通用的规范并添加了部分注释,希望对大家有帮助!
控制语句
【强制】在一个 switch 块内,每个 case 要么通过 break/return 来终止,要么注释说明程序将继续 执行到哪一个 case 为止;在一个 switch 块内,都必须包含一个 default 语句并且放在最后,即使 它什么代码也没有。
说明:switch 不加 break 继续执行 下一个case(不用匹配条件)
【强制】在 if/else/for/while/do 语句中必须使用大括号,即使只有一行代码,避免使用下面的形式:if (condition) statements;
说明:以前有人说,括号不换行,是因为以前屏幕小,一个括号占一行,能显示的代码就少,不方便看代码。然后被后人无脑沿用。(真假未知)
【推荐】推荐尽量少用 else, if-else 的方式可以改写成:
if(condition){
…
return obj;
}
// 接着写 else 的业务逻辑代码;
说明:如果使用要 if-else if-else 方式表达逻辑,【强制】请勿超过 3 层,超过请使用状态设计模式。
【推荐】除常用方法(如 getXxx/isXxx)等外,不要在条件判断中执行复杂的语句,以提高可读性。
正例:
//伪代码如下
InputStream stream = file.open(fileName, "w");
if (stream != null) {
…
}
反例:
if (file.open(fileName, "w") != null)) {
…
}
【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。
说明:这个不用说明吧~~~
【参考】方法中需要进行参数校验的场景:
1) 调用频次低的方法。
2) 执行时间开销很大的方法,参数校验时间几乎可以忽略不计,但如果因为参数错误导致中间执行回退,或者错误,那得不偿失。
3) 需要极高稳定性和可用性的方法。
4) 对外提供的开放接口,不管是 RPC/API/HTTP 接口。
【参考】方法中不需要参数校验的场景:
1) 极有可能被循环调用的方法,不建议对参数进行校验。但在方法说明里必须注明外部参数检查。
2) 底层的方法调用频度都比较高,一般不校验。毕竟是像纯净水过滤的最后一道,参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中,部署在同一台服务器,所以 DAO 的参数校验,可以省略。
3) 被声明成 private 只会被自己代码所调用的方法,如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题,此时可以不校验参数。
说明:2个参考场景不是唯一,具体问题具体分析