文章目錄
一蒸苇、編程規(guī)約
(一) 命名風格
(二) 常量定義
(三) 代碼格式
(四) OOP 規(guī)約
(五) 日期時間
(六) 集合處理
(七) 并發(fā)處理
(八) 控制語句
(九) 注釋規(guī)約
(十) 其它
二或详、異常日志
(一) 錯誤碼
(二) 異常處理
(三) 日志規(guī)約
三昙楚、單元測試
四蟀拷、安全規(guī)約
五、MySQL 數(shù)據(jù)庫
(一) 建表規(guī)約
(二) 索引規(guī)約
(三) SQL 語句
(四) ORM 映射

一儒恋、編程規(guī)約

(一) 命名風格

-- 包：
【強制】包名統(tǒng)一使用小寫湖笨，點分隔符之間有且僅有一個自然語義的英語單詞。包名統(tǒng)一使用單數(shù)形式灵寺，但是類名如果有復數(shù)含義曼库，類名可以使用復數(shù)形式。
正例：應用工具類包名為 com.alibaba.ei.kunlun.aap.util略板、類名為 MessageUtils（此規(guī)則參考 spring 的框架結構）
-- 類和接口
【強制】類名使用 UpperCamelCase 風格：首字母大寫毁枯，其他字母小寫，若名字由多個單詞組成叮称，則每個單詞的首字母均大寫

但以下情形例外：DO / BO / DTO / VO / AO /PO 等种玛。
DO:(Data Object): 數(shù)據(jù)對象
與數(shù)據(jù)庫表結構一一對應，通過DAO層向上傳輸數(shù)據(jù)源對象瓤檐。
BO(Business Object) 業(yè)務對象
主要作用是把業(yè)務邏輯封裝為一個對象赂韵。這個對象可以包括一個或多個其它的對象。
由Service層輸出的封裝業(yè)務邏輯的對象挠蛉。
如：建立一個對應簡歷的BO對象處理簡歷祭示，每個BO包含多個PO。我們可以把教育經(jīng)歷對應一個PO谴古，
工作經(jīng)歷對應一個PO质涛，社會關系對應一個PO。這樣處理業(yè)務邏輯時掰担，我們就可以針對BO去處理蹂窖。
DTO(Data Transfer Object) 數(shù)據(jù)傳輸對象
Service或Manager向外傳輸?shù)膶ο?br> VO（value Object) 表現(xiàn)對象
value object值對象；ViewObject表現(xiàn)層對象恩敌；主要對應界面顯示的數(shù)據(jù)對象
AO（ Application Object）：應用對象瞬测。
在Web層與Service層之間抽象的復用對象模型，極為貼近展示層纠炮，復用度不高月趟。
PO(Persistent Object) 持久對象
跟bean層一樣，是將數(shù)據(jù)庫數(shù)據(jù)封裝成對象層恢口。持久化對象數(shù)據(jù)孝宗。擁有get/set方法等。
POJO（ Plain Ordinary Java Object）：POJO專指只有setter/getter/toString的簡單類
POJO是DO/DTO/BO/VO的統(tǒng)稱耕肩，禁止命名成xxxPOJO
正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion

【強制】抽象類命名使用 Abstract 或 Base 開頭因妇；異常類命名使用 Exception 結尾问潭；測試類命名以它要測試的類的名稱開始，以 Test 結尾婚被。

【推薦】如果模塊狡忙、接口、類址芯、方法使用了設計模式灾茁，在命名時需體現(xiàn)出具體模式。
說明：將設計模式體現(xiàn)在名字中谷炸，有利于閱讀者快速理解架構設計理念北专。
正例： public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
public class MessageSingleton;

-- 變量和方法：
一般采用Camel 小駝峰命名法：書寫規(guī)范為：首字母小寫，若名字由多個單詞組成旬陡，則只有第一個單詞的首字母小寫拓颓，其他單詞的首字母大寫

【強制】POJO 類中的任何布爾類型的變量，都不要加 is 前綴描孟，否則部分框架解析會引起序列化錯誤驶睦。
說明：在本文 MySQL 規(guī)約中的建表約定第一條，表達是與否的值采用 is_xxx 的命名方式画拾，所以，需要在< resultMap>設置從 is_xxx 到 xxx 的映射關系菜职。
反例：定義為基本數(shù)據(jù)類型 Boolean isDeleted 的屬性青抛，它的方法也是 isDeleted()，框架在反向解析的時候酬核，“誤以為”對應的屬性名稱是 deleted蜜另，導致屬性獲取不到，進而拋出異常嫡意。

【推薦】在常量與變量的命名時举瑰，表示類型的名詞放在詞尾，以提升辨識度蔬螟。

正例：startTime / workQueue / nameList

反例：startedAt / QueueOfWork / listName

【推薦】接口中的方法和屬性不要加任何修飾符號（public 也不要加）此迅，保持代碼的簡潔性，并加上有效的 Javadoc 注釋旧巾。盡量不要在接口里定義變量耸序，如果一定要定義變量，確定與接口方法相關鲁猩，并且是整個應用的基礎常量坎怪。

正例：接口方法簽名 void commit();
接口基礎常量 String COMPANY = "neuedu";

反例：接口方法定義 public abstract void f();

說明：JDK8 中接口允許有默認實現(xiàn)，那么這個 default 方法廓握，是對所有實現(xiàn)類都有價值的默認實現(xiàn)搅窿。

【參考】各層方法命名規(guī)約：

A) Service/DAO 層方法命名規(guī)約
1） 獲取單個對象的方法用 get 做前綴嘁酿。
2） 獲取多個對象的方法用 list 做前綴，復數(shù)結尾男应，如：listObjects闹司。
3） 獲取統(tǒng)計值的方法用 count 做前綴。
4） 插入的方法用 save/insert 做前綴殉了。
5） 刪除的方法用 remove/delete 做前綴开仰。
6） 修改的方法用 update 做前綴。
B) 領域模型命名規(guī)約
領域模型：是對領域內的概念類或現(xiàn)實世界中對象的可視化表示
1） 數(shù)據(jù)對象：xxxDO薪铜，xxx 即為數(shù)據(jù)表名众弓。
2） 數(shù)據(jù)傳輸對象：xxxDTO，xxx 為業(yè)務領域相關的名稱隔箍。
3） 展示對象：xxxVO谓娃，xxx 一般為網(wǎng)頁名稱。
4） POJO 是 DO/DTO/BO/VO 的統(tǒng)稱蜒滩，禁止命名成 xxxPOJO滨达。

(二) 常量定義

【推薦】不要使用一個常量類維護所有常量，要按常量功能進行歸類俯艰，分開維護捡遍。
說明：大而全的常量類，雜亂無章竹握，使用查找功能才能定位到修改的常量画株，不利于理解，也不利于維護啦辐。
正例：緩存相關常量放在類 CacheConsts 下谓传；系統(tǒng)配置相關常量放在類 ConfigConsts 下。

(三) 代碼格式

【強制】單行字符數(shù)限制不超過 120 個芹关，超出需要換行续挟，換行時遵循如下原則：
1）第二行相對第一行縮進 4 個空格，從第三行開始侥衬，不再繼續(xù)縮進诗祸，參考示例。
2）運算符與下文一起換行轴总。
3）方法調用的點符號與下文一起換行贬媒。
4）方法調用中的多個參數(shù)需要換行時，在逗號后進行肘习。
5）在括號前不要換行际乘，見反例。

正例：
StringBuilder sb = new StringBuilder();
// 超過 120 個字符的情況下漂佩，換行縮進 4 個空格脖含，并且方法前的點號一起換行
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...
.append("huang");

反例：
StringBuilder sb = new StringBuilder();
// 超過 120 個字符的情況下罪塔，不要在括號前換行
sb.append("you").append("are")...append
("lucky");
// 參數(shù)很多的方法調用可能超過 120 個字符，逗號后才是換行處
method(args1, args2, args3, ...
, argsX);

【推薦】單個方法的總行數(shù)不超過 80 行养葵。

