java開發規範總結_代碼編碼規範

標籤：

規範需要平時編碼過程中注意，是一個慢慢養成的好習慣

1.基本原則

   強制性原則：
     1.字串的拼加操作，必須使用StringBuilder；
     2.try…catch的用法

try{}catch{Exception e    e.printStackTrace();}finally{}//在最外層的Action中可以使用，其它地方一律禁止使用；

try{    //程式碼}catch(Exception e){    //為空白，什麼都不寫}//在任何情境中都禁止使用

try{}catch{Exception e    throw new runtimeException(e)；//最優先採用的寫法}finally{}

     1.對於捕獲後，不知道幹什麼事情或者也不知道怎樣處理的情況，就不要捕獲異常，留給外出層去捕獲處理；
     2.傳回型別為集合的,在方法聲明中必須使用泛型，必須在javadoc中註明什麼情況下返回null，什麼情況下返回空集合。
     3.對於方法、變數聲明範圍要採用如下優先順序：private、protected、public，對於變數要採用如下的優先順序：局部變數、執行個體變數、類變數，如果必須要採用執行個體變數或類變數的情況下，要保證執行緒安全性，如有可能盡量採用ThreadLocal儲存執行個體變數或類變數；
     4.如果不是必須，不要在迴圈中去定義變數或者new 對象；盡量在需要的最後一刻才去new 對象；
     5.如果不是必須，不要在迴圈中去用try…catch;
     6.類中對於比較複雜的邏輯要採用行注釋的方式進行注釋，java代碼中絕對不允許採用塊注釋（/**/）進行注釋；
     7.Java類的名稱第一個子母必須大寫，有多個單片語成的，每個單詞的首字母大寫
     8.jsp的檔案名稱必須全部小寫；
     9.Spring的bean設定檔名必須小寫，格式為xxx.bean.xml，xxx.bean.xml設定檔中的<bean id=”” ，此處的id，就是將類名的第一個字母小寫放到此處。
    10.xwork的設定檔名必須小寫，且遵循xwork_xxx.xml的格式書寫，其中XXX是業務名稱的縮寫；
   11.日誌的處理，

if (log.isDebugEnabled())ex.printStackTrace();elselog.error("從資料庫刪除: [" + entity.getClass().getName() + "] 執行個體失敗", daex);throw new PersistenceException("從資料庫刪除: [" + entity.getClass().getName()+ "] 執行個體失敗", daex);

    12.代碼中嚴禁使用System.out.println()進行調試輸出，如果要使用調試資訊，必須使用log.debug()。對於必要的資訊使用log.info()進行輸出；
    13.類中不要出現無用import，可以採用IDE工具進行最佳化，類提交前進行代碼的格式化；
    14.有商務邏輯處理的類必須寫junit單元測試類；
    15.國際化的支援：ftl模板中不允許出現中文字元，要全部放到相應的properties檔案中，properties檔案要放到和Action類同樣的目錄中；ftl的編碼要全部採用UTF-8的格式；properties檔案的命名：中文：Action名稱+“_zh”+“_CN”.properties，英文：Action名稱+“_en”+“_US”.properties
    16.一個程式檔案最好不要超過２０００行
    17.儘可能縮小對象的範圍，這樣對象的可見範圍和生存期也都會儘可能地小，盡所有可能優先採用局部變數，實在沒有辦法用全域變數的，優先採用ThreadLocal來處理。
    18.一個方法所完成的功能要單一,不同的功能封裝為不同的方法.
    19.儘可能的處理異常或轉換異常，不要一味的封裝異常
    20.如果對象在某個特定範圍內必須被清理（而不是作為垃圾被回收），請使用帶有finally子句的try塊，在finally子句中進行清理。
    21.對於把一些邏輯相關的類組織在一起，可以考慮把一個類的定義放在另一個類的定義中，這種情況推薦使用內部類（比如介面層中的事件響應等）。內部類擁有所有外圍類所有成員的訪問權。
    22.對成員變數的訪問最好通過getter/setter方法,這樣能夠保證訪問的合法性,以及代碼調整
    23.優先選擇介面而不是抽象類別或具體類。如果你知道某些東西將成為基類，你應當優先把它們設計成介面；只有在必須放進方法定義或成員變數時，才把它修改為具體或抽象類別。介面只和客戶希望的動作有關（協議），而類則傾向於關注實現細節。
    24.使用java標準庫提供的容器。精通他們的用法，將極大地提高工作效率。優先選擇ArrayList來處理順序結構，選擇HashSet來處理集合，選擇HashMap來處理關聯陣列，選擇linkedList來處理堆棧和隊列，它對順序訪問進行了最佳化，向List中間插入與刪除的開銷小，但隨機訪問則較慢。當使用前三個的時候，應該把他們向上轉型為List、Set和Map,這樣就可以在必要的時候以其它方式實現
    25.數組是一種效率最高的儲存和隨機訪問對象引用序列的方式，但是當建立了一個數組對象，數組的大小就被固定了，如果在空間不足時再建立新的數組進行複製，這樣效率就比ArrayList開銷大了。所以必須明確使用情境。
    26.盡量使用”private”、”protected”關鍵字。一旦你把庫的特徵（包括類、方法、欄位）標記為public,你就再也不可能去掉他們。在這種方式下，實現的變動對衍生類別造成的影響最小，在處理多線程問題的時候，保持私人性尤其重要，因為只有Private的欄位才會受到保護，而不用擔心被未受同步控制的使用所破壞。
    27.禁止後台業務代碼使用如下代碼

try{    something()}catch(Exception ex){}new Exception()

2.類編寫規範

   類的結構組織，一般按照如下的順序：
     1．常量聲明
     2．靜態變數聲明
     3．成員變數聲明
     4．建構函式部分
     5．Finalize部分
     6．成員方法部分
     7．靜態方法部分
     8.這種順序是推薦的，在實際開發中可以按照一定的尺度修改，原則是程式更易讀。如對方法的排序按照重要性，或按照字母順序排列或按照方法之間的關係排列。
     9.每個方法（包括構造與finalize）都是一個段。多個變數聲明按照邏輯共同組成一個段，段與段之間以空行分隔。
     10.類聲明時，要指出其存取控制，一般為沒有修飾符，public，和private。
     11.方法與方法之間，大的部分之間都需要以空行隔離。
     12.編寫通用性的類時，請遵守標準形式。包括定義equals()、hasCode()、toString()、Clone(實現Cloneable介面)，並實現Comparable和Serialiable介面
     13.對於設計期間不需要繼承的類，盡量使用final

3.變數編寫規範

   1.對成員變數, 盡量採用private
   2.每一個變數聲明/定義佔一行（參數變數除外），如

int a;int b;

        比int a,b; 更容易讀, 更容易尋找bug

   3.局部變數在使用前必須初始化，一般在聲明時初始化
   4.變數的聲明要放在程式塊的開始位置

     如

public void myMethod() {  int int1 = 0; // beginning of method block  if (condition) {    int int2 = 0; // beginning of "if" block    ...  }}

    一種例外情況是在for語句中，定義聲明不僅不佔一行，還在運算式內部，完全採用Eclips產生,如：

for(int i = 0; i<100; i++)

    5.數組的申明採用 <資料類型[] + 變數名>方式如

char[] buffer;

而不是

char buffer[];

4.方法編寫規範

    1.對成員方法,不要輕易的採用public的成員變數。主要的修飾符有public, private, protected, 無
    2.空方法中方法聲明和函數體可都在一行。如：　void func(){}
    3.方法和方法之間空一行
    4.方法的文檔注釋放在方法的緊前面，不能空一行。
    5.避免過多的參數列表，盡量控制在５個以內，若需要傳遞多個參數時，當使用一個容納這些參數的對象進行傳遞，以提高程式的可讀性和可擴充性
    6.方法中的迴圈潛套不能超過２層
    7.對於設計期間不需要子類來重載的類，盡量使用final
    8.每個方法盡量程式碼數盡量不要超過100行（有效程式碼，不包括注釋），但必須保證邏輯的完整性
    9.介面中的方法預設層級為protected，只有很確認其它子系統的包會調用自己子系統的介面中的方法時，才將方法暴露為public.

5.語言使用及書寫規範

   1.避免變數的定義與上一層範圍的變數同名。
   2.方法與方法之間用需要用一空行隔開
   3.局部變數在使用時刻聲明，局部變數/靜態變數在聲明時同時初始化
   4.在與常數作比較時常數放在比較運算式的前面如：

if(“simpleCase”.equals(obj))…if(null == obj)….

   5.return語句中，不要有複雜的運算。
   6.switch語句，需要一個預設的分支

 

java開發規範總結_代碼編碼規範