編程規約之控制語句

(七)控制語句 
1. 【強制】在一個 switch 塊內,每個 case 要麼通過 break/return 等來終止,要麼註釋說明程
序將繼續執行到哪一個 case 爲止;在一個 switch 塊內,都必須包含一個 default 語句並且
放在最後,即使空代碼。
2. 【強制】在 if/else/for/while/do 語句中必須使用大括號。即使只有一行代碼,避免採用
單行的編碼方式:if (condition) statements; 
阿里巴巴 Java 開發手冊
 15/38
3. 【強制】在高併發場景中,避免使用”等於”判斷作爲中斷或退出的條件。
說明:如果併發控制沒有處理好,容易產生等值判斷被“擊穿”的情況,使用大於或小於的區間
判斷條件來代替。
反例:判斷剩餘獎品數量等於 0 時,終止發放獎品,但因爲併發處理錯誤導致獎品數量瞬間變
成了負數,這樣的話,活動無法終止。
4. 【推薦】表達異常的分支時,少用 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 Guidelines.”);
 return;
}
5. 【推薦】除常用方法(如 getXxx/isXxx)等外,不要在條件判斷中執行其它複雜的語句,將
複雜邏輯判斷的結果賦值給一個有意義的布爾變量名,以提高可讀性。
說明:很多 if 語句內的邏輯相當複雜,閱讀者需要分析條件表達式的最終結果,才能明確什麼
樣的條件執行什麼樣的語句,那麼,如果閱讀者分析邏輯表達式錯誤呢?
正例:
// 僞代碼如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
 ...

反例:
if ((file.open(fileName, "w") != null) && (...) || (...)) {
 ...
}
阿里巴巴 Java 開發手冊
 16/38
6. 【推薦】循環體中的語句要考量性能,以下操作儘量移至循環體外處理,如定義對象、變量、
獲取數據庫連接,進行不必要的 try-catch 操作(這個 try-catch 是否可以移至循環體外)。
7. 【推薦】避免採用取反邏輯運算符。
說明:取反邏輯不利於快速理解,並且取反邏輯寫法必然存在對應的正向邏輯寫法。
正例:使用 if (x < 628) 來表達 x 小於 628。
反例:使用 if (!(x >= 628)) 來表達 x 小於 628。
8. 【推薦】接口入參保護,這種場景常見的是用作批量操作的接口。
9. 【參考】下列情形,需要進行參數校驗:
1) 調用頻次低的方法。
2) 執行時間開銷很大的方法。此情形中,參數校驗時間幾乎可以忽略不計,但如果因爲參
數錯誤導致中間執行回退,或者錯誤,那得不償失。
3) 需要極高穩定性和可用性的方法。
4) 對外提供的開放接口,不管是 RPC/API/HTTP 接口。
5) 敏感權限入口。
10. 【參考】下列情形,不需要進行參數校驗:
1) 極有可能被循環調用的方法。但在方法說明裏必須註明外部參數檢查要求。
2) 底層調用頻度比較高的方法。畢竟是像純淨水過濾的最後一道,參數錯誤不太可能到底
層纔會暴露問題。一般 DAO 層與 Service 層都在同一個應用中,部署在同一臺服務器中,所
以 DAO 的參數校驗,可以省略。
3) 被聲明成 private 只會被自己代碼所調用的方法,如果能夠確定調用方法的代碼傳入參
數已經做過檢查或者肯定不會有問題,此時可以不校驗參數。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章