說明：除注釋之外的方法簽名征堪、左右大括號、方法內代碼关拒、空行佃蚜、回車及任何不可見字符的總行數(shù)不超過80 行。

正例：代碼邏輯分清紅花和綠葉着绊，個性和共性谐算，綠葉邏輯單獨出來成為額外方法，使主干代碼更加清晰归露；共性邏輯抽取成為共性方法洲脂，便于復用和維護。

【推薦】不同邏輯剧包、不同語義恐锦、不同業(yè)務的代碼之間插入一個空行分隔開來以提升可讀性。

說明：任何情形疆液，沒有必要插入多個空行進行隔開一铅。

(四) OOP 規(guī)約

【強制】相同參數(shù)類型，相同業(yè)務含義堕油，才可以使用 Java 的可變參數(shù)潘飘，避免使用 Object 。

說明：可變參數(shù)必須放置在參數(shù)列表的最后馍迄。（提倡同學們盡量不用可變參數(shù)編程）

正例：public List<User> listUsers(String type, Long... ids) {...}

【強制】不能使用過時的類或方法福也。

說明：java.net.URLDecoder 中的方法 decode(String encodeStr) 這個方法已經(jīng)過時局骤，應該使用雙參數(shù)decode(String source, String encode)攀圈。接口提供方既然明確是過時接口，那么有義務同時提供新的接口峦甩；作為調用方來說赘来，有義務去考證過時方法的新實現(xiàn)是什么。

【強制】所有整型包裝類對象之間值的比較凯傲，全部使用 equals 方法比較犬辰。
說明：對于 Integer var = ? 在-128 至 127 之間的賦值，Integer 對象是在 IntegerCache.cache 產(chǎn)生冰单，會復用已有對象幌缝，這個區(qū)間內的 Integer 值可以直接使用==進行判斷，但是這個區(qū)間之外的所有數(shù)據(jù)诫欠，都會在堆上產(chǎn)生涵卵，并不會復用已有對象浴栽，這是一個大坑，推薦使用 equals 方法進行判斷轿偎。

【強制】浮點數(shù)之間的等值判斷典鸡，基本數(shù)據(jù)類型不能用==來比較，包裝數(shù)據(jù)類型不能用 equals來判斷坏晦。
說明：浮點數(shù)采用“尾數(shù)+階碼”的編碼方式萝玷，類似于科學計數(shù)法的“有效數(shù)字+指數(shù)”的表示方式。二進制無法精確表示大部分的十進制小數(shù)昆婿，具體原理參考《碼出高效》球碉。

反例：
float a = 1.0f - 0.9f;
float b = 0.9f - 0.8f;
if (a == b) {
// 預期進入此代碼快，執(zhí)行其它業(yè)務邏輯
// 但事實上 a==b 的結果為 false
}
Float x = Float.valueOf(a);
Float y = Float.valueOf(b);
if (x.equals(y)) {
// 預期進入此代碼快挖诸，執(zhí)行其它業(yè)務邏輯
// 但事實上 equals 的結果為 false
}

正例：
(1) 指定一個誤差范圍汁尺，兩個浮點數(shù)的差值在此范圍之內，則認為是相等的多律。
float a = 1.0f - 0.9f;
float b = 0.9f - 0.8f;
float diff = 1e-6f;
if (Math.abs(a - b) < diff) {
System.out.println("true");
}
(2) 使用 BigDecimal 來定義值痴突，再進行浮點數(shù)的運算操作。
BigDecimal a = new BigDecimal("1.0");
BigDecimal b = new BigDecimal("0.9");
BigDecimal c = new BigDecimal("0.8");
BigDecimal x = a.subtract(b);//減
BigDecimal y = b.subtract(c);//減
if (x.equals(y)) {
System.out.println("true");
}

【強制】禁止使用構造方法 BigDecimal(double) 的方式把 double 值轉化為 BigDecimal 對象狼荞。

說明：BigDecimal(double)存在精度損失風險辽装，在精確計算或值比較的場景中可能會導致業(yè)務邏輯異常。
如：BigDecimal g = new BigDecimal(0.1f); 實際的存儲值為：0.10000000149

正例：優(yōu)先推薦入?yún)?String 的構造方法相味，或使用 BigDecimal 的 valueOf 方法拾积，此方法內部其實執(zhí)行了
Double 的 toString，而 Double 的 toString 按 double 的實際能表達的精度對尾數(shù)進行了截斷丰涉。
BigDecimal recommend1 = new BigDecimal("0.1");
BigDecimal recommend2 = BigDecimal.valueOf(0.1);

關于基本數(shù)據(jù)類型與包裝數(shù)據(jù)類型的使用標準如下：

1） 【強制】所有的 POJO 類屬性必須使用包裝數(shù)據(jù)類型拓巧。
2） 【強制】RPC 方法的返回值和參數(shù)必須使用包裝數(shù)據(jù)類型。
RPC是遠程過程調用的意思
3） 【推薦】所有的局部變量使用基本數(shù)據(jù)類型一死。

說明：POJO 類屬性沒有初值是提醒使用者在需要使用時肛度，必須自己顯式地進行賦值，任何 NPE(空指針異常) 問題投慈，或者入庫檢查承耿，都由使用者來保證。

正例：數(shù)據(jù)庫的查詢結果可能是 null伪煤，因為自動拆箱加袋，用基本數(shù)據(jù)類型接收有 NPE 風險。

反例：某業(yè)務的交易報表上顯示成交總額漲跌情況抱既，即正負 x%职烧，x 為基本數(shù)據(jù)類型，調用的 RPC 服務，調用不成功時蚀之，返回的是默認值跋理，頁面顯示為 0%，這是不合理的恬总，應該顯示成中劃線-前普。所以包裝數(shù)據(jù)類型的 null 值，能夠表示額外的信息壹堰，如：遠程調用失敗拭卿，異常退出。

【強制】定義 DO/DTO/VO 等 POJO 類時贱纠，不要設定任何屬性默認值峻厚。

反例：POJO 類的 createTime 默認值為 new Date()，但是這個屬性在數(shù)據(jù)提取時并沒有置入具體值谆焊，在更新其它字段時又附帶更新了此字段惠桃，導致創(chuàng)建時間被修改成當前時間。

【強制】構造方法里面禁止加入任何業(yè)務邏輯辖试，如果有初始化邏輯辜王，請放在 init 方法中。

【強制】禁止在 POJO 類中罐孝，同時存在對應屬性 xxx 的 isXxx()和 getXxx()方法呐馆。

說明：框架在調用屬性 xxx 的提取方法時，并不能確定哪個方法一定是被優(yōu)先調用到莲兢，神坑之一汹来。

【推薦】使用索引訪問用 String 的 split 方法得到的數(shù)組時，需做最后一個分隔符后有無內容的檢查改艇，否則會有拋 IndexOutOfBoundsException 的風險收班。

說明：
String str = "a,b,c,,";
String[] ary = str.split(",");
// 預期大于 3，結果是 3
System.out.println(ary.length);

【推薦】當一個類有多個構造方法谒兄，或者多個同名方法摔桦，這些方法應該按順序放置在一起，便于閱讀舵变，此條規(guī)則優(yōu)先于下一條酣溃。

【推薦】 類內方法定義的順序依次是：公有方法或保護方法 > 私有方法 > getter / setter方法瘦穆。

說明：公有方法是類的調用者和維護者最關心的方法纪隙，首屏展示最好；保護方法雖然只是子類關心扛或，也可能是“模板設計模式”下的核心方法绵咱；而私有方法外部一般不需要特別關心，是一個黑盒實現(xiàn)熙兔；因為承載的信息價值較低悲伶，所有 Service 和 DAO 的 getter/setter 方法放在類體最后艾恼。

【推薦】循環(huán)體內壤蚜，字符串的連接方式醇疼，使用 StringBuilder 的 append 方法進行擴展纤控。

說明：下例中钻趋，反編譯出的字節(jié)碼文件顯示每次循環(huán)都會 new 出一個 StringBuilder 對象奸披，然后進行 append操作坟比，最后通過 toString 方法返回 String 對象谚鄙，造成內存資源浪費稠曼。

