手记

Java编程规约

【强制】在一个 switch 块内,每个 case 要么通过 continue/break/return 等来终止,要么


注释说明程序将继续执行到哪一个 case 为止;在一个 switch 块内,都必须包含一个


default 语句并且放在最后,即使它什么代码也没有。https://www.beLLytanks.com


说明:注意 break 是退出 switch 语句块,而 return 是退出方法体。


【强制】当 switch 括号内的变量类型为 String 并且此变量为外部参数时,必须先进行 null


判断。


反例:猜猜下面的代码输出是什么?


public static void method(String param) {

 

    switch (param) {

 

    // 肯定不是进入这里 

 

        case "sth":

 

        System.out.println("it's sth");

 

        break;

 

        // 也不是进入这里 

 

        case "null":

 

        System.out.println("it's null");

 

        break;

 

        // 也不是进入这里 

 

        default:

 

        System.out.println("default"); }

 

    } 

 

}

【强制】在 if/else/for/while/do 语句中必须使用大括号。


说明:即使只有一行代码,避免采用单行的编码方式:if (condition) statements;


【强制】在高并发场景中,避免使用”等于”判断作为中断或退出的条件。


说明:如果并发控制没有处理好,容易产生等值判断被“击穿”的情况,使用大于或小于的区间判断条件


来代替。


反例:判断剩余奖品数量等于 0 时,终止发放奖品,但因为并发处理错误导致奖品数量瞬间变成了负数,


这样的话,活动无法终止。


【推荐】表达异常的分支时,少用 if-else 方式,这种方式可以改写成:


if (condition) {


...


return obj; }


// 接着写 else 的业务逻辑代码;


说明:如果非使用 if()...else if()...else...方式表达逻辑,避免后续代码维护困难,【强制】请勿超过 3 层。


正例:超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现,其中卫语句


即代码逻辑先考虑失败、异常、中断、退出等直接返回的情况,以方法多个出口的方式,解决代码中判断


分支嵌套的问题,这是逆向思维的体现。


示例如下:


public void findBoyfriend(Man man) {

 

    if (man.isUgly()) {

 

    System.out.println("本姑娘是外貌协会的资深会员");

 

    return; }

 

    if (man.isPoor()) {

 

    System.out.println("贫贱夫妻百事哀");

 

    return; }

 

    if (man.isBadTemper()) {

 

    System.out.println("银河有多远,你就给我滚多远");

 

    return; }

 

    System.out.println("可以先交往一段时间看看"); }

【推荐】除常用方法(如 getXxx/isXxx)等外,不要在条件判断中执行其它复杂的语句,将复


杂逻辑判断的结果赋值给一个有意义的布尔变量名,以提高可读性。


说明:很多 if 语句内的逻辑表达式相当复杂,与、或、取反混合运算,甚至各种方法纵深调用,理解成


本非常高。如果赋值一个非常好理解的布尔变量名字,则是件令人爽心悦目的事情。


正例:


// 伪代码如下


final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);


if (existed) { ...}


反例:


public final void acquire(long arg) {


if (!tryAcquire(arg) &&


acquireQueued(addWaiter(Node.EXCLUSIVE), arg)) {


 selfInterrupt();


}


}


【推荐】不要在其它表达式(尤其是条件表达式)中,插入赋值语句。


说明:赋值点类似于人体的穴位,对于代码的理解至关重要,所以赋值语句需要清晰地单独成为一行。


反例:


public Lock getLock(boolean fair) {


// 算术表达式中出现赋值操作,容易忽略 count 值已经被改变 threshold = (count = Integer.MAX_VALUE) - 1;


// 条件表达式中出现赋值操作,容易误认为是 sync==fair return (sync = fair) ? new FairSync() : new NonfairSync();


}


【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变


量、获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体


外)。


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


说明:取反逻辑不利于快速理解,并且取反逻辑写法必然存在对应的正向逻辑写法。


正例:使用 if (x < 628) 来表达 x 小于 628。


反例:使用 if (!(x >= 628)) 来表达 x 小于 628。


【推荐】接口入参保护,这种场景常见的是用作批量操作的接口。


【参考】下列情形,需要进行参数校验:


1) 调用频次低的方法。


2) 执行时间开销很大的方法。此情形中,参数校验时间几乎可以忽略不计,但如果因为参数错误导致


中间执行回退,或者错误,那得不偿失。


3) 需要极高稳定性和可用性的方法。


4) 对外提供的开放接口,不管是 RPC/API/HTTP 接口。


5) 敏感权限入口。


【参考】下列情形,不需要进行参数校验:


1) 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。


2) 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道,参数错误不太可能到底层才会暴露


问题。一般 DAO 层与 Service 层都在同一个应用中,部署在同一台服务器中,所以 DAO 的参数校验,可


以省略。https://www.beyondtheseLf.com


3) 被声明成 private 只会被自己代码所调用的方法,如果能够确定调用方法的代码传入参数已经做过检


查或者肯定不会有问题,此时可以不校验参数。



0人推荐
随时随地看视频
慕课网APP