Java開發命名規範總結

類命名規範：

類名使用 UpperCamelCase 風格（首字母都大寫），必須遵從駝峰形式。 例如： MessageUtil

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

對于 Service 和 DAO 類，基于 SOA 的理念，暴露出來的服務一定是接口，内部的實作類用 Impl 的字尾與接口差別。

推薦實體類沒有字尾名。

POJO 類中布爾類型的變量，都不要加 is ，否則部分架構解析會引起序列化錯誤。

其他：

方法名、參數名、成員變量、局部變量都統一使用 lowerCamelCase 風格（第一個單詞首字母小寫，其他單詞首字母大寫），必須遵從駝峰形式。 例如： myFirstName

常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。 例如：MAX_NAME_LENGTH

推薦使用公司或機構的頂級域名為包名的字首，目的是保證各公司/機構内所使用的包名的唯一性

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

實際應用中：

　　各層命名規約：

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

　　　　1 ） 擷取單個對象的方法用 get 做字首。

　　　　2 ） 擷取多個對象的方法用 list 做字首。

　　　　3 ） 擷取統計值的方法用 count 做字首。

　　　　4 ） 插入的方法用 save（ 推薦 ） 或 insert 做字首。

　　　　5 ） 删除的方法用 remove（ 推薦 ） 或 delete 做字首。

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

　　B) 領域模型命名規約

　　　　1 ） 資料對象： xxxDO ， xxx 即為資料表名。

　　　　2 ） 資料傳輸對象： xxxDTO ， xxx 為業務領域相關的名稱。

　　　　3 ） 展示對象： xxxVO ， xxx 一般為網頁名稱。

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

推薦：

如果使用到了設計模式，建議在類名中展現出具體模式。

接口類中的方法和屬性不要加任何修飾符号 （public 也不要加 ） ，保持代碼的簡潔性，并加上有效的 Javadoc 注釋。盡量不要在接口裡定義變量，如果一定要定義變量，肯定是與接口方法相關，并且是整個應用的基礎常量。

注釋的書寫規範 （Javadoc）

Java除了可以采用我們常見的注釋方式（//、/* */）之外，Java語言規範還定義了一種特殊的注釋，也就是我們所說的Javadoc注釋，以/**開頭，而以*/結束， Javadoc 注釋可以被自動轉為線上文檔，省去了單獨編寫程式文檔的麻煩。 推薦使用。

Javadoc注釋主要涉及範圍：類、屬性、方法。