建表規約
- 【強制】表達是與否概念的字段,必須使用 is_xxx 的方式命名,數據類型是 unsigned tinyint (1 表示是,0 表示否)。
說明:任何字段如果爲非負數,數據類型則必須是 unsigned,類型聲明:tinyint unsigned
注意:POJO 類中的任何布爾類型的變量,都不要加 is 前綴。
所以,需要在<resultMap> 設置 is_xxx 到 Xxx 的映射關係。數據庫表示是與否的值,使用 tinyint 類型,
堅持 is_xxx 的命名方式是爲了明確其取值含義與取值範圍。
(設置映射之後,0 對應轉化爲了 false,1 -> true)
正例:表達邏輯刪除的字段名 is_deleted,1 表示 刪除,0 表示 未刪除。 - 【強制】表名、字段名必須使用小寫字母或數字。禁止出現數字開頭,禁止兩個下劃線中間出現數字。
說明:MySQL 在 Windows 下不區分大小寫,但在 Linux 下 默認區分大小寫。因此,數據庫名、表名、字段名都不允許出現任何大寫字母,避免節外生枝。 - 【強制】表名不使用複數名詞。
- 【強制】禁用保留字,如:desc、range、match、delayed等,請參考 MySQL 官方保留字。
- 【強制】主鍵索引名爲 pk_字段名,唯一索引名爲 uk_字段名,普通索引名則爲 idx_字段名。
說明:pk_ 即 primary key;uk_ 即 unique key;idx_ 即 index 的簡稱。 - 【強制】小數類型爲 decimal,禁止使用 float 和 double。
說明:在存儲的時候,float 和 double 存在精度損失的問題,很可能在比較值的時候,得到不正確的結果。如果存儲的數據範圍超過 decimal 的範圍,建議將數據拆成整數和小數並分開存儲。 - 【強制】如果存儲的字符串長度幾乎相等,則應使用 char 定長字符串類型。
- 【強制】varchar 是可變長字符串,不預先分配存儲空間,長度不要超過 5000個字符。如果存儲長度大於此值,則應定義字段類型爲 text,獨立出來一張表,用於主鍵來對應,避免影響其他字段的索引效率。
- 【強制】表必備的三字段:id、create_time、update_time。
說明:其中 id 必爲主鍵,類型爲 unsigned bigint,單表時自增,步長爲1。create_time 和 update_time 的類型均爲 date_time 類型。 - 【推薦】庫名與應用名稱儘量一致。
- 【推薦】修改字段含義或對字段表示的狀態追加時,需要及時更新字段註釋。
- 【推薦】字段允許適當冗餘,以提高查詢性能,但必須考慮數據一致。冗餘字段應遵循
1)不是頻繁修改的字段。
2)不是 varchar 超長字段,更不能是 text 字段。
3)不是唯一索引的字段。
正例:商品類目名稱的使用頻率高,字段長度短,名稱基本一成不變,可在相關聯的表中冗餘存儲類目的名稱,避免關聯查詢。 - 【推薦】當單錶行數超過 500 萬行或者單表容量超過 2GB時,才推薦進行分庫分表。
說明:如果預計三年後的數據量無法到達這個級別,請不要在創建表時就分庫分表。 - 【參考】設置合適的字符存儲長度,不但可以節約數據庫表空間和索引存儲,更重要的是能夠提升檢索速度。
正例:見表 5-1,其中無符號值可以避免誤存負數,且擴大了數據的表示範圍。對象 年齡區間 類型 字節 表示範圍 人 150歲之內 unsigned tinyint 1 無符號:0-255 龜 數百歲 unsigned smallint 2 無符號:0-65535 恐龍化石 數千萬年 unsigned int 4 無符號:0-約42.9億 太陽 約50億年 unsigned bigint 8 無符號:0-10^19
索引規約
- 【強制】業務上具有唯一特性的字段,即使是多個字段的組合,也必須建成唯一索引。
說明:不要以爲唯一索引影響了 insert 的速度,這個速度損耗可以忽略,但會明顯提高查找速度;另外即使應用層做了非常完善的校驗控制,只要沒有唯一索引,根據墨菲定律,必然會有髒數據產生。 - 【強制】超過三張表禁止 join。需要 join 的字段,數據類型必須絕對一致;當多表關聯查詢時,保證被關聯的字段需要有索引。
說明:即使雙表 join 也要注意表索引、SQL 性能。(Oracle 無此限制) - 【強制】在 varchar 字段上建立索引時,必須指定索引長度,沒必要對全字段建立索引,根據實際文本區分度決定索引長度即可。
說明:索引的長度與區分度是一對矛盾體,一般對字符串類型數據,長度爲 20 的索引,區分度會高達 90% 以上,可以使用 count(distinct left(列名,索引長度))/ count(*) 的區分度來確定。語法 CREATE INDEX index_name ON table_name (column_name(length), clolumn_name(length)…); 確認當前字段設置一個合適的長度 select count(distinct left(column_name, length))/count(*) from table_name
- 【強制】頁面搜索嚴禁左模糊或者全模糊,如果需要請通過搜索引擎來解決。
說明:索引文件具有 B-Tree 的最左前綴匹配特性,如果左邊的值未確定,那麼無法使用此索引。 - 【推薦】如果有 order by 的場景,請注意利用索引的有序性。order by 最後的字段是組合索引的一部分,並且放在索引組合順序的最後,避免出現 file_sort 的情況,影響查詢性能。
說明:如果 order by 的列上有索引,那麼就可以利用索引的有序性進行排序;
如果沒有索引,那麼就是 file_sort,可以理解爲外部排序,
就是把 select 的數據,按照 order by 的列 ,在內存中進行一次排序,然後返回結果。索引的有序性:簡單理解爲,索引本身就是對某列建立的一個可以按照一定順序規格訪問的目錄。通過 order by 列上的索引來訪問,那麼默認獲取到的值就是按照這列排好的順序。就是利用到了索引的有序性。
正例:where a=? and b= ? order by c;索引:a_b_c
反例:索引中有範圍查找,那麼索引有序性無法利用,如 where a>10 order by b;索引 a_b 無法排序。 -
【推薦】利用覆蓋索引進行查詢操作,避免回表。
說明:如果想知道一本書的第 11 章的標題,我們沒有必要翻開第 11 章對應的那一頁,只瀏覽一下目錄即可,這個目錄就祈禱覆蓋索引的作用。
正例:能夠建立索引的 種類分爲 主鍵索引、唯一索引、普通索引3種,而覆蓋索引只是查詢的一種效果,用 explain 的結果,extra 列會出現:using index。 -
【推薦】利用延遲關聯或者子查詢優化超多分頁場景。
說明: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
-
【推薦】SQL性能優化的目標:至少要達到 range 級別,要求 ref 級別,最好是 consts。
說明:1)consts 單表中最多隻有一個匹配行(主鍵或者唯一索引),在優化階段即可讀取到數據。
2)ref 指的是使用普通索引(normal index)。
3)range 對索引進行範圍的檢索。
反例:explain 表的結果,type=index,索引物理文件全掃描,速度非常慢,這個 index 級別比 range 還低,與全表掃描相比是小巫見大巫。 -
【推薦】建組合索引的時候,區分度最高的在左邊。
正例:如果 where a=? and b=?,a 列幾乎接近於唯一值,那麼只需要單建 idx_a 索引即可。
說明:如存在非等號和等號混合判斷條件,在建索引時,請把等號條件的列前置。如 where c>? and d=?,那麼即使 c 的區分度更高,也必須把 d 放在索引的最前列。 -
【參考】創建索引時,避免有如下極端誤解:
1)寧濫勿缺。認爲一個查詢就需要建一個索引。
2)寧缺毋濫。認爲索引會消耗空間、嚴重拖慢記錄的更新以及行的新增速度。
3)抵制唯一索引。認爲業務的唯一性一律需要在應用層通過“先查後插”的方式解決。
SQL 語句
- 【強制】不要使用 count (列名)或 count(常量)來替代 count(*),count(*) 是 SQL92 定義的標準統計行數的語法,跟數據庫無關,跟 NULL 和 非NULL 無關。
說明:count(*) 會統計值爲 NULL 的行,而 count(列名) 不會統計此列爲 NULL 值的行。 - 【強制】count(distinct column) 計算該列除 NULL 外的不重複行數。注意,count(distinct column1,column2),如果其中一列全爲 NULL,那麼即使另一列有不同的值,也返回 0。
- 【強制】當某一列的值全爲 NULL時,count(column) 的返回結果爲 0,但 sum(column) 的返回結果爲 NULL,因此使用 sum() 時需要注意 NPE 問題。
正例:可以使用如下方式來避免 sum 的NPE 問題:select IFNULL(sum(column),0) from table;
- 【強制】使用 ISNULL() 來判斷是否爲 NULL 值。
說明:NULL 與任何值的直接比較都爲 NULL。# 返回值都是 NULL select NULL=NULL, NULL<>NULL,NULL<>1,NULL=1; # 1,0,0 select ISNULL(NULL),ISNULL(1),ISNULL(0);
- 【強制】在代碼中寫分頁查詢邏輯時,若 count 爲 0,應直接返回,避免執行後面的分頁語句。
- 【強制】不得使用外鍵與級聯,一切外鍵概念必須在應用層解決。
說明:以學生和成績的關係爲例,學生表中的 student_id 是主鍵,那麼成績表中的 student_id 則爲外鍵。如果更新學生表中的 student_id ,同時觸發成績表中的 student_id 更新,即爲級聯更新。外鍵與級聯更新適用於單機低併發,不適合分佈式、高併發集羣;級聯更新是強阻塞,存在數據庫更新風暴的風險;外鍵影響數據庫插入速度。 - 【強制】禁止使用存儲過程,存儲過程難以調試和擴展,更沒有移植性。
- 【強制】數據訂正(特別是刪除、修改記錄操作)時,要先 select,避免出現誤刪除,確認無誤才能執行更新語句。
- 【推薦】in 操作能避免則避免,若實在避免不了,需要仔細評估 in 後面的集合元素數量,控制在 1000 個之內。
- 【參考】如果有國際化需要,所有的字符存儲與表示,均以 UTF-8 編碼,注意字符統計函數的區別。
說明:如果需要存儲表情,那麼選擇 utf8mb4 進行存儲,注意它與 UTF-8 的區別。#12,4 select LENGTH('輕鬆工作'),CHARACTER_LENGTH('輕鬆工作');
- 【參考】 TRUNCATE TABLE 比 DELETE 速度快,且使用的系統和事物日誌資源少,但 TRUNCATE 無事物且不觸發 trigger,有可能造成事故,故不建議在開發代碼中使用此語句。
說明:TRUNCATE TABLE 在功能上與不帶 WHERE 子句的 DELETE 語句相同。TRUNCATE table; delete from table; delete from table where column=?;
ORM 映射
- 【強制】在表查詢中,一律不使用 * 作爲查詢的字段列表,需要哪些字段必須明確寫明。
說明:1)增加查詢分析器解析成本。
2)增減字段容易與 resultMap 配置不一致。
3)多餘字段增加網絡開銷。 - 【強制】POJO 類的布爾屬性不能加 is,而數據庫字段必須加 is_,要求在 resultMap 中進行字段與屬性之間的映射
說明:參見定義 POJO 類以及數據庫字段定義規定,在 <resultMap> 中必須增加映射。在 Mybatis Generator 生成的代碼中,需要進行對應的修改。<!--生成對應表及類名--> <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> <columnOverride column="is_deleted" javaType="boolean" property="deleted"/> <!-- 特殊字段映射指定 --> </table>
- 【強制】不要用 resultClass 作爲返回參數,即使所有類屬性名與數據庫字段一一對應,也需要定義;反過來,每一個表也必然有一個屬性與之對應。
說明:配置映射關係,使字段與 DO 類解耦,方便維護。 - sql.xml 配置參數使用:#{},#param#,不要使用 ${},此種方式容易出現 SQL 注入。
- iBATIS 自帶的 queryForList(String statementName, int start, int size) 不推薦使用。
說明:其實現方式是在數據庫取到 statementName 對應的 SQL 語句的所有記錄,再通過 subList 取 start,size 的子集合。
正例:Map<String, Object> map = new HashMap<>(); map.put("start",start); map.put("size",size);
- 【強制】不允許直接拿 HashMap 與 Hashtable 作爲查詢結果集的輸出。
說明:resultClass=“Hashtable”,會置入字段名和屬性值,但是值的類型不可控。 - 【強制】更新數據表記錄時,必須同時更新記錄對應的修改時間 update_time。
- 【推薦】不要寫一個大而全的數據更新接口。只更新目標字段,不要更新無改動字段,一是容易出錯,二是效率低,三是會增加 binlog 存儲。
- 【參考】@Transactional 事物不要濫用。事務會影響數據庫的 QPS。另外,使用事務的地方需要考慮各方面的回滾方案,包括緩存回滾、搜索引擎回滾、消息補償、統計修正等。
- 【參考】<isEqual> 中的 compareValue 是與屬性值對比的常量,一般是數字,表示相等的時候執行相應的SQL語句 ;
<isNotEmpty> 表示不爲空且不爲 null 時執行;
<isNotNull> 表示不爲 null 時 執行。
說明:mybatis 3 不支持,使用 <if test="屬性值 != null"> 這樣的 if 標籤 加條件表達式。