(一) 建表規約

1. 【強制】表達是與否概念的欄位，必須使用is_xxx的方式命名，資料型別是unsignedtinyint

 （1表示是，0表示否），此規則同樣適用於odps建表。

 說明：任何欄位如果為非負數，必須是unsigned。

2. 【強制】表名、欄位名必須使用小寫字母或數字；禁止出現數字開頭，禁止兩個下劃線中間只

  出現數字。資料庫欄位名的修改代價很大，因為無法進行預釋出，所以欄位名稱需要慎重考慮。

  正例：getter_admin，task_config，level3_name

  反例：GetterAdmin，taskConfig，level_3_name

3. 【強制】表名不使用複數名詞。

  說明：表名應該僅僅表示表裡面的實體內容，不應該表示實體數量，對應於DO類名也是單數

  形式，符合表達習慣。

4. 【強制】禁用保留字，如desc、range、match、delayed等，參考官方保留字。

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；分表時改為從

      TDDL Sequence取值，確保分表之間的全域性唯一。gmt_create,gmt_modified的型別均為

      date_time

10.【推薦】表的命名最好是加上“業務名稱_表的作用”，避免上雲梯後，再與其它業務表關聯

  時有混淆。

  正例：tiger_task / tiger_reader / mpp_config

11.【推薦】庫名與應用名稱儘量一致。

12.【推薦】如果修改欄位含義或對欄位表示的狀態追加時，需要及時更新欄位註釋。

13.【推薦】欄位允許適當冗餘，以提高效能，但是必須考慮資料同步的情況。冗餘欄位應遵循：

1）不是頻繁修改的欄位。

2）不是varchar超長欄位，更不能是text欄位。

  正例：各業務線經常冗餘儲存商品名稱，避免查詢時需要呼叫IC服務獲取。

14.【推薦】單錶行數超過500萬行或者單表容量超過2GB，才推薦進行分庫分表。

  說明：如果預計三年後的資料量根本達不到這個級別，請不要在建立表時就分庫分表。

  反例：某業務三年總資料量才2萬行，卻分成1024張表，問：你為什麼這麼設計？答：分1024

  張表，不是標配嗎？

15.【參考】合適的字元儲存長度，不但節約資料庫表空間、節約索引儲存，更重要的是提升檢索

  速度。

  正例：人的年齡用unsignedtinyint（表示範圍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. 【推薦】如果有orderby的場景，請注意利用索引的有序性。orderby最後的欄位是組合索

  引的一部分，並且放在索引組合順序的最後，避免出現file_sort的情況，影響查詢效能。

  正例：where a=? and b=? order by c;索引：a_b_c

  反例：索引中有範圍查詢，那麼索引有序性無法利用，如：WHEREa>10ORDERBYb;索引a_b

  無法排序。

6. 【推薦】利用覆蓋索引來進行查詢操作，來避免回表操作。

  說明：如果一本書需要知道第11章是什麼標題，會翻開第11章對應的那一頁嗎？目錄瀏覽一

  下就好，這個目錄就是起到覆蓋索引的作用。

  正例：IDB能夠建立索引的種類：主鍵索引、唯一索引、普通索引，而覆蓋索引是一種查詢的

  一種效果，用explain的結果，extra列會出現：using index.

7. 【推薦】利用延遲關聯或者子查詢優化超多分頁場景。

  說明：MySQL並不是跳過offset行，而是取offset+N行，然後返回放棄前offset行，返回N

  行，那當offset特別大的時候，效率就非常的低下，要麼控制返回的總頁數，要麼對超過特

  定閾值的頁數進行SQL改寫。

  正例：先快速定位需要獲取的id段，然後再關聯：

      SELECT a.* FROM表1a,(selectidfrom表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. 【推薦】建組合索引的時候，區分度最高的在最左邊。

  正例：如果wherea=?andb=?，a列的幾乎接近於唯一值，那麼只需要單建idx_a索引即可。

  說明：存在非等號和等號混合判斷條件時，在建索引時，請把等號條件的列前置。如：wherea>?

      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問題：SELECTIF(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. 【強制】IDB資料訂正時，刪除和修改記錄時，要先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(StringstatementName,intstart,intsize)不推薦使

  用。

  說明：其實現方式是在資料庫取到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作為查詢結果集的輸出。

  反例：某同學為避免寫一個<resultMap>，直接使用HashTable來接收資料庫返回結果，結果

  出現日常是把bigint轉成Long值，而線上由於資料庫版本不一樣，解析成BigInteger，導

  致線上問題。

7. 【強制】更新資料表記錄時，必須同時更新記錄對應的gmt_modified欄位值為當前時間。

8. 【推薦】不要寫一個大而全的資料更新介面，傳入為POJO類，不管是不是自己的目標更新字

  段，都進行updatetablesetc1=value1,c2=value2,c3=value3;這是不對的。執行SQL時，

  儘量不要更新無改動的欄位，一是易出錯；二是效率低；三是binlog增加儲存。

9. 【參考】@Transactional事務不要濫用。事務會影響資料庫的QPS，另外使用事務的地方需要

  考慮各方面的回滾方案，包括快取回滾、搜尋引擎回滾、訊息補償、統計修正等。

10.【參考】<isEqual>中的compareValue是與屬性值對比的常量，一般是數字，表示相等時帶上

  此條件；<isNotEmpty>表示不為空且不為null時執行；<isNotNull>表示不為null值時執行。