反例：
String str = "start";
for (int i = 0; i < 100; i++) {
str = str + "hello";
}

【推薦】 final 可以聲明類碱屁、成員變量磷脯、方法、以及本地變量娩脾，下列情況使用 final 關鍵字：

1） 不允許被繼承的類赵誓，如：String 類。
2） 不允許修改引用的域對象柿赊，如：POJO 類的域變量俩功。
3） 不允許被覆寫的方法，如：POJO 類的 setter 方法碰声。
4） 不允許運行過程中重新賦值的局部變量绑雄。
5） 避免上下文重復使用一個變量，使用 final 可以強制重新定義一個變量奥邮，方便更好地進行重構万牺。

【推薦】類成員與方法訪問控制從嚴：

1） 如果不允許外部直接通過 new 來創(chuàng)建對象，那么構造方法必須是 private洽腺。
2） 工具類不允許有 public 或 default 構造方法脚粟。
3） 類非 static 成員變量并且與子類共享，必須是 protected蘸朋。
4） 類非 static 成員變量并且僅在本類使用核无，必須是 private。
5） 類 static 成員變量如果僅在本類使用藕坯，必須是 private团南。
6） 若是 static 成員變量，考慮是否為 final炼彪。
7） 類成員方法只供類內部調用吐根，必須是 private。
8） 類成員方法只對繼承類公開辐马，那么限制為 protected拷橘。

說明：任何類、方法、參數(shù)冗疮、變量萄唇，嚴控訪問范圍。過于寬泛的訪問范圍术幔，不利于模塊解耦另萤。思考：如果是一個 private 的方法，想刪除就刪除诅挑，可是一個 public 的 service 成員方法或成員變量仲墨，刪除一下，不得手心冒點汗嗎揍障？變量像自己的小孩目养，盡量在自己的視線內，變量作用域太大毒嫡，無限制的到處跑癌蚁，那么你會擔心的。

(五) 日期時間

【強制】日期格式化時兜畸，傳入 pattern 中表示年份統(tǒng)一使用小寫的 y努释。
說明：日期格式化時，yyyy 表示當天所在的年咬摇，而大寫的 YYYY 代表是 week in which year（JDK7 之后引入的概念）伐蒂，意思是當天所在的周屬于的年份，一周從周日開始肛鹏，周六結束逸邦，只要本周跨年，返回的 YYYY就是下一年在扰。

正例：表示日期和時間的格式如下所示：
new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")

【強制】在日期格式中分清楚大寫的 M 和小寫的 m缕减，大寫的 H 和小寫的 h 分別指代的意義。
說明：日期格式中的這兩對字母表意如下：
1） 表示月份是大寫的 M芒珠；
2） 表示分鐘則是小寫的 m桥狡；
3） 24 小時制的是大寫的 H；
4） 12 小時制的則是小寫的 h皱卓。

【強制】獲取當前毫秒數(shù)：System.currentTimeMillis(); 而不是 new Date().getTime()裹芝。
說明：如果想獲取更加精確的納秒級時間值，使用 System.nanoTime 的方式娜汁。在 JDK8 中嫂易，針對統(tǒng)計時間等場景，推薦使用 Instant 類存炮。

【強制】不允許在程序任何地方中使用：1）java.sql.Date 2）java.sql.Time 3）java.sql.Timestamp炬搭。
說明：第 1 個不記錄時間，getHours()拋出異常穆桂；第 2 個不記錄日期宫盔，getYear()拋出異常；第 3 個在構造方法 super((time/1000)*1000)享完，fastTime 和 nanos 分開存儲秒和納秒信息灼芭。

反例： java.util.Date.after(Date)進行時間比較時，當入?yún)⑹?java.sql.Timestamp 時般又，會觸發(fā) JDK
BUG(JDK9 已修復)彼绷，可能導致比較時的意外結果。

(六) 集合處理

【強制】關于 hashCode 和 equals 的處理茴迁，遵循如下規(guī)則：
1） 只要重寫 equals寄悯，就必須重寫 hashCode。
2） 因為 Set 存儲的是不重復的對象堕义，依據(jù) hashCode 和 equals 進行判斷猜旬，所以 Set 存儲的對象必須重寫這兩個方法。
3） 如果自定義對象作為 Map 的鍵倦卖，那么必須覆寫 hashCode 和 equals洒擦。
說明：String 因為重寫了 hashCode 和 equals 方法，所以我們可以愉快地使用 String 對象作為 key 來使用怕膛。

【強制】ArrayList 的 subList 結果不可強轉成 ArrayList熟嫩，否則會拋出 ClassCastException 異常： java.util.RandomAccessSubList cannot be cast to java.util.ArrayList 。
說明：subList 返回的是 ArrayList 的內部類 SubList褐捻，并不是 ArrayList 而是 ArrayList 的一個視圖掸茅，對于 SubList 子列表的所有操作最終會反映到原列表上。

【強制】使用 Map 的方法 keySet() / values() / entrySet() 返回集合對象時柠逞，不可以對其進行添加元素操作倦蚪，否則會拋出 UnsupportedOperationException 異常。

【強制】在 subList 場景中边苹，高度注意對父集合元素的增加或刪除陵且，均會導致子列表的遍歷、增加个束、刪除產(chǎn)生 ConcurrentModificationException 異常慕购。

【強制】使用集合轉數(shù)組的方法，必須使用集合的 toArray(T[] array)茬底，傳入的是類型完全一致沪悲、長度為 0 的空數(shù)組。

反例：直接使用 toArray 無參方法存在問題阱表，此方法返回值只能是 Object[]類殿如，若強轉其它類型數(shù)組將出現(xiàn)ClassCastException 錯誤贡珊。

正例：
List<String> list = new ArrayList<>(2);
list.add("guan");
list.add("bao");
String[] array = list.toArray(new String[0]);

說明：使用 toArray 帶參方法，數(shù)組空間大小的 length涉馁，
1） 等于 0门岔，動態(tài)創(chuàng)建與 size 相同的數(shù)組，性能最好烤送。
2） 大于 0 但小于 size寒随，重新創(chuàng)建大小等于 size 的數(shù)組，增加 GC 負擔帮坚。
3） 等于 size妻往，在高并發(fā)情況下，數(shù)組創(chuàng)建完成之后试和，size 正在變大的情況下讯泣，負面影響與 2 相同。
4） 大于 size阅悍，空間浪費判帮，且在 size 處插入 null 值，存在 NPE 隱患溉箕。

【強制】在使用 Collection 接口任何實現(xiàn)類的 addAll()方法時晦墙，都要對輸入的集合參數(shù)進行NPE 判斷。

說明：在 ArrayList#addAll 方法的第一行代碼即 Object[] a = c.toArray(); 其中 c 為輸入集合參數(shù)肴茄，如果為 null晌畅，則直接拋出異常。

【強制】不要在 foreach 循環(huán)里進行元素的 remove/add 操作寡痰。remove 元素請使用 Iterator方式抗楔，如果并發(fā)操作，需要對 Iterator 對象加鎖拦坠。

正例：
List<String> list = new ArrayList<>();
list.add("1");
list.add("2");
Iterator<String> iterator = list.iterator();
while (iterator.hasNext()) {
String item = iterator.next();
if (刪除元素的條件) {
iterator.remove();
}
}

反例：
for (String item : list) {
if ("1".equals(item)) {
list.remove(item);
}
}

說明：以上代碼的執(zhí)行結果肯定會出乎大家的意料连躏，那么試一下把“1”換成“2”，會是同樣的結果嗎贞滨？

【強制】在 JDK 7 版本及以上入热， Comparator 實現(xiàn)類要滿足如下三個條件，不然 Arrays . sort 晓铆，Collections . sort 會拋 IllegalArgumentException 異常勺良。

說明：三個條件如下
1） x，y 的比較結果和 y骄噪，x 的比較結果相反尚困。
2） x>y，y>z链蕊，則 x>z事甜。
3） x=y谬泌，則 x，z 比較結果和 y逻谦，z 比較結果相同掌实。

