阿里mysql規範

(一)建表規約

1.【強制】表達是與否概念的字段，必須使用 is_xxx的方式命名，數據類型是 unsigned tinyint（ 1表示是，0表示否），此規則一樣適用於 odps建表。 
說明：任何字段若是爲非負數，必須是 unsigned。 
我的備註： 
Open Data Processing Service， 簡稱ODPS；是由阿里雲自主研發，提供針對TB/PB級數據、實時性要求不高的分佈式處理能力，應用於數據分析、挖掘、商業智能等領域；阿里巴巴的離線數據業務都運行在ODPS上；。 
2.【強制】表名、字段名必須使用小寫字母或數字；禁止出現數字開頭，禁止兩個下劃線中間只出現數字。數據庫字段名的修改代價很大，由於沒法進行預發佈，因此字段名稱須要慎重考慮。 
正例：getter_admin，task_config，level3_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萬行或者單表容量超過 2GB，才推薦進行分庫分表。 
說明：若是預計三年後的數據量根本達不到這個級別，請不要在建立表時就分庫分表。 
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

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16

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()就是 SQL92定義的標準統計行數的語法，跟數據庫無關，跟 NULL和非 NULL無關。 
說明：count(*)會統計值爲 NULL的行，而 count(列名)不會統計此列爲 NULL值的行。 
2.【強制】count(distinct col) 計算該列除 NULL以外的不重複數量。注意 count(distinct col1, col2) 若是其中一列全爲 NULL，那麼即便另外一列有不一樣的值，也返回爲 0。 
3.【強制】當某一列的值全是 NULL時，count(col)的返回結果爲 0，但 sum(col)的返回結果爲NULL，所以使用 sum()時需注意 NPE問題。 
正例：可使用以下方式來避免 sum的 NPE問題：

SELECT IF (ISNULL(SUM(g)), 0, SUM(g)) FROM TABLE;

• 1
• 2
• 3
• 4

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 
若是要使用表情，那麼使用 utfmb4來進行存儲，注意它與 utf-8編碼的區別。 
11.【參考】TRUNCATETABLE 比 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);

• 1
• 2
• 3

6.【強制】不容許直接拿 HashMap與 Hashtable做爲查詢結果集的輸出。 
7.【強制】更新數據表記錄時，必須同時更新記錄對應的 gmt_modified字段值爲當前時間。 
8.【推薦】不要寫一個大而全的數據更新接口，傳入爲 POJO類，不論是不是本身的目標更新字段，都進行

UPDATE TABLE SET c1 = value1, c2 = value2, c3 = value3; 

• 1
• 2
• 3
• 4
• 5
• 6

這是不對的。執行 SQL時，儘可能不要更新無改動的字段，一是易出錯；二是效率低；三是 binlog增長存儲。 
9.【參考】@Transactional事務不要濫用。事務會影響數據庫的 QPS，另外使用事務的地方須要考慮各方面的回滾方案，包括緩存回滾、搜索引擎回滾、消息補償、統計修正等。 
10.【參考】< isEqual>中的 compareValue是與屬性值對比的常量，通常是數字，表示相等時帶上此條件；< isNotEmpty>表示不爲空且不爲 null時執行；< isNotNull>表示不爲 null值時執行。

本文整理自：《阿里巴巴Java開發手冊（正式版）》

整理本文的目的是方便本身閱讀，標註等，若有侵權，立馬刪除。