1. 程式人生 > >java程式設計規範筆記(一)

java程式設計規範筆記(一)

1. 命名風格

    程式碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束

    程式碼中的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式

    類名使用UpperCamelCase風格,必須遵從駝峰形式

    方法名、引數名、成員變數、區域性變數都統一遵從駝峰形式

    常量命名全部大寫,單詞間用下劃線隔開

    抽象類命名使用Abstract或Base開頭;異常類命名使用Exception結尾;測試類命名以它要測試的類的名稱開始,以Test結尾

    包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用單數形式,但是類名如果有複數含義,類名可以使用複數形式

    列舉類名建議帶上Enum字尾,列舉成員名稱需要全大寫,單詞間用下劃線隔開。

    各層命名規約:

      A) Service/DAO層方法命名規約

        1) 獲取單個物件的方法用get做字首。

        2) 獲取多個物件的方法用list做字首。

        3) 獲取統計值的方法用count做字首。

        4) 插入的方法用save/insert做字首。

        5) 刪除的方法用remove/delete做字首。

        6) 修改的方法用update做字首。

PO 持久物件,資料; BO 業務物件,封裝物件、複雜物件 ,裡面可能包含多個類; DTO 傳輸物件,前端呼叫時傳輸 ; VO 表現物件,前端介面展示。

  B) 領域模型命名規約

    1) 資料物件:xxxDO,xxx即為資料表名。

    2) 資料傳輸物件:xxxDTO,xxx為業務領域相關的名稱。

    3) 展示物件:xxxVO,xxx一般為網頁名稱。

    4) POJO是DO/DTO/BO/VO的統稱,禁止命名成xxxPOJO。