我的博客網站:http://www.caoyong.xin:8080/blogger(歡迎訪問!有我更多的文章)
1: 控制語句
1. 【強制】在一個 switch 塊內,每個 case 要麼通過 break/return 等來終止,要麼註釋說明程序將繼續執行到哪一個 case 爲止;在一個 switch 塊內,都必須包含一個 default 語句並且放在最後,即使空代碼。
2. 【強制】在 if/else/for/while/do 語句中必須使用大括號。即使只有一行代碼,避免採用
單行的編碼方式:if (condition) statements;
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) && (...) || (...)) {
...
}
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 只會被自己代碼所調用的方法,如果能夠確定調用方法的代碼傳入參
數已經做過檢查或者肯定不會有問題,此時可以不校驗參數。
2:註釋規約
1. 【強制】類、類屬性、類方法的註釋必須使用 Javadoc 規範,使用/**內容*/格式,不得使用
// xxx 方式。
說明:在 IDE 編輯窗口中,Javadoc 方式會提示相關注釋,生成 Javadoc 可以正確輸出相應註釋;在 IDE 中,工程調用方法時,不進入方法即可懸浮提示方法、參數、返回值的意義,提高閱讀效率。
2. 【強制】所有的抽象方法(包括接口中的方法)必須要用 Javadoc 註釋、除了返回值、參數、異常說明外,還必須指出該方法做什麼事情,實現什麼功能。
說明:對子類的實現要求,或者調用注意事項,請一併說明。
3. 【強制】所有的類都必須添加創建者和創建日期。
4. 【強制】方法內部單行註釋,在被註釋語句上方另起一行,使用//註釋。方法內部多行註釋使用/* */註釋,注意與代碼對齊。
5. 【強制】所有的枚舉類型字段必須要有註釋,說明每個數據項的用途。
6. 【推薦】與其“半吊子”英文來註釋,不如用中文註釋把問題說清楚。專有名詞與關鍵字保持英文原文即可。
反例:“TCP 連接超時”解釋成“傳輸控制協議連接超時”,理解反而費腦筋。
7. 【推薦】代碼修改的同時,註釋也要進行相應的修改,尤其是參數、返回值、異常、核心邏輯等的修改。
說明:代碼與註釋更新不同步,就像路網與導航軟件更新不同步一樣,如果導航軟件嚴重滯後,就失去了導航的意義。
8. 【參考】謹慎註釋掉代碼。在上方詳細說明,而不是簡單地註釋掉。如果無用,則刪除。
說明:代碼被註釋掉有兩種可能性:1)後續會恢復此段代碼邏輯。2)永久不用。前者如果沒有備註信息,難以知曉註釋動機。後者建議直接刪掉(代碼倉庫保存了歷史代碼)。
9. 【參考】對於註釋的要求:第一、能夠準確反應設計思想和代碼邏輯;第二、能夠描述業務含義,使別的程序員能夠迅速瞭解到代碼背後的信息。完全沒有註釋的大段代碼對於閱讀者形同天書,註釋是給自己看的,即使隔很長時間,也能清晰理解當時的思路;註釋也是給繼任者看的,使其能夠快速接替自己的工作。
10. 【參考】好的命名、代碼結構是自解釋的,註釋力求精簡準確、表達到位。避免出現註釋的一個極端:過多過濫的註釋,代碼的邏輯一旦修改,修改註釋是相當大的負擔。
反例:
// put elephant into fridge put(elephant, fridge);
方法名 put,加上兩個有意義的變量名 elephant 和 fridge,已經說明了這是在幹什麼,語義清晰的代碼不需要額外的註釋。
11. 【參考】特殊註釋標記,請註明標記人與標記時間。注意及時處理這些標記,通過標記掃描,經常清理此類標記。線上故障有時候就是來源於這些標記處的代碼。
1) 待辦事宜(TODO):( 標記人,標記時間,[預計處理時間])
表示需要實現,但目前還未實現的功能。這實際上是一個 Javadoc 的標籤,目前的 Javadoc
還沒有實現,但已經被廣泛使用。只能應用於類,接口和方法(因爲它是一個 Javadoc 標籤)。
2) 錯誤,不能工作(FIXME):(標記人,標記時間,[預計處理時間])
在註釋中用 FIXME 標記某代碼是錯誤的,而且不能工作,需要及時糾正的情況。
3:MyEclipse設置註釋規則
關於在MyEclipse中配置註釋規則,每個人都有自己的一套註釋規則,那麼就需要我們自己去配置這樣一套規則。首先可以在網上軸一份模板規 則,然後在進行一些修改,按照自己喜歡,但是又符合項目的規則。我這列出一份
/**
* All rights Reserved, Designed By www.tydic.com
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句話描述該文件做什麼)
* @author: 天源迪科技
* @date: ${date} ${time}
* @version V1.0
* @Copyright: ${year} www.tydic.com Inc. All rights reserved.
* 注意:本內容僅限於深圳天源迪科信息技術股份有限公司內部傳閱,禁止外泄以及用於其他的商業目 */
2.類型(Types)註釋標籤(類的註釋):
/**
* @ClassName: ${type_name}
* @Description:${todo}(這裏用一句話描述這個類的作用)
* @author: 天源迪科
* @date: ${date} ${time}
*
* ${tags}
* @Copyright: ${year} www.tydic.com Inc. All rights reserved.
* 注意:本內容僅限於深圳天源迪科信息技術股份有限公司內部傳閱,禁止外泄以及用於其他的商業目
*/
3.字段(Fields)註釋標籤:
/**
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
*/
4.構造函數標籤:
/**
* @Title: ${enclosing_type}
* @Description: ${todo}(這裏用一句話描述這個方法的作用)
* @param: ${tags}
* @throws
*/
5.方法(Methods)標籤:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(這裏用一句話描述這個方法的作用)
* @param: ${tags}
* @return: ${return_type}
* @throws
*/
6.覆蓋方法(Overriding Methods)標籤:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
7.代表方法(Delegate Methods)標籤:
/**
* ${tags}
* ${see_to_target}
*/
8.getter方法標籤:
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/
9.setter方法標籤:
/**
* @Title: ${enclosing_method} <BR>
* @Description: please write your description <BR>
* @return: ${field_type} <BR>
*/
模板是有了,但是我建議不要粘貼複製,可以自己修改一下,這樣纔有自己的風格,具體怎麼導入到MyEclipse中
Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設置註釋的元素啦
提到了MyEclipse 就要說一下,可能有些人啓動MyEclipse很慢或者tomcat啓動很慢,關於MyEclipse啓動很慢一方面是沒有對MyEclipse進行優化,一方面可能是沒有調節JDK的運行內存,關於這兩點網上有很多案例(我就不做搬運工了),關於tomcat啓動很慢,也有兩點,第一就是tomcat的運行內存,第二可以是在安裝tomcat的\apache-tomcat-6.0.37\work\Catalina\localhost裏面緩存了很多項目,需要把這些都清理一下。這樣運行會流暢一些。