【正文】 規(guī)約條目的延伸信息中，“說(shuō)明”對(duì)內(nèi)容做了引申和解釋?zhuān)弧罢碧岢裁礃拥木?碼和實(shí)現(xiàn)方式；“反例”說(shuō)明需要提防的雷區(qū)，以及真實(shí)的錯(cuò)誤案例?，F(xiàn)代軟件行業(yè)的高速 發(fā)展對(duì)開(kāi)發(fā)者的綜合素質(zhì)要求越來(lái)越高，因?yàn)椴粌H是編程知識(shí)點(diǎn)，其它維度的知識(shí)點(diǎn) 也會(huì)影響到軟件的最終交付質(zhì)量。比如：數(shù)據(jù)庫(kù)的表結(jié)構(gòu)和索引設(shè)計(jì)缺陷可能帶來(lái)軟 件上的架構(gòu)缺陷或性能風(fēng)險(xiǎn)；工程結(jié)構(gòu)混亂導(dǎo)致后續(xù)維護(hù)艱難；沒(méi)有鑒權(quán)的漏洞代碼 易被黑客攻擊等等。本手冊(cè)的愿景是碼出高效、碼出質(zhì)量。試想如果沒(méi)有限速，沒(méi)有紅綠燈，誰(shuí)還敢上路行駛。目錄前言一、編程規(guī)約 ........................................................................ 1(一) 命名風(fēng)格 ................................................................................................................................................................1(二) 常量定義 ................................................................................................................................................................3(三) 代碼格式 ................................................................................................................................................................4(四) OOP 規(guī)約 6(五) 集合處理 ................................................................................................................................................................9(六) 并發(fā)處理 .............................................................................................................................................................11(七) 控制語(yǔ)句 .............................................................................................................................................................14(八) 注釋規(guī)約 .............................................................................................................................................................15(九) 其它 .......................................................................................................................................................................17 二、異常日志 ....................................................................... 18 (一) 異常處理 .............................................................................................................................................................18(二) 日志規(guī)約 .............................................................................................................................................................19 三、MySQL 數(shù)據(jù)庫(kù) .................................................................. 21 (一) 建表規(guī)約 .............................................................................................................................................................21(二) 索引規(guī)約 .............................................................................................................................................................22(三) SQL 語(yǔ)句 24(四) ORM 映射 25四、工程結(jié)構(gòu) ....................................................................... 27(一) 應(yīng)用分層 .............................................................................................................................................................27(二) 二方庫(kù)依賴(lài).........................................................................................................................................................28(三) 服務(wù)器 ..................................................................................................................................................................29五、安全規(guī)約 ....................................................................... 31附 1：版本歷史 ..................................................................... 32附 2：本手冊(cè)專(zhuān)有名詞 ............................................................... 33（注：瀏覽時(shí)請(qǐng)使用 PDF 左側(cè)導(dǎo)航欄）阿里巴巴 Java 開(kāi)發(fā)手冊(cè)Java 開(kāi)發(fā)手冊(cè)版本號(hào)制定團(tuán)隊(duì)更新日期備注阿里巴巴集團(tuán)技術(shù)團(tuán)隊(duì)公開(kāi)征集意見(jiàn)后的修正版本。注意，即使純拼音命名方式 也要避免采用。正例： MAX_STOCK_COUNT反例： MAX_COUNT6. 【強(qiáng)制】抽象類(lèi)命名使用 Abstract 或 Base 開(kāi)頭；異常類(lèi)命名使用 Exception 結(jié)尾；測(cè)試類(lèi) 命名以它要測(cè)試的類(lèi)的名稱(chēng)開(kāi)始，以 Test 結(jié)尾。反例：定義為基本數(shù)據(jù)類(lèi)型 Boolean isDeleted；的屬性，它的方法也是 isDeleted()，RPC——禁止用于商業(yè)用途，違者必究——13 / 33框架在反向解析的時(shí)候，“以為”對(duì)應(yīng)的屬性名稱(chēng)是 deleted，導(dǎo)致屬性獲取不到，進(jìn)而拋出異 常。反例： AbstractClass“縮寫(xiě)”命名成 AbsClass；condition“縮寫(xiě)”命名成 condi，此類(lèi) 隨意縮寫(xiě)嚴(yán)重降低了代碼的可閱讀性。public class LoginProxy。正例：接口方法簽名：void f()。13. 接口和實(shí)現(xiàn)類(lèi)的命名有兩套規(guī)則：1）【強(qiáng)制】對(duì)于 Service 和 DAO 類(lèi)，基于 SOA 的理念，暴露出來(lái)的服務(wù)一定是接口，內(nèi)部 的實(shí)現(xiàn)類(lèi)用 Impl 的后綴與接口區(qū)別。14. 【參考】枚舉類(lèi)名建議帶上 Enum 后綴，枚舉成員名稱(chēng)需要全大寫(xiě)，單詞間用下劃線(xiàn)隔開(kāi)。2） 獲取多個(gè)對(duì)象的方法用 list 做前綴。 6） 修改的方法用 update 做前綴。4） POJO 是 DO/DTO/BO/VO 的統(tǒng)稱(chēng)，禁止命名成 xxxPOJO。2. 【強(qiáng)制】long 或者 Long 初始賦值時(shí)，必須使用大寫(xiě)的 L，不能是小寫(xiě)的 l，小寫(xiě)容易跟數(shù)字1 混淆，造成誤解。 說(shuō)明：大而全的常量類(lèi)，非得使用查找功能才能定位到修改的常量，不利于理解和維護(hù)。反例：易懂變量也要統(tǒng)一定義成應(yīng)用內(nèi)共享常量，兩位攻城師在兩個(gè)類(lèi)中分別定義了表示“是”的變量：類(lèi) A 中：public static final String YES = yes。4） 包內(nèi)共享常量：即在當(dāng)前包下單獨(dú)的 constant 目錄下。正例：public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7)。3） 右大括號(hào)前換行。反例：if (空格 a == b 空格)3. 【強(qiáng)制】if/for/while/switch/do 等保留字與括號(hào)之間都必須加空格。、加減乘除符號(hào)等。正例： （涉及 15 點(diǎn)）public static void main(String[] args) {// 縮進(jìn) 4 個(gè)空格String say = hello。// 右大括號(hào)前換行，右大括號(hào)后有 else，不用換行} else {(ok)。4） 在多個(gè)參數(shù)超長(zhǎng)，在逗號(hào)后換行。反例：StringBuffer sb = new StringBuffer()。正例：下例中實(shí)參的a,后邊必須要有一個(gè)空格。9. 【推薦】沒(méi)有必要增加若干空格來(lái)使某一行的字符與上一行對(duì)應(yīng)位置的字符對(duì)齊。StringBuffer sb = new StringBuffer()。 說(shuō)明：沒(méi)有必要插入多個(gè)空行進(jìn)行隔開(kāi)。一個(gè)是字母的 O，一個(gè)是數(shù)字的 0，加Override 可以準(zhǔn)確判斷是否覆蓋成功。（提倡同學(xué)們盡量不用可變參數(shù)編程） 正例：public User getUsers(String type, Integer... ids) {...}4. 【強(qiáng)制】外部正在調(diào)用或者二方庫(kù)依賴(lài)的接口，不允許修改方法簽名，避免對(duì)接口調(diào)用方產(chǎn)生 影響。接口提供方既然明確是過(guò)時(shí)接口， 那么有義務(wù)同時(shí)提供新的接口；作為調(diào)用方來(lái)說(shuō)，有義務(wù)去考證過(guò)時(shí)方法的新實(shí)現(xiàn)是什么。說(shuō)明：推薦使用 equals （JDK7 引入的工具類(lèi)）7. 【強(qiáng)制】所有的相同類(lèi)型的包裝類(lèi)對(duì)象之間值的比較，全部使用 equals 方法比較。3） 【推薦】所有的局部變量使用基本數(shù)據(jù)類(lèi)型。所以包裝 數(shù)據(jù)類(lèi)型的 null 值，能夠表示額外的信息，如：遠(yuǎn)程調(diào)用失敗，異常退出。10. 【強(qiáng)制】序列化類(lèi)新增屬性時(shí)，請(qǐng)不要修改 serialVersionUID 字段，避免反序列失?。蝗?果完全不兼容升級(jí)，避免反序列化混亂，那么請(qǐng)修改 serialVersionUID 值。使用 IDE 的中工具：source generate toString 時(shí)，如果繼承了另一個(gè) POJO 類(lèi)，注意在前面加一下 。String[] ary = (,)。 說(shuō)明：公有方法是類(lèi)的調(diào)用者和維護(hù)者最關(guān)心的方法，首屏展示最好；保護(hù)方法雖然只是子類(lèi) 關(guān)心，也可能是“模板設(shè)計(jì)模式”下的核心方法；而私有方法外部一般不需要特別關(guān)心，是一個(gè) 黑盒實(shí)現(xiàn)；因?yàn)榉椒ㄐ畔r(jià)值較低，所有 Service 和 DAO 的 getter/setter 方法放在類(lèi)體最 后。} else {return 100。for (int i = 0。2） 不允許修改引用的域?qū)ο螅纾篜OJO 類(lèi)的域變量。19. 【推薦】慎用 Object 的 clone 方法來(lái)拷貝對(duì)象。3） 類(lèi)非 static 成員變量并且與子類(lèi)共享，必須是 protected。7） 類(lèi)成員方法只供類(lèi)內(nèi)部調(diào)用，必須是 private。 思考：如果是一個(gè) private 的方法，想刪除就刪除，可是一個(gè) public