(一) 建表規約
1. 【強制】表達是與否概念的字段,必須使用 is _ xxx 的方式命名,數據類型是 unsigned tinyint
( 1 表示是,0 表示否 ) ,此規則同樣適用於 odps 建表。
說明:任何字段如果爲非負數,必須是 unsigned 。
2. 【強制】表名、字段名必須使用小寫字母或數字 ; 禁止出現數字開頭,禁止兩個下劃線中間只
出現數字。數據庫字段名的修改代價很大,因爲無法進行預發佈,所以字段名稱需要慎重考慮。
正例: getter _ admin , task _ config , level 3_ name
反例: GetterAdmin , taskConfig , level _3_ name
3. 【強制】表名不使用複數名詞。
說明:表名應該僅僅表示表裏面的實體內容,不應該表示實體數量,對應於 DO 類名也是單數
形式,符合表達習慣。
4. 【強制】禁用保留字,如 desc 、 range 、 match 、 delayed 等,請參考 MySQL 官方保留字。
5. 【強制】唯一索引名爲 uk _字段名 ; 普通索引名則爲 idx _字段名。
說明: uk _ 即 unique key;idx _ 即 index 的簡稱。
6. 【強制】小數類型爲 decimal ,禁止使用 float 和 double 。
說明: float 和 double 在存儲的時候,存在精度損失的問題,很可能在值的比較時,得到不
正確的結果。如果存儲的數據範圍超過 decimal 的範圍,建議將數據拆成整數和小數分開存儲。
7. 【強制】如果存儲的字符串長度幾乎相等,使用 char 定長字符串類型。
8. 【強制】 varchar 是可變長字符串,不預先分配存儲空間,長度不要超過 5000,如果存儲長
度大於此值,定義字段類型爲 text ,獨立出來一張表,用主鍵來對應,避免影響其它字段索
引效率。
9. 【強制】表必備三字段: id , gmt _ create , gmt _ modified 。
說明:其中 id 必爲主鍵,類型爲 unsigned bigint 、單表時自增、步長爲 1。 gmt _ create ,
gmt _ modified 的類型均爲 date _ time 類型。
10. 【推薦】表的命名最好是加上“業務名稱_表的作用”。
正例: tiger _ task / tiger _ reader / mpp _ config
11. 【推薦】庫名與應用名稱儘量一致。
12. 【推薦】如果修改字段含義或對字段表示的狀態追加時,需要及時更新字段註釋。
13. 【推薦】字段允許適當冗餘,以提高性能,但是必須考慮數據同步的情況。冗餘字段應遵循:
1 ) 不是頻繁修改的字段。
2 ) 不是 varchar 超長字段,更不能是 text 字段。
正例:商品類目名稱使用頻率高,字段長度短,名稱基本一成不變,可在相關聯的表中冗餘存
儲類目名稱,避免關聯查詢。
14. 【推薦】單錶行數超過 500 萬行或者單表容量超過 2 GB ,才推薦進行分庫分表。
說明:如果預計三年後的數據量根本達不到這個級別,請不要在創建表時就分庫分表。
15. 【參考】合適的字符存儲長度,不但節約數據庫表空間、節約索引存儲,更重要的是提升檢
索速度。
正例:人的年齡用 unsigned tinyint( 表示範圍 0-255,人的壽命不會超過 255 歲 ); 海龜
就必須是 smallint ,但如果是太陽的年齡,就必須是 int; 如果是所有恆星的年齡都加起來,
那麼就必須使用 bigint 。
(二) 索引規約
1. 【強制】業務上具有唯一特性的字段,即使是組合字段,也必須建成唯一索引。
說明:不要以爲唯一索引影響了 insert 速度,這個速度損耗可以忽略,但提高查找速度是明
顯的 ; 另外,即使在應用層做了非常完善的校驗和控制,只要沒有唯一索引,根據墨菲定律,
必然有髒數據產生。
2. 【強制】 超過三個表禁止 join 。需要 join 的字段,數據類型保持絕對一致 ; 多表關聯查詢
時,保證被關聯的字段需要有索引。
說明:即使雙表 join 也要注意表索引、 SQL 性能。
3. 【強制】在 varchar 字段上建立索引時,必須指定索引長度,沒必要對全字段建立索引,根據
實際文本區分度決定索引長度。
說明:索引的長度與區分度是一對矛盾體,一般對字符串類型數據,長度爲 20 的索引,區分
度會高達 90%以上,可以使用 count(distinct left( 列名, 索引長度 )) / count( * ) 的區分度
來確定。
4. 【強制】頁面搜索嚴禁左模糊或者全模糊,如果需要請走搜索引擎來解決。
說明:索引文件具有 B - Tree 的最左前綴匹配特性,如果左邊的值未確定,那麼無法使用此索
引。
5. 【推薦】如果有 order by 的場景,請注意利用索引的有序性。 order by 最後的字段是組合
索引的一部分,並且放在索引組合順序的最後,避免出現 file _ sort 的情況,影響查詢性能。
正例: where a =? and b =? order by c; 索引: a _ b _ c
反例:索引中有範圍查找,那麼索引有序性無法利用,如: WHERE a >10 ORDER BY b; 索引
a _ b 無法排序。
6. 【推薦】利用覆蓋索引來進行查詢操作,來避免回表操作。
說明:如果一本書需要知道第 11 章是什麼標題,會翻開第 11 章對應的那一頁嗎?目錄瀏覽
一下就好,這個目錄就是起到覆蓋索引的作用。
正例:能夠建立索引的種類:主鍵索引、唯一索引、普通索引,而覆蓋索引是一種查詢的一種
效果,用 explain 的結果, extra 列會出現: using index 。
7. 【推薦】利用延遲關聯或者子查詢優化超多分頁場景。
說明: MySQL 並不是跳過 offset 行,而是取 offset + N 行,然後返回放棄前 offset 行,返回
N 行,那當 offset 特別大的時候,效率就非常的低下,要麼控制返回的總頁數,要麼對超過
特定閾值的頁數進行 SQL 改寫。
正例:先快速定位需要獲取的 id 段,然後再關聯:
SELECT a.* FROM 表 1 a, (select id from 表 1 where 條件 LIMIT 100000,20 ) b where a.id=b.id
8. 【推薦】 SQL 性能優化的目標:至少要達到 range 級別,要求是 ref 級別,如果可以是 consts
最好。
說明:
1 ) consts 單表中最多隻有一個匹配行 ( 主鍵或者唯一索引 ) ,在優化階段即可讀取到數據。
2 )ref 指的是使用普通的索引 (normal index) 。
3 )range 對索引進行範圍檢索。
反例: explain 表的結果, type = index ,索引物理文件全掃描,速度非常慢,這個 index 級
別比較 range 還低,與全表掃描是小巫見大巫。
9. 【推薦】建組合索引的時候,區分度最高的在最左邊。
正例:如果 where a =? and b =? , a 列的幾乎接近於唯一值,那麼只需要單建 idx _ a 索引即
可。
說明:存在非等號和等號混合判斷條件時,在建索引時,請把等號條件的列前置。如: where a >?
and b =? 那麼即使 a 的區分度更高,也必須把 b 放在索引的最前列。
10. 【參考】創建索引時避免有如下極端誤解:
1 ) 誤認爲一個查詢就需要建一個索引。
2 ) 誤認爲索引會消耗空間、嚴重拖慢更新和新增速度。
3 ) 誤認爲唯一索引一律需要在應用層通過“先查後插”方式解決。
(三) SQL 規約
1. 【強制】不要使用 count( 列名 ) 或 count( 常量 ) 來替代 count( * ) , count( * ) 就是 SQL 92 定義
的標準統計行數的語法,跟數據庫無關,跟 NULL 和非 NULL 無關。
說明: count( * ) 會統計值爲 NULL 的行,而 count( 列名 ) 不會統計此列爲 NULL 值的行。
2. 【強制】 count(distinct col) 計算該列除 NULL 之外的不重複數量。注意 count(distinct
col 1, col 2 ) 如果其中一列全爲 NULL ,那麼即使另一列有不同的值,也返回爲 0。
3. 【強制】當某一列的值全是 NULL 時, count(col) 的返回結果爲 0,但 sum(col) 的返回結果爲
NULL ,因此使用 sum() 時需注意 NPE 問題。
正例:可以使用如下方式來避免 sum 的 NPE 問題: SELECT IF(ISNULL(SUM(g)) ,0, SUM(g))
FROM table;
4. 【強制】使用 ISNULL() 來判斷是否爲 NULL 值。注意: NULL 與任何值的直接比較都爲 NULL。
說明:
1 ) NULL<>NULL 的返回結果是 NULL ,而不是 false 。
2 ) NULL=NULL 的返回結果是 NULL ,而不是 true 。
3 ) NULL<>1 的返回結果是 NULL ,而不是 true 。
5. 【強制】 在代碼中寫分頁查詢邏輯時,若 count 爲 0 應直接返回,避免執行後面的分頁語句。
6. 【強制】不得使用外鍵與級聯,一切外鍵概念必須在應用層解決。
說明: ( 概念解釋 ) 學生表中的 student _ id 是主鍵,那麼成績表中的 student _ id 則爲外鍵。
如果更新學生表中的 student _ id ,同時觸發成績表中的 student _ id 更新,則爲級聯更新。
外鍵與級聯更新適用於單機低併發,不適合分佈式、高併發集羣 ; 級聯更新是強阻塞,存在數
據庫更新風暴的風險 ; 外鍵影響數據庫的插入速度。
7. 【強制】禁止使用存儲過程,存儲過程難以調試和擴展,更沒有移植性。
8. 【強制】數據訂正時,刪除和修改記錄時,要先 select ,避免出現誤刪除,確認無誤才能執
行更新語句。
9. 【推薦】 in 操作能避免則避免,若實在避免不了,需要仔細評估 in 後邊的集合元素數量,控
制在 1000 個之內。
10. 【參考】如果有全球化需要,所有的字符存儲與表示,均以 utf -8 編碼,那麼字符計數方法
注意:
說明:
SELECT LENGTH( "輕鬆工作" ); 返回爲 12
SELECT CHARACTER _ LENGTH( "輕鬆工作" ); 返回爲 4
如果要使用表情,那麼使用 utfmb 4 來進行存儲,注意它與 utf -8 編碼的區別。
11. 【參考】 TRUNCATE TABLE 比 DELETE 速度快,
且使用的系統和事務日誌資源少,但 TRUNCATE
無事務且不觸發 trigger ,有可能造成事故,故不建議在開發代碼中使用此語句。
說明: TRUNCATE TABLE 在功能上與不帶 WHERE 子句的 DELETE 語句相同。
(四) ORM 規約
1. 【強制】在表查詢中,一律不要使用 * 作爲查詢的字段列表,需要哪些字段必須明確寫明。
說明:1 ) 增加查詢分析器解析成本。2 ) 增減字段容易與 resultMap 配置不一致。
2. 【強制】 POJO 類的 boolean 屬性不能加 is ,而數據庫字段必須加 is _,要求在 resultMap 中
進行字段與屬性之間的映射。
說明:參見定義 POJO 類以及數據庫字段定義規定,在 sql . xml 增加映射,是必須的。
3. 【強制】不要用 resultClass 當返回參數,即使所有類屬性名與數據庫字段一一對應,也需
要定義 ; 反過來,每一個表也必然有一個與之對應。
說明:配置映射關係,使字段與 DO 類解耦,方便維護。
4. 【強制】 xml 配置中參數注意使用:#{},# param # 不要使用${} 此種方式容易出現 SQL 注
入。
5. 【強制】 iBATIS 自帶的 queryForList(String statementName , int start , int size) 不推
薦使用。
說明:
其實現方式是在數據庫取到 statementName 對應的 SQL 語句的所有記錄,再通過 subList
取 start , size 的子集合,線上因爲這個原因曾經出現過 OOM 。
正例:在 sqlmap . xml 中引入 #start#, #size#
Map<String, Object> map = new HashMap<String, Object>();
map.put("start", start);
map.put("size", size);
6. 【強制】不允許直接拿 HashMap 與 Hashtable 作爲查詢結果集的輸出。
7. 【強制】更新數據表記錄時,必須同時更新記錄對應的 gmt _ modified 字段值爲當前時間。
8. 【推薦】不要寫一個大而全的數據更新接口,傳入爲 POJO 類,不管是不是自己的目標更新字
段,都進行 update table set c1=value1,c2=value2,c3=value3; 這是不對的。執行 SQL
時,儘量不要更新無改動的字段,一是易出錯 ; 二是效率低 ; 三是 binlog 增加存儲。
9. 【參考】@ Transactional 事務不要濫用。事務會影響數據庫的 QPS ,另外使用事務的地方需
要考慮各方面的回滾方案,包括緩存回滾、搜索引擎回滾、消息補償、統計修正等。
10. 【參考】< isEqual >中的 compareValue 是與屬性值對比的常量,一般是數字,表示相等時帶
上此條件 ; < isNotEmpty >表示不爲空且不爲 null 時執行 ; < isNotNull >表示不爲 null 值時
執行。