反例：下例中沒有處理相等的情況，交換兩個對象判斷結果并不互反跨跨，不符合第一個條件潮峦，在實際使用中可能會出現(xiàn)異常囱皿。
new Comparator<Student>() {
@Override
public int compare(Student o1, Student o2) {
return o1.getId() > o2.getId() ? 1 : -1;
}
};

【推薦】使用 entrySet 遍歷 Map 類集合 KV 勇婴，而不是 keySet 方式進行遍歷。

說明：keySet 其實是遍歷了 2 次嘱腥，一次是轉為 Iterator 對象耕渴，另一次是從 hashMap 中取出 key 所對應的value。而 entrySet 只是遍歷了一次就把 key 和 value 都放到了 entry 中齿兔，效率更高橱脸。如果是 JDK8，使用Map.forEach 方法分苇。

正例：values()返回的是 V 值集合添诉，是一個 list 集合對象；keySet()返回的是 K 值集合医寿，是一個 Set 集合對象栏赴；entrySet()返回的是 K-V 值組合集合。

【推薦】高度注意 Map 類集合 K/V 能不能存儲 null 值的情況靖秩，如下表格：

集合類 Key Value Super 說明
HashTable 不允許為 null 不允許為 null Dictionary 線程安全
ConcurrentHashMap 不允許為 null 不允許為 null AbstractMap 分段鎖技術
TreeMap 不允許為 null 允許為 null AbstractMap 線程不安全
HashMap 允許為 null 允許為 null AbstractMap 線程不安全
反例： 由于 HashMap 的干擾须眷，很多人認為 ConcurrentHashMap 是可以置入 null 值，而事實上沟突，存儲 null 值時會拋出 NPE 異常花颗。

【參考】合理利用好集合的穩(wěn)定性(order)和有序性(sort)，避免集合的不穩(wěn)定性(unorder)和無序性(unsort)帶來的負面影響惠拭。

說明：有序性是指遍歷的結果是按某種比較規(guī)則依次排列的扩劝。穩(wěn)定性指集合每次遍歷的元素次序是一定的。
如：ArrayList 是 order/unsort职辅；HashMap 是 unorder/unsort今野；TreeSet 是 order/sort。

【參考】利用 Set 元素唯一的特性罐农，可以快速對一個集合進行去重操作条霜，避免使用 List 的contains()進行遍歷去重或者判斷包含操作。

(七) 并發(fā)處理

【強制】創(chuàng)建線程或線程池時請指定有意義的線程名稱涵亏，方便出錯時回溯宰睡。
正例：自定義線程工廠蒲凶，并且根據(jù)外部特征進行分組，比如拆内，來自同一機房的調用旋圆，把機房編號賦值給
whatFeaturOfGroup
public class UserThreadFactory implements ThreadFactory {
private final String namePrefix;
private final AtomicInteger nextId = new AtomicInteger(1);
// 定義線程組名稱，在 jstack 問題排查時麸恍，非常有幫助
UserThreadFactory(String whatFeaturOfGroup) {
namePrefix = "From UserThreadFactory's " + whatFeaturOfGroup + "-Worker-";
}
@Override
public Thread newThread(Runnable task) {
String name = namePrefix + nextId.getAndIncrement();
Thread thread = new Thread(null, task, name, 0, false);
System.out.println(thread.getName());
return thread;
}
}

【強制】線程池不允許使用 Executors 去創(chuàng)建灵巧，而是通過 ThreadPoolExecutor 的方式，這樣的處理方式讓寫的同學更加明確線程池的運行規(guī)則抹沪，規(guī)避資源耗盡的風險刻肄。
說明：Executors 返回的線程池對象的弊端如下：
1） FixedThreadPool 和 SingleThreadPool：
允許的請求隊列長度為 Integer.MAX_VALUE，可能會堆積大量的請求融欧，從而導致 OOM敏弃。
2） CachedThreadPool：
允許的創(chuàng)建線程數(shù)量為 Integer.MAX_VALUE，可能會創(chuàng)建大量的線程噪馏，從而導致 OOM麦到。

【強制】 SimpleDateFormat 是線程不安全的類，一般不要定義為 static 變量欠肾，如果定義為 static 瓶颠，必須加鎖，或者使用 DateUtils 工具類刺桃。
正例：注意線程安全粹淋，使用 DateUtils。亦推薦如下處理：
private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
@Override
protected DateFormat initialValue() {
return new SimpleDateFormat("yyyy-MM-dd");
}
};

說明：如果是 JDK8 的應用虏肾，可以使用 Instant 代替 Date廓啊，LocalDateTime 代替 Calendar，DateTimeFormatter 代替 SimpleDateFormat
官方給出的解釋：simple beautiful strong immutablethread-safe(簡單 美觀 健壯 線程安全)封豪。

【強制】必須回收自定義的 ThreadLocal 變量谴轮，尤其在線程池場景下，線程經(jīng)常會被復用吹埠，如果不清理自定義的 ThreadLocal 變量第步，可能會影響后續(xù)業(yè)務邏輯和造成內存泄露等問題。盡量在代理中使用 try-finally 塊進行回收缘琅。
正例：
objectThreadLocal.set(userInfo);
try {
// ...
} finally {
objectThreadLocal.remove();
}

【強制】對多個資源粘都、數(shù)據(jù)庫表、對象同時加鎖時刷袍，需要保持一致的加鎖順序翩隧，否則可能會造成死鎖。
說明：線程一需要對表 A呻纹、B堆生、C 依次全部加鎖后才可以進行更新操作专缠，那么線程二的加鎖順序也必須是 A、B淑仆、C涝婉，否則可能出現(xiàn)死鎖。

【強制】在使用嘗試機制來獲取鎖的方式中蔗怠，進入業(yè)務代碼塊之前墩弯，必須先判斷當前線程是否持有鎖。鎖的釋放規(guī)則與鎖的阻塞等待方式相同寞射。

說明：Lock 對象的 unlock 方法在執(zhí)行時渔工，它會調用 AQS 的 tryRelease 方法（取決于具體實現(xiàn)類），如果當前線程不持有鎖怠惶，則拋出 IllegalMonitorStateException 異常涨缚。

正例：
Lock lock = new XxxLock();
// ...
boolean isLocked = lock.tryLock();
if (isLocked) {
try {
doSomething();
doOthers();
} finally {
lock.unlock();
}
}

【推薦】避免 Random 實例被多線程使用轧粟，雖然共享該實例是線程安全的策治，但會因競爭同一 seed
導致的性能下降。

說明：Random 實例包括 java.util.Random 的實例或者 Math.random()的方式兰吟。正例：在 JDK7 之后通惫，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前混蔼，需要編碼保證每個線程持有一個單獨的 Random 實例履腋。

【參考】 volatile 解決多線程內存不可見問題。對于一寫多讀惭嚣，是可以解決變量同步問題遵湖，但是如果多寫，同樣無法解決線程安全問題晚吞。

說明：如果是 count++操作延旧，使用如下類實現(xiàn)：
AtomicInteger count = new AtomicInteger();
count.addAndGet(1);
如果是 JDK8，推薦使用 LongAdder 對象槽地，比 AtomicLong 性能更好（減少樂觀鎖的重試次數(shù)）迁沫。

【參考】HashMap 在容量不夠進行 resize 時由于高并發(fā)可能出現(xiàn)死鏈，導致 CPU 飆升捌蚊，在開發(fā)過程中注意規(guī)避此風險集畅。

【參考】ThreadLocal 對象使用 static 修飾，ThreadLocal 無法解決共享對象的更新問題缅糟。

說明：這個變量是針對一個線程內所有操作共享的挺智，所以設置為靜態(tài)變量，所有此類實例共享此靜態(tài)變量窗宦，也就是說在類第一次被使用時裝載赦颇，只分配一塊存儲空間谣辞，所有此類的對象(只要是這個線程內定義的)都可以操控這個變量。

(八) 控制語句

