阿里巴巴对Java编程【控制语句】的规约
轉(zhuǎn)載自?阿里巴巴對Java編程【控制語句】的規(guī)約
控制語句
1. 【強制】在一個 switch 塊內(nèi)，每個 case 要么通過 break / return 等來終止，要么注釋說明程序?qū)⒗^續(xù)執(zhí)行到哪一個 case 為止 ； 在一個 switch 塊內(nèi)，都必須包含一個 default 語句并且放在最后，即使它什么代碼也沒有。?
2.【強制】在 if / else / for / while / do 語句中必須使用大括號。即使只有一行代碼，避免采用單行的編碼方式： if (condition) statements;
3. 【推薦】表達異常的分支時，少用 if-else 方式 ，這種方式可以改寫成：
if (condition) {
...
return obj;
}
// 接著寫 else 的業(yè)務(wù)邏輯代碼;
說明：如果非得使用 if()...else if()...else... 方式表達邏輯，【強制】避免后續(xù)代碼維護困難，請勿超過 3 層。
正例：超過 3 層的 if-else 的邏輯判斷代碼可以使用衛(wèi)語句、策略模式、狀態(tài)模式等來實現(xiàn)，
其中衛(wèi)語句示例如下：
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）等外，不要在條件判斷中執(zhí)行其它復(fù)雜的語句，將復(fù)雜邏輯判斷的結(jié)果賦值給一個有意義的布爾變量名，以提高可讀性。
說明：很多 if 語句內(nèi)的邏輯相當復(fù)雜，閱讀者需要分析條件表達式的最終結(jié)果，才能明確什么樣的條件執(zhí)行什么樣的語句，那么，如果閱讀者分析邏輯表達式錯誤呢？
正例：
// 偽代碼如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
...
}
反例：
if ((file.open(fileName, "w") != null) && (...) || (...)) {
...
}
5. 【推薦】循環(huán)體中的語句要考量性能，以下操作盡量移至循環(huán)體外處理，如定義對象、變量、獲取數(shù)據(jù)庫連接，進行不必要的 try - catch 操作 （ 這個 try - catch 是否可以移至循環(huán)體外 ） 。
6. 【推薦】接口入?yún)⒈Ｗo，這種場景常見的是用于做批量操作的接口。
7. 【參考】下列情形，需要進行參數(shù)校驗：
1 ） 調(diào)用頻次低的方法。
2 ） 執(zhí)行時間開銷很大的方法。此情形中，參數(shù)校驗時間幾乎可以忽略不計，但如果因為參數(shù)錯誤導(dǎo)致中間執(zhí)行回退，或者錯誤，那得不償失。
3 ） 需要極高穩(wěn)定性和可用性的方法。
4 ） 對外提供的開放接口，不管是 RPC / API / HTTP 接口。
5） 敏感權(quán)限入口。
8. 【參考】下列情形，不需要進行參數(shù)校驗：
1 ） 極有可能被循環(huán)調(diào)用的方法。但在方法說明里必須注明外部參數(shù)檢查要求。
2 ） 底層調(diào)用頻度比較高的方法。畢竟是像純凈水過濾的最后一道，參數(shù)錯誤不太可能到底層才會暴露問題。一般 DAO 層與 Service 層都在同一個應(yīng)用中，部署在同一臺服務(wù)器中，所以 DAO 的參數(shù)校驗，可以省略。
3 ） 被聲明成 private 只會被自己代碼所調(diào)用的方法，如果能夠確定調(diào)用方法的代碼傳入?yún)?shù)已經(jīng)做過檢查或者肯定不會有問題，此時可以不校驗參數(shù)。?
總結(jié)
以上是生活随笔為你收集整理的阿里巴巴对Java编程【控制语句】的规约的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 阿里巴巴对Java编程【并发处理】的规约
- 下一篇： 阿里巴巴对Java编程【注释规约】的规约