(一)命名風(fēng)格
3. 【強制】類名使用 UpperCamelCase 風(fēng)格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID?等惭笑。
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
6. 【強制】抽象類命名使用 Abstract 或 Base 開頭侣姆；異常類命名使用 Exception 結(jié)尾；測試類 命名以它要測試的類的名稱開始沉噩，以 Test 結(jié)尾捺宗。
7. 【強制】類型與中括號緊挨相連來表示數(shù)組。
正例：定義整形數(shù)組 int[] arrayDemo;
反例：在 main 參數(shù)中屁擅，使用 String args[]來定義偿凭。
8. 【強制】POJO 類中布爾類型的變量，都不要加 is 前綴派歌，否則部分框架解析會引起序列化錯誤弯囊。
反例：定義為基本數(shù)據(jù)類型 Boolean isDeleted 的屬性，它的方法也是 isDeleted()胶果，RPC 阿里巴巴 Java 開發(fā)手冊 2/38 框架在反向解析的時候匾嘱，“誤以為”對應(yīng)的屬性名稱是 deleted，導(dǎo)致屬性獲取不到早抠，進(jìn)而拋 出異常霎烙。
9. 【強制】包名統(tǒng)一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞蕊连。包名統(tǒng)一使用 單數(shù)形式悬垃，但是類名如果有復(fù)數(shù)含義，類名可以使用復(fù)數(shù)形式甘苍。 正例：應(yīng)用工具類包名為 com.alibaba.ai.util尝蠕、類名為 MessageUtils（此規(guī)則參考 spring 的框架結(jié)構(gòu)）
13. 【推薦】接口類中的方法和屬性不要加任何修飾符號（public 也不要加），保持代碼的簡潔 性载庭，并加上有效的 Javadoc 注釋看彼。盡量不要在接口里定義變量，如果一定要定義變量囚聚，肯定是 與接口方法相關(guān)靖榕，并且是整個應(yīng)用的基礎(chǔ)常量。 正例：接口方法簽名 void commit(); 接口基礎(chǔ)常量 String COMPANY = "alibaba"; 反例：接口方法定義 public abstract void f(); 說明：JDK8 中接口允許有默認(rèn)實現(xiàn)顽铸，那么這個 default 方法茁计，是對所有實現(xiàn)類都有價值的默 認(rèn)實現(xiàn)。
14. 接口和實現(xiàn)類的命名有兩套規(guī)則：
1）【強制】對于 Service 和 DAO 類谓松，基于 SOA 的理念星压，暴露出來的服務(wù)一定是接口瓶蝴，內(nèi)部 的實現(xiàn)類用 Impl 的后綴與接口區(qū)別。 正例：CacheServiceImpl 實現(xiàn) CacheService 接口租幕。
2）【推薦】如果是形容能力的接口名稱舷手，取對應(yīng)的形容詞為接口名（通常是–able 的形式）。 正例：AbstractTranslator 實現(xiàn) Translatable 接口劲绪。
15. 【參考】枚舉類名建議帶上 Enum 后綴男窟，枚舉成員名稱需要全大寫，單詞間用下劃線隔開贾富。 說明：枚舉其實就是特殊的類歉眷，域成員均為常量，且構(gòu)造方法被默認(rèn)強制是私有颤枪。 正例：枚舉名字為 ProcessStatusEnum 的成員名稱：SUCCESS / UNKNOWN_REASON汗捡。
16. 【參考】各層命名規(guī)約：
A) Service/DAO 層方法命名規(guī)約
1） 獲取單個對象的方法用 get 做前綴。
2） 獲取多個對象的方法用 list 做前綴畏纲，復(fù)數(shù)形式結(jié)尾如：listObjects扇住。
3） 獲取統(tǒng)計值的方法用 count 做前綴。
4） 插入的方法用 save/insert 做前綴盗胀。
5） 刪除的方法用 remove/delete 做前綴艘蹋。
6） 修改的方法用 update 做前綴。
B) 領(lǐng)域模型命名規(guī)約
1） 數(shù)據(jù)對象：xxxDO票灰，xxx 即為數(shù)據(jù)表名女阀。
2） 數(shù)據(jù)傳輸對象：xxxDTO，xxx 為業(yè)務(wù)領(lǐng)域相關(guān)的名稱屑迂。
3） 展示對象：xxxVO浸策，xxx 一般為網(wǎng)頁名稱。
4） POJO 是 DO/DTO/BO/VO 的統(tǒng)稱惹盼，禁止命名成 xxxPOJO庸汗。
(二)常量定義
3. 【推薦】不要使用一個常量類維護(hù)所有常量，要按常量功能進(jìn)行歸類逻锐，分開維護(hù)夫晌。 說明：大而全的常量類雕薪，雜亂無章昧诱，使用查找功能才能定位到修改的常量，不利于理解和維護(hù)所袁。
正例：緩存相關(guān)常量放在類 CacheConsts 下盏档；系統(tǒng)配置相關(guān)常量放在類 ConfigConsts 下。
4. 【推薦】常量的復(fù)用層次有五層：跨應(yīng)用共享常量燥爷、應(yīng)用內(nèi)共享常量蜈亩、子工程內(nèi)共享常量懦窘、包 內(nèi)共享常量、類內(nèi)共享常量稚配。
1） 跨應(yīng)用共享常量：放置在二方庫中畅涂，通常是 client.jar 中的 constant 目錄下。
2） 應(yīng)用內(nèi)共享常量：放置在一方庫中道川，通常是子模塊中的 constant 目錄下午衰。
反例：易懂變量也要統(tǒng)一定義成應(yīng)用內(nèi)共享常量，兩位攻城師在兩個類中分別定義了表示 “是”的變量：
類 A 中：public static final String YES = "yes";
類 B 中：public static final String YES = "y"; A.YES.equals(B.YES)冒萄，預(yù)期是 true臊岸，但實際返回為 false，導(dǎo)致線上問題尊流。
3） 子工程內(nèi)部共享常量：即在當(dāng)前子工程的 constant 目錄下帅戒。
4） 包內(nèi)共享常量：即在當(dāng)前包下單獨的 constant 目錄下。
5） 類內(nèi)共享常量：直接在類內(nèi)部 private static final 定義崖技。
(三)代碼格式
1. 【強制】大括號的使用約定逻住。如果是大括號內(nèi)為空，則簡潔地寫成{}即可迎献，不需要換行鄙信；如果 是非空代碼塊則：
1） 左大括號前不換行。
2） 左大括號后換行忿晕。
3） 右大括號前換行装诡。
4） 右大括號后還有 else 等代碼則不換行；表示終止的右大括號后必須換行践盼。
2. 【強制】左小括號和字符之間不出現(xiàn)空格鸦采；同樣，右小括號和字符之間也不出現(xiàn)空格咕幻；而左大 括號前需要空格渔伯。詳見第 5 條下方正例提示。 反例：if (空格 a == b 空格)
3. 【強制】if/for/while/switch/do 等保留字與括號之間都必須加空格肄程。
4. 【強制】任何二目锣吼、三目運算符的左右兩邊都需要加一個空格。 說明：運算符包括賦值運算符=蓝厌、邏輯運算符&&玄叠、加減乘除符號等。
5. 【強制】采用 4 個空格縮進(jìn)拓提，禁止使用 tab 字符读恃。 說明：如果使用 tab 縮進(jìn)，必須設(shè)置 1 個 tab 為 4 個空格。IDEA 設(shè)置 tab 為 4 個空格時寺惫， 請勿勾選 Use tab character疹吃；而在 eclipse 中，必須勾選 insert spaces for tabs西雀。
7. 【強制】單行字符數(shù)限制不超過 120 個萨驶，超出需要換行，換行時遵循如下原則：
1） 第二行相對第一行縮進(jìn) 4 個空格艇肴，從第三行開始篡撵，不再繼續(xù)縮進(jìn)，參考示例豆挽。
2） 運算符與下文一起換行育谬。
3） 方法調(diào)用的點符號與下文一起換行。
4） 方法調(diào)用中的多個參數(shù)需要換行時帮哈，在逗號后進(jìn)行膛檀。
5）?在括號前不要換行，見反例娘侍。
8. 【強制】方法參數(shù)在定義和傳入時咖刃，多個參數(shù)逗號后邊必須加空格。 正例：下例中實參的 args1憾筏，后邊必須要有一個空格嚎杨。 method(args1, args2, args3);
9. 【強制】IDE 的 text file encoding 設(shè)置為 UTF-8; IDE 中文件的換行符使用 Unix 格式， 不要使用 Windows 格式氧腰。
10. 【推薦】單個方法的總行數(shù)不超過 80 行枫浙。
說明：包括方法簽名、結(jié)束右大括號古拴、方法內(nèi)代碼箩帚、注釋、空行黄痪、回車及任何不可見字符的總 行數(shù)不超過 80 行紧帕。
正例：代碼邏輯分清紅花和綠葉，個性和共性桅打，綠葉邏輯單獨出來成為額外方法是嗜，使主干代碼 更加清晰；共性邏輯抽取成為共性方法挺尾，便于復(fù)用和維護(hù)鹅搪。
12. 【推薦】不同邏輯、不同語義潦嘶、不同業(yè)務(wù)的代碼之間插入一個空行分隔開來以提升可讀性涩嚣。 說明：任何情形，沒有必要插入多個空行進(jìn)行隔開掂僵。
鏈接：https://www.cnblogs.com/Pusteblume/p/10211083.html
來源：博客園
著作權(quán)歸作者所有航厚。商業(yè)轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)，非商業(yè)轉(zhuǎn)載請注明出處锰蓬。