【強制】當 switch 括號內的變量類型為 String 并且此變量為外部參數(shù)時沐扳，必須先進行 null判斷泥从。
反例：如下的代碼輸出是什么？
public class SwitchString {
public static void main(String[] args) {
method(null);
}
public static void method(String param) {
switch (param) {
// 肯定不是進入這里
case "sth":
System.out.println("it's sth");
break;
// 也不是進入這里
case "null":
System.out.println("it's null");
break;
// 也不是進入這里
default:
System.out.println("default");
}
}
}

【強制】三目運算符 condition? 表達式 1 : 表達式 2 中沪摄，高度注意表達式 1 和 2 在類型對齊時躯嫉，可能拋出因自動拆箱導致的 NPE 異常。
說明：以下兩種場景會觸發(fā)類型對齊的拆箱操作：
1） 表達式 1 或表達式 2 的值只要有一個是原始類型杨拐。
2） 表達式 1 或表達式 2 的值的類型不一致祈餐，會強制拆箱升級成表示范圍更大的那個類型。

反例：
Integer a = 1;
Integer b = 2;
Integer c = null;
Boolean flag = false;
// ab 的結果是 int 類型哄陶，那么 c 會強制拆箱成 int 類型帆阳，拋出 NPE 異常
Integer result=(flag? ab : c);

【強制】在高并發(fā)場景中，避免使用”等于”判斷作為中斷或退出的條件屋吨。
說明：如果并發(fā)控制沒有處理好蜒谤，容易產(chǎn)生等值判斷被“擊穿”的情況，使用大于或小于的區(qū)間判斷條件來代替至扰。

反例：判斷剩余獎品數(shù)量等于 0 時鳍徽，終止發(fā)放獎品，但因為并發(fā)處理錯誤導致獎品數(shù)量瞬間變成了負數(shù)敢课，這樣的話阶祭，活動無法終止。

【推薦】當某個方法的代碼行數(shù)超過 10 行時直秆，return / throw 等中斷邏輯的右大括號后加一個空行濒募。
說明：這樣做邏輯清晰，有利于代碼閱讀時重點關注圾结。

【推薦】表達異常的分支時瑰剃，少用 if-else 方式 ，這種方式可以改寫成：
if (condition) {
...
return obj;
}
// 接著寫 else 的業(yè)務邏輯代碼;
說明：如果非使用 if()...else if()...else...方式表達邏輯疫稿，避免后續(xù)代碼維護困難培他，請勿超過 3 層。

正例：超過 3 層的 if-else 的邏輯判斷代碼可以使用衛(wèi)語句遗座、策略模式舀凛、狀態(tài)模式等來實現(xiàn)，其中衛(wèi)語句
衛(wèi)語句就是把復雜的條件表達式拆分成多個條件表達式,減少嵌套途蒋。
示例如下：
public void findBoyfriend (Man man){
if (man.isUgly()) {
System.out.println("本姑娘是外貌協(xié)會的資深會員");
return;
}
if (man.isPoor()) {
System.out.println("貧賤夫妻百事哀");
return;
}
if (man.isBadTemper()) {
System.out.println("銀河有多遠猛遍，你就給我滾多遠");
return;
}
System.out.println("可以先交往一段時間看看");
}

【推薦】除常用方法（如 getXxx/isXxx ）等外，不要在條件判斷中執(zhí)行其它復雜的語句，將復雜邏輯判斷的結果賦值給一個有意義的布爾變量名懊烤，以提高可讀性梯醒。
說明：很多 if 語句內的邏輯表達式相當復雜，與腌紧、或茸习、取反混合運算，甚至各種方法縱深調用壁肋，理解成本非常高号胚。如果賦值一個非常好理解的布爾變量名字，則是件令人爽心悅目的事情浸遗。

正例：
// 偽代碼如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
...
}

反例：
public final void acquire ( long arg){
if (!tryAcquire(arg) &&
acquireQueued(addWaiter(Node.EXCLUSIVE), arg)) {
selfInterrupt();
}

【推薦】不要在其它表達式（尤其是條件表達式）中猫胁，插入賦值語句。
說明：賦值點類似于人體的穴位跛锌，對于代碼的理解至關重要弃秆，所以賦值語句需要清晰地單獨成為一行。

反例：
public Lock getLock(boolean fair) {
// 算術表達式中出現(xiàn)賦值操作髓帽，容易忽略 count 值已經(jīng)被改變
threshold = (count = Integer.MAX_VALUE) - 1;
// 條件表達式中出現(xiàn)賦值操作菠赚，容易誤認為是 sync==fair
return (sync = fair) ? new FairSync() : new NonfairSync();
}

【推薦】循環(huán)體中的語句要考量性能，以下操作盡量移至循環(huán)體外處理氢卡，如定義對象锈至、變量晨缴、獲取數(shù)據(jù)庫連接译秦，進行不必要的 try - catch 操作 （ 這個 try - catch 是否可以移至循環(huán)體外 ） 。

【推薦】避免采用取反邏輯運算符击碗。

說明：取反邏輯不利于快速理解筑悴，并且取反邏輯寫法必然存在對應的正向邏輯寫法。

正例：使用 if (x < 628) 來表達 x 小于 628稍途。

反例：使用 if (!(x >= 628)) 來表達 x 小于 628阁吝。

【推薦】接口入?yún)⒈Ｗo，這種場景常見的是用作批量操作的接口械拍。

反例：某業(yè)務系統(tǒng)突勇，提供一個用戶批量查詢的接口，API 文檔上有說最多查多少個坷虑，但接口實現(xiàn)上沒做任何保護甲馋，導致調用方傳了一個 1000 的用戶 id 數(shù)組過來后，查詢信息后迄损，內存爆了定躏。

【參考】下列情形，需要進行參數(shù)校驗：

1） 調用頻次低的方法。
2） 執(zhí)行時間開銷很大的方法痊远。此情形中垮抗，參數(shù)校驗時間幾乎可以忽略不計，但如果因為參數(shù)錯誤導致
中間執(zhí)行回退碧聪，或者錯誤冒版，那得不償失。
3） 需要極高穩(wěn)定性和可用性的方法逞姿。
4） 對外提供的開放接口壤玫，不管是 RPC/API/HTTP 接口。
5） 敏感權限入口哼凯。

【參考】下列情形欲间，不需要進行參數(shù)校驗：

1） 極有可能被循環(huán)調用的方法。但在方法說明里必須注明外部參數(shù)檢查断部。
2） 底層調用頻度比較高的方法猎贴。畢竟是像純凈水過濾的最后一道，參數(shù)錯誤不太可能到底層才會暴露問題蝴光。一般 DAO 層與 Service 層都在同一個應用中她渴，部署在同一臺服務器中，所以 DAO 的參數(shù)校驗蔑祟，可以省略趁耗。
3） 被聲明成 private 只會被自己代碼所調用的方法，如果能夠確定調用方法的代碼傳入?yún)?shù)已經(jīng)做過檢查或者肯定不會有問題疆虚，此時可以不校驗參數(shù)苛败。

(九) 注釋規(guī)約

【推薦】代碼修改的同時，注釋也要進行相應的修改径簿，尤其是參數(shù)罢屈、返回值、異常篇亭、核心邏輯等的修改缠捌。
說明：代碼與注釋更新不同步，就像路網(wǎng)與導航軟件更新不同步一樣译蒂，如果導航軟件嚴重滯后曼月，就失去了導航的意義。

【參考】對于注釋的要求：

第一柔昼、能夠準確反映設計思想和代碼邏輯 哑芹；
第二、能夠描述業(yè)務含義岳锁，使別的程序員能夠迅速了解到代碼背后的信息绩衷。完全沒有注釋的大段代碼對于閱讀者形同天書蹦魔，注釋是給自己看的，即使隔很長時間咳燕，也能清晰理解當時的思路 勿决； 注釋也是給繼任者看的，使其能夠快速接替自己的工作招盲。

【參考】特殊注釋標記低缩，請注明標記人與標記時間。注意及時處理這些標記曹货，通過標記掃描咆繁，經(jīng)常清理此類標記。線上故障有時候就是來源于這些標記處的代碼顶籽。

