1. 【強制】在一個switch塊內,每個case要么通過break/return等來終止,要么注釋說明程序將繼續執行到哪一個case為止;在一個switch塊內,都必須包含一個default語句并且放在最后,即使它什么代碼也沒有。
2. 【強制】在if/else/for/while/do語句中必須使用大括號。即使只有一行代碼,避免采用
單行的編碼方式:if (condition) statements;
1. 【推薦】表達異常的分支時,少用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;
}
4\. 【推薦】除常用方法(如 getXxx/isXxx)等外,不要在條件判斷中執行其它復雜的語句,將復
雜邏輯判斷的結果賦值給一個有意義的布爾變量名,以提高可讀性。
說明:很多 if 語句內的邏輯相當復雜,閱讀者需要分析條件表達式的最終結果,才能明確什么樣的條件執行什么樣的語句,那么,如果閱讀者分析邏輯表達式錯誤呢?正例:
// 偽代碼如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...); if (existed) {
...
}
##### 反例:
if ((file.open(fileName, "w") != null) && (...) || (...)) {
...
}
1. 【推薦】循環體中的語句要考量性能,以下操作盡量移至循環體外處理,如定義對象、變量、
獲取數據庫連接,進行不必要的try-catch操作(這個try-catch是否可以移至循環體外)。
1. 【推薦】接口入參保護,這種場景常見的是用于做批量操作的接口。
2. 【參考】下列情形,需要進行參數校驗:
1) 調用頻次低的方法。
2) 執行時間開銷很大的方法。此情形中,參數校驗時間幾乎可以忽略不計,但如果因為參數錯誤導致中間執行回退,或者錯誤,那得不償失。
3) 需要極高穩定性和可用性的方法。
4) 對外提供的開放接口,不管是RPC/API/HTTP接口。
5) 敏感權限入口。
1. 【參考】下列情形,不需要進行參數校驗:
1) 極有可能被循環調用的方法。但在方法說明里必須注明外部參數檢查要求。
2) 底層調用頻度比較高的方法。畢竟是像純凈水過濾的最后一道,參數錯誤不太可能到底層才會暴露問題。一般DAO層與Service層都在同一個應用中,部署在同一臺服務器中,所以DAO的參數校驗,可以省略。
3) 被聲明成private只會被自己代碼所調用的方法,如果能夠確定調用方法的代碼傳入參數已經做過檢查或者肯定不會有問題,此時可以不校驗參數。
- 一、編程規約????1
- (一) 命名風格????1
- (二) 常量定義????3
- (三) 代碼格式????4
- (四) OOP規約????6
- (五) 集合處理????9
- (六) 并發處理????12
- (七) 控制語句????14
- (八) 注釋規約????16
- (九) 其它????17
- 二、異常日志????18
- (一) 異常處理????18
- (二) 日志規約????19
- 三、單元測試????21
- 四、安全規約????23
- 五、MySQL數據庫????24
- (一) 建表規約????24
- (二) 索引規約????25
- (三) SQL語句????27
- (四) ORM映射????28
- 六、工程結構????30
- (一) 應用分層????30
- (二) 二方庫依賴????31
- (三) 服務器????32
- 附1:版本歷史????34
- 附2:本手冊專有名詞????35