阿里巴巴对Java编程【控制语句】的规约
轉載自?阿里巴巴對Java編程【控制語句】的規約
控制語句
1. 【強制】在一個 switch 塊內,每個 case 要么通過 break / return 等來終止,要么注釋說明程序將繼續執行到哪一個 case 為止 ; 在一個 switch 塊內,都必須包含一個 default 語句并且放在最后,即使它什么代碼也沒有。?
2.【強制】在 if / else / for / while / do 語句中必須使用大括號。即使只有一行代碼,避免采用單行的編碼方式: if (condition) statements;
3. 【推薦】表達異常的分支時,少用 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) && (...) || (...)) {
...
}
5. 【推薦】循環體中的語句要考量性能,以下操作盡量移至循環體外處理,如定義對象、變量、獲取數據庫連接,進行不必要的 try - catch 操作 ( 這個 try - catch 是否可以移至循環體外 ) 。
6. 【推薦】接口入參保護,這種場景常見的是用于做批量操作的接口。
7. 【參考】下列情形,需要進行參數校驗:
1 ) 調用頻次低的方法。
2 ) 執行時間開銷很大的方法。此情形中,參數校驗時間幾乎可以忽略不計,但如果因為參數錯誤導致中間執行回退,或者錯誤,那得不償失。
3 ) 需要極高穩定性和可用性的方法。
4 ) 對外提供的開放接口,不管是 RPC / API / HTTP 接口。
5) 敏感權限入口。
8. 【參考】下列情形,不需要進行參數校驗:
1 ) 極有可能被循環調用的方法。但在方法說明里必須注明外部參數檢查要求。
2 ) 底層調用頻度比較高的方法。畢竟是像純凈水過濾的最后一道,參數錯誤不太可能到底層才會暴露問題。一般 DAO 層與 Service 層都在同一個應用中,部署在同一臺服務器中,所以 DAO 的參數校驗,可以省略。
3 ) 被聲明成 private 只會被自己代碼所調用的方法,如果能夠確定調用方法的代碼傳入參數已經做過檢查或者肯定不會有問題,此時可以不校驗參數。?
總結
以上是生活随笔為你收集整理的阿里巴巴对Java编程【控制语句】的规约的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 阿里巴巴对Java编程【并发处理】的规约
- 下一篇: 尼康 Zf 全画幅复古相机今晚发售,单机