在高并发场景中,避免使用”等于”判断作为中断或退出的条件。【说明:如果并发控制没有处理好,容易产生等值判断被“击穿”的情况,使用大于或小于的区间判断条件来代替。】
反例:判断剩余奖品数量等于 0 时,终止发放奖品,但因为并发处理错误导致奖品数量瞬间变成了负数,这样的话,活动无法终止。
表达异常的分支时,少用if-else方式,这种方式可以改写成下面代码:【说明:如果非使用if()...else if()...else...方式表达逻辑,避免后续代码维护困难,请勿超过3层】
if (condition) { ... return obj; } // 接着写 else 的业务逻辑代码;超过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) { ... } // 反例 // 哈哈,这好像是ReentrantLock里面有类似风格的代码 // 连Doug Lea的代码都拿来当做反面教材啊 // 早前就听别人说过“编程不识Doug Lea,写尽Java也枉然!!!” 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的参数校验,可以省略。3)被声明成private只会被自己代码所调用的方法,如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题,此时可以不校验参数。
(八) 注释规约类、类属性、类方法的注释必须使用Javadoc规范,使用/**内容*/格式,不得使用// xxx方式。【说明:在IDE编辑窗口中,Javadoc方式会提示相关注释,生成 Javadoc可以正确输出相应注释;在IDE中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。】
所有的抽象方法(包括接口中的方法)必须要用Javadoc注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能【说明:对子类的实现要求,或者调用注意事项,请一并说明】
所有的类都必须添加创建者和创建日期。
方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/* */注释,注意与代码对齐
所有的枚举类型字段必须要有注释,说明每个数据项的用途