1） 待辦事宜（TODO）:（標記人玩般，標記時間，[預計處理時間]）
表示需要實現(xiàn)礼饱，但目前還未實現(xiàn)的功能坏为。這實際上是一個 Javadoc 的標簽，目前的 Javadoc 還沒有實現(xiàn)镊绪，但已經(jīng)被廣泛使用匀伏。只能應用于類，接口和方法（因為它是一個 Javadoc 標簽）蝴韭。
2） 錯誤够颠，不能工作（FIXME）:（標記人，標記時間榄鉴，[預計處理時間]）
在注釋中用 FIXME 標記某代碼是錯誤的焚刺，而且不能工作耕皮，需要及時糾正的情況檀轨。

(十) 其它
【強制】避免用 Apache Beanutils 進行屬性的 copy剥啤。
說明：Apache BeanUtils 性能較差，可以使用其他方案比如 Spring BeanUtils, Cglib BeanCopier减余，注意均是淺拷貝。

【強制】注意 Math . random() 這個方法返回是 double 類型惩系，注意取值的范圍 0≤ x <1 （ 能夠取到零值位岔，注意除零異常 ） ，如果想獲取整數(shù)類型的隨機數(shù)堡牡，不要將 x 放大 10 的若干倍然后取整抒抬，直接使用 Random 對象的 nextInt 或者 nextLong 方法。

【推薦】任何數(shù)據(jù)結構的構造或初始化晤柄，都應指定大小擦剑，避免數(shù)據(jù)結構無限增長吃光內存。

【推薦】及時清理不再使用的代碼段或配置信息。

說明：對于垃圾代碼或過時配置惠勒，堅決清理干凈赚抡，避免程序過度臃腫，代碼冗余纠屋。

正例：對于暫時被注釋掉涂臣，后續(xù)可能恢復使用的代碼片斷，在注釋代碼上方售担，統(tǒng)一規(guī)定使用三個斜杠(///)來說明注釋掉代碼的理由赁遗。如：
public static void hello() {
/// 業(yè)務方通知活動暫停
// Business business = new Business();
// business.active();
System.out.println("it's finished");
}

二、異常日志

(一) 異常處理

【強制】捕獲異常是為了處理它族铆，不要捕獲了卻什么都不處理而拋棄之岩四，如果不想處理它，請將該異常拋給它的調用者哥攘。最外層的業(yè)務使用者炫乓，必須處理異常，將其轉化為用戶可以理解的內容献丑。

【強制】事務場景中末捣，拋出異常被 catch 后，如果需要回滾创橄，一定要注意手動回滾事務箩做。

【強制】finally 塊必須對資源對象、流對象進行關閉妥畏，有異常也要做 try-catch邦邦。

說明：如果 JDK7 及以上，可以使用 try-with-resources 方式醉蚁。

【強制】不要在 finally 塊中使用 return燃辖。
說明：try 塊中的 return 語句執(zhí)行成功后，并不馬上返回网棍，而是繼續(xù)執(zhí)行 finally 塊中的語句黔龟，如果此處存在 return 語句，則在此直接返回滥玷，無情丟棄掉 try 塊中的返回點氏身。

反例：
private int x = 0;
public int checkReturn() {
try {
// x 等于 1，此處不返回
return ++x;
} finally {
// 返回的結果是 2
return ++x;
}
}

【推薦】方法的返回值可以為 null惑畴，不強制返回空集合蛋欣，或者空對象等，必須添加注釋充分說明什么情況下會返回 null 值如贷。

說明：本手冊明確防止 NPE 是調用者的責任陷虎。即使被調用方法返回空集合或者空對象到踏，對調用者來說，也并非高枕無憂尚猿，必須考慮到遠程調用失敗窝稿、序列化失敗、運行時異常等場景返回 null 的情況谊路。

【推薦】防止 NPE 讹躯，是程序員的基本修養(yǎng)，注意 NPE 產(chǎn)生的場景：
1） 返回類型為基本數(shù)據(jù)類型缠劝，return 包裝數(shù)據(jù)類型的對象時潮梯，自動拆箱有可能產(chǎn)生 NPE。
反例：public int f() { return Integer 對象}惨恭， 如果為 null秉馏，自動解箱拋 NPE。
2） 數(shù)據(jù)庫的查詢結果可能為 null脱羡。
3） 集合里的元素即使 isNotEmpty萝究，取出的數(shù)據(jù)元素也可能為 null。
4） 遠程調用返回對象時锉罐，一律要求進行空指針判斷帆竹，防止 NPE。
5） 對于 Session 中獲取的數(shù)據(jù)脓规，建議進行 NPE 檢查栽连，避免空指針。
6） 級聯(lián)調用 obj.getA().getB().getC()侨舆；一連串調用秒紧，易產(chǎn)生 NPE。
正例：使用 JDK8 的 Optional 類來防止 NPE 問題挨下。

【參考】對于公司外的 http/api 開放接口必須使用“錯誤碼”熔恢；而應用內部推薦異常拋出；跨應用間 RPC 調用優(yōu)先考慮使用 Result 方式臭笆，封裝 isSuccess()方法叙淌、“錯誤碼”、“錯誤簡短信息”耗啦；而應用內部推薦異常拋出凿菩。

說明：關于 RPC 方法返回方式使用 Result 方式的理由：
1）使用拋異常返回方式，調用方如果沒有捕獲到就會產(chǎn)生運行時錯誤帜讲。
2）如果不加棧信息，只是 new 自定義異常椒拗，加入自己的理解的 error message似将，對于調用端解決問題
的幫助不會太多获黔。如果加了棧信息，在頻繁調用出錯的情況下在验，數(shù)據(jù)序列化和傳輸?shù)男阅軗p耗也是問題玷氏。

【參考】避免出現(xiàn)重復的代碼 （Don ’ t Repeat Yourself） ，即 DRY 原則腋舌。

說明：隨意復制和粘貼代碼盏触，必然會導致代碼的重復，在以后需要修改時块饺，需要修改所有的副本赞辩，容易遺漏。必要時抽取共性方法授艰，或者抽象公共類辨嗽，甚至是組件化。

正例：一個類中有多個 public 方法淮腾，都需要進行數(shù)行相同的參數(shù)校驗操作糟需，這個時候請抽取：
private boolean checkParam(DTO dto) {...}

四谷朝、安全規(guī)約
【強制】隸屬于用戶個人的頁面或者功能必須進行權限控制校驗洲押。
說明：防止沒有做水平權限校驗就可隨意訪問、修改圆凰、刪除別人的數(shù)據(jù)杈帐，比如查看他人的私信內容。

【強制】用戶敏感數(shù)據(jù)禁止直接展示送朱，必須對展示數(shù)據(jù)進行脫敏娘荡。
說明：中國大陸個人手機號碼顯示為:137****0969，隱藏中間 4 位驶沼，防止隱私泄露炮沐。

【強制】用戶輸入的 SQL 參數(shù)嚴格使用參數(shù)綁定或者 METADATA 字段值限定，防止 SQL 注入回怜，禁止字符串拼接 SQL 訪問數(shù)據(jù)庫大年。
反例：某系統(tǒng)簽名大量被惡意修改，即是因為對于危險字符 # --沒有進行轉義玉雾，導致數(shù)據(jù)庫更新時翔试，where后邊的信息被注釋掉，對全庫進行更新复旬。

【強制】用戶請求傳入的任何參數(shù)必須做有效性驗證垦缅。
說明：忽略參數(shù)校驗可能導致：
page size 過大導致內存溢出
惡意 order by 導致數(shù)據(jù)庫慢查詢
緩存擊穿
SSRF
任意重定向
SQL 注入，Shell 注入驹碍，反序列化注入
正則輸入源串拒絕服務 ReDoS

Java 代碼用正則來驗證客戶端的輸入壁涎，有些正則寫法驗證普通用戶輸入沒有問題凡恍，但是如果攻擊人員使用
的是特殊構造的字符串來驗證，有可能導致死循環(huán)的結果怔球。

【強制】表單嚼酝、 AJAX 提交必須執(zhí)行 CSRF 安全驗證。
說明：CSRF(Cross-site request forgery)跨站請求偽造是一類常見編程漏洞竟坛。對于存在 CSRF 漏洞的應用/網(wǎng)站闽巩，攻擊者可以事先構造好 URL，只要受害者用戶一訪問担汤，后臺便在用戶不知情的情況下對數(shù)據(jù)庫中用戶參數(shù)進行相應修改涎跨。
【強制】URL 外部重定向傳入的目標地址必須執(zhí)行白名單過濾。
【強制】在使用平臺資源漫试，譬如短信六敬、郵件、電話驾荣、下單外构、支付，必須實現(xiàn)正確的防重放的機制播掷，如數(shù)量限制审编、疲勞度控制、驗證碼校驗歧匈，避免被濫刷而導致資損垒酬。

說明：如注冊時發(fā)送驗證碼到手機，如果沒有限制次數(shù)和頻率件炉，那么可以利用此功能騷擾到其它用戶勘究，并造成短信平臺資源浪費。

【推薦】發(fā)貼斟冕、評論口糕、發(fā)送即時消息等用戶生成內容的場景必須實現(xiàn)防刷、文本內容違禁詞過濾等風控策略磕蛇。

五景描、MySQL 數(shù)據(jù)庫

(一) 建表規(guī)約
【強制】表達是與否概念的字段，必須使用 is_xxx 的方式命名秀撇，數(shù)據(jù)類型是 unsigned tinyint（1 表示是超棺，0 表示否）。
說明：任何字段如果為非負數(shù)呵燕，必須是 unsigned棠绘。
注意：POJO 類中的任何布爾類型的變量，都不要加 is 前綴，所以弄唧，需要在<resultMap>設置從 is_xxx 到Xxx 的映射關系适肠。數(shù)據(jù)庫表示是與否的值霍衫，使用 tinyint 類型候引，堅持 is_xxx 的命名方式是為了明確其取值含義與取值范圍。

正例：表達邏輯刪除的字段名 is_deleted敦跌，1 表示刪除澄干，0 表示未刪除。

【強制】表名柠傍、字段名必須使用小寫字母或數(shù)字 麸俘， 禁止出現(xiàn)數(shù)字開頭，禁止兩個下劃線中間只出現(xiàn)數(shù)字惧笛。數(shù)據(jù)庫字段名的修改代價很大从媚，因為無法進行預發(fā)布，所以字段名稱需要慎重考慮患整。
說明：MySQL 在 Windows 下不區(qū)分大小寫拜效，但在 Linux 下默認是區(qū)分大小寫。因此各谚，數(shù)據(jù)庫名紧憾、表名、字段名昌渤，都不允許出現(xiàn)任何大寫字母赴穗，避免節(jié)外生枝。

正例：aliyun_admin膀息，rdc_config般眉，level3_name

反例：AliyunAdmin，rdcConfig潜支，level_3_name

【強制】表名不使用復數(shù)名詞甸赃。
說明：表名應該僅僅表示表里面的實體內容，不應該表示實體數(shù)量毁腿，對應于 DO 類名也是單數(shù)形式辑奈，符合表達習慣。

【強制】小數(shù)類型為 decimal已烤，禁止使用 float 和 double鸠窗。
說明：在存儲的時候，float 和 double 都存在精度損失的問題胯究，很可能在比較值的時候稍计，得到不正確的結果。如果存儲的數(shù)據(jù)范圍超過 decimal 的范圍裕循，建議將數(shù)據(jù)拆成整數(shù)和小數(shù)并分開存儲臣嚣。

【強制】 varchar 是可變長字符串净刮，不預先分配存儲空間，長度不要超過 5000硅则，如果存儲長度大于此值淹父，定義字段類型為 text ，獨立出來一張表怎虫，用主鍵來對應暑认，避免影響其它字段索引效率。
注意varchar代表的字符長度大审，而不是字節(jié) UTF8:一個中文字符3個字節(jié)蘸际，一個英文字符1個字節(jié)

【強制】表必備三字段：id, gmt_create, gmt_modified。
說明：其中 id 必為主鍵徒扶，類型為 bigint unsigned粮彤、單表時自增、步長為 1姜骡。
gmt_create, gmt_modified的類型均為 datetime 類型导坟，前者現(xiàn)在時表示主動式創(chuàng)建，后者過去分詞表示被動式更新溶浴。

【推薦】字段允許適當冗余乍迄，以提高查詢性能，但必須考慮數(shù)據(jù)一致士败。冗余字段應遵循：
1） 不是頻繁修改的字段闯两。
2） 不是唯一索引的字段。
3） 不是 varchar 超長字段谅将，更不能是 text 字段漾狼。

正例：各業(yè)務線經(jīng)常冗余存儲商品名稱，避免查詢時需要調用 IC 服務獲取饥臂。

【推薦】單表行數(shù)超過 500 萬行或者單表容量超過 2GB逊躁，才推薦進行分庫分表。

說明：如果預計三年后的數(shù)據(jù)量根本達不到這個級別隅熙，請不要在創(chuàng)建表時就分庫分表稽煤。
1
(二) 索引規(guī)約
【強制】業(yè)務上具有唯一特性的字段，即使是組合字段囚戚，也必須建成唯一索引酵熙。
說明：不要以為唯一索引影響了 insert 速度，這個速度損耗可以忽略驰坊，但提高查找速度是明顯的匾二；另外，即使在應用層做了非常完善的校驗控制，只要沒有唯一索引察藐，根據(jù)墨菲定律皮璧，必然有臟數(shù)據(jù)產(chǎn)生。

【強制】超過三個表禁止 join 分飞。需要 join 的字段悴务，數(shù)據(jù)類型保持絕對一致 ； 多表關聯(lián)查詢時浸须，保證被關聯(lián)的字段需要有索引惨寿。
說明：即使雙表 join 也要注意表索引、SQL 性能删窒。

【強制】在 varchar 字段上建立索引時，必須指定索引長度顺囊，沒必要對全字段建立索引肌索，根據(jù)實際文本區(qū)分度決定索引長度。
說明：索引的長度與區(qū)分度是一對矛盾體特碳，一般對字符串類型數(shù)據(jù)诚亚，長度為 20 的索引，區(qū)分度會高達 90%以上午乓，可以使用 count(distinct left(列名, 索引長度))/count(*)的區(qū)分度來確定站宗。

【強制】頁面搜索嚴禁左模糊或者全模糊，如果需要請走搜索引擎來解決益愈。
說明：索引文件具有 B-Tree 的最左前綴匹配特性梢灭，如果左邊的值未確定，那么無法使用此索引蒸其。

【推薦】如果有 order by 的場景敏释，請注意利用索引的有序性。order by 最后的字段是組合索引的一部分摸袁，并且放在索引組合順序的最后钥顽，避免出現(xiàn) file_sort 的情況，影響查詢性能靠汁。
正例：where a=? and b=? order by c; 索引：a_b_c

反例：索引如果存在范圍查詢蜂大，那么索引有序性無法利用，如：WHERE a>10 ORDER BY b; 索引 a_b 無法排序蝶怔。

【推薦】利用覆蓋索引來進行查詢操作奶浦，避免回表。
說明：如果一本書需要知道第 11 章是什么標題添谊，會翻開第 11 章對應的那一頁嗎财喳？目錄瀏覽一下就好，這個目錄就是起到覆蓋索引的作用。

正例：能夠建立索引的種類分為主鍵索引耳高、唯一索引扎瓶、普通索引三種，而覆蓋索引只是一種查詢的一種效果泌枪，用 explain 的結果概荷，extra 列會出現(xiàn)：using index。

【推薦】 SQL 性能優(yōu)化的目標：至少要達到 range 級別碌燕，要求是 ref 級別误证，如果可以是 consts最好。
說明：
1） consts 單表中最多只有一個匹配行（主鍵或者唯一索引）修壕，在優(yōu)化階段即可讀取到數(shù)據(jù)愈捅。
2） ref 指的是使用普通的索引（normal index）。
3） range 對索引進行范圍檢索慈鸠。

反例：explain 表的結果蓝谨，type=index，索引物理文件全掃描青团，速度非常慢譬巫，這個 index 級別比較 range還低，與全表掃描是小巫見大巫督笆。

【推薦】建組合索引的時候芦昔，區(qū)分度最高的在最左邊。
正例：如果 where a=? and b=?娃肿，a 列的幾乎接近于唯一值咕缎，那么只需要單建 idx_a 索引即可。

說明：存在非等號和等號混合判斷條件時咸作，在建索引時锨阿，請把等號條件的列前置。如：where c>? and d=?那么即使 c 的區(qū)分度更高记罚，也必須把 d 放在索引的最前列墅诡，即建立組合索引 idx_d_c。

【推薦】防止因字段類型不同造成的隱式轉換桐智，導致索引失效末早。

【參考】創(chuàng)建索引時避免有如下極端誤解：

1） 索引寧濫勿缺。認為一個查詢就需要建一個索引说庭。
2） 吝嗇索引的創(chuàng)建然磷。認為索引會消耗空間、嚴重拖慢記錄的更新以及行的新增速度刊驴。
3） 抵制惟一索引姿搜。認為惟一索引一律需要在應用層通過“先查后插”方式解決寡润。

(三) SQL 語句
【強制】不要使用 count(列名)或 count(常量)來替代 count()，count()是 SQL92 定義的標準統(tǒng)計行數(shù)的語法舅柜，跟數(shù)據(jù)庫無關梭纹，跟 NULL 和非 NULL 無關。
說明：count(*)會統(tǒng)計值為 NULL 的行致份，而 count(列名)不會統(tǒng)計此列為 NULL 值的行变抽。
1
【強制】count(distinct col) 計算該列除 NULL 之外的不重復行數(shù)，注意 count(distinct col1,col2) 如果其中一列全為 NULL氮块，那么即使另一列有不同的值绍载，也返回為 0。

【強制】當某一列的值全是 NULL 時滔蝉，count(col)的返回結果為 0击儡，但 sum(col)的返回結果為NULL，因此使用 sum()時需注意 NPE 問題锰提。

正例：可以使用如下方式來避免 sum 的 NPE 問題：SELECT IFNULL(SUM(column), 0) FROM table;
1
【強制】使用 ISNULL() 來判斷是否為 NULL 值曙痘。
說明：NULL 與任何值的直接比較都為 NULL。
1） NULL<>NULL 的返回結果是 NULL立肘，而不是 false。
2） NULL=NULL 的返回結果是 NULL名扛，而不是 true谅年。
3） NULL<>1 的返回結果是 NULL，而不是 true肮韧。

反例：在 SQL 語句中融蹂，如果在 null 前換行，影響可讀性弄企。select * from table where column1 is null andcolumn3 is not null; 而ISNULL(column)是一個整體超燃，簡潔易懂。從性能數(shù)據(jù)上分析拘领，ISNULL(column)執(zhí)行效率更快一些意乓。

【強制】代碼中寫分頁查詢邏輯時，若 count 為 0 應直接返回约素，避免執(zhí)行后面的分頁語句届良。

【強制】數(shù)據(jù)訂正（特別是刪除或修改記錄操作）時，要先 select 圣猎，避免出現(xiàn)誤刪除士葫，確認無誤才能執(zhí)行更新語句。

【強制】對于數(shù)據(jù)庫中表記錄的查詢和變更送悔，只要涉及多個表慢显，都需要在列名前加表的別名（或表名）進行限定爪模。

說明：對多表進行查詢記錄、更新記錄荚藻、刪除記錄時屋灌，如果對操作列沒有限定表的別名（或表名），并且操作列在多個表中存在時鞋喇，就會拋異常声滥。

正例：select t1.name from table_first as t1 , table_second as t2 where t1.id=t2.id;

反例：在某業(yè)務中，由于多表關聯(lián)查詢語句沒有加表的別名（或表名）的限制侦香，正常運行兩年后落塑，最近在某個表中增加一個同名字段，在預發(fā)布環(huán)境做數(shù)據(jù)庫變更后罐韩，線上查詢語句出現(xiàn)出 1052 異常：Column'name' in field list is ambiguous憾赁。

【推薦】SQL 語句中表的別名前加 as，并且以 t1散吵、t2龙考、t3、…的順序依次命名矾睦。

說明：1）別名可以是表的簡稱晦款，或者是根據(jù)表出現(xiàn)的順序，以 t1枚冗、t2缓溅、t3 的方式命名。2）別名前加 as使別名更容易識別赁温。

正例：select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;

【推薦】 in 操作能避免則避免坛怪，若實在避免不了，需要仔細評估 in 后邊的集合元素數(shù)量股囊，控
制在 1000 個之內袜匿。

【參考】因國際化需要，所有的字符存儲與表示稚疹，均采用 utf 8 字符集居灯，那么字符計數(shù)方法需要注意。

說明：
SELECT LENGTH("輕松工作")贫堰； 返回為 12
SELECT CHARACTER_LENGTH("輕松工作")穆壕； 返回為 4
如果需要存儲表情，那么選擇 utf8mb4 來進行存儲其屏，注意它與 utf8 編碼的區(qū)別喇勋。

(四) ORM 映射
【強制】在表查詢中，一律不要使用 * 作為查詢的字段列表偎行，需要哪些字段必須明確寫明川背。
說明：1）增加查詢分析器解析成本贰拿。2）增減字段容易與 resultMap 配置不一致。3）無用字段增加網(wǎng)絡消耗熄云，尤其是 text 類型的字段膨更。
1
【強制】POJO 類的布爾屬性不能加 is，而數(shù)據(jù)庫字段必須加 is_缴允，要求在 resultMap 中進行字段與屬性之間的映射荚守。
說明：參見定義 POJO 類以及數(shù)據(jù)庫字段定義規(guī)定，在 sql.xml 增加映射练般，是必須的矗漾。

【強制】不要用 resultClass 當返回參數(shù)，即使所有類屬性名與數(shù)據(jù)庫字段一一對應薄料，也需要定義< resultMap>敞贡；反過來，每一個表也必然有一個< resultMap>與之對應摄职。
說明：配置映射關系誊役，使字段與 DO 類解耦，方便維護谷市。

【強制】 iBATIS 自帶的 queryForList(String statementName , int start , int size) 不推薦使用蛔垢。
說明：其實現(xiàn)方式是在數(shù)據(jù)庫取到 statementName 對應的 SQL 語句的所有記錄，再通過 subList 取start,size 的子集合迫悠。

正例：
Map<String, Object> map = new HashMap<>();
map.put("start", start);
map.put("size", size);

【強制】不允許直接拿 HashMap 與 Hashtable 作為查詢結果集的輸出啦桌。
反例：某同學為避免寫一個<resultMap>，直接使用 HashTable 來接收數(shù)據(jù)庫返回結果及皂，結果出現(xiàn)日常是把 bigint 轉成 Long 值，而線上由于數(shù)據(jù)庫版本不一樣且改，解析成 BigInteger验烧，導致線上問題。

【推薦】不要寫一個大而全的數(shù)據(jù)更新接口又跛。傳入為 POJO 類碍拆，不管是不是自己的目標更新字段，都進行 update table set c1=value1,c2=value2,c3=value3; 這是不對的慨蓝。執(zhí)行 SQL 時感混，不要更新無改動的字段，一是易出錯礼烈；二是效率低弧满；三是增加 binlog 存儲。

【參考】@Transactional 事務不要濫用此熬。事務會影響數(shù)據(jù)庫的 QPS庭呜，另外使用事務的地方需要考慮各方面的回滾方案滑进，包括緩存回滾、搜索引擎回滾募谎、消息補償扶关、統(tǒng)計修正等。

【參考】< isEqual>中的 compareValue 是與屬性值對比的常量数冬，一般是數(shù)字节槐，表示相等時帶上此條件；< isNotEmpty>表示不為空且不為 null 時執(zhí)行拐纱；< isNotNull>表示不為 null 值時執(zhí)行铜异。