建表規(guī)約
- 【強(qiáng)制】表達(dá)是與否概念的字段菩彬，必須使用 is_xxx 的方式命名赁还，數(shù)據(jù)類(lèi)型是 unsigned tinyint
（1 表示是， 0 表示否） 漏麦。
- 說(shuō)明： 任何字段如果為非負(fù)數(shù)客税，必須是 unsigned。
- 正例： 表達(dá)邏輯刪除的字段名 is_deleted撕贞， 1 表示刪除更耻， 0 表示未刪除。
- 【強(qiáng)制】表名捏膨、字段名必須使用小寫(xiě)字母或數(shù)字秧均，禁止出現(xiàn)數(shù)字開(kāi)頭，禁止兩個(gè)下劃線(xiàn)中間只出現(xiàn)數(shù)字号涯。數(shù)據(jù)庫(kù)字段名的修改代價(jià)很大目胡，因?yàn)闊o(wú)法進(jìn)行預(yù)發(fā)布，所以字段名稱(chēng)需要慎重考慮链快。
- 說(shuō)明： MySQL 在 Windows 下不區(qū)分大小寫(xiě)讶隐，但在 Linux 下默認(rèn)是區(qū)分大小寫(xiě)。因此久又，數(shù)據(jù)庫(kù)名巫延、表名、字段名地消，都不允許出現(xiàn)任何大寫(xiě)字母炉峰，避免節(jié)外生枝。
- 正例： hap_admin脉执， rdc_config疼阔， level3_name
- 反例： HapAdmin， rdcConfig半夷， level_3_name
- 【強(qiáng)制】表名不使用復(fù)數(shù)名詞婆廊。
- 說(shuō)明： 表名應(yīng)該僅僅表示表里面的實(shí)體內(nèi)容，不應(yīng)該表示實(shí)體數(shù)量巫橄，對(duì)應(yīng)于 DO 類(lèi)名也是單數(shù)
形式淘邻，符合表達(dá)習(xí)慣。
- 【強(qiáng)制】禁用保留字湘换，如 desc宾舅、 range统阿、 match、 delayed 等筹我， 請(qǐng)參考 MySQL 官方保留字扶平。
- 【強(qiáng)制】 主鍵索引名為 pk_字段名； 唯一索引名為 uk_字段名蔬蕊； 普通索引名則為 idx_字段名结澄。
- 說(shuō)明： pk_ 即 primary key； uk_ 即 unique key岸夯； idx_ 即 index 的簡(jiǎn)稱(chēng)麻献。
- 【強(qiáng)制】小數(shù)類(lèi)型為 decimal，禁止使用 float 和 double囱修。
- 說(shuō)明： float 和 double 在存儲(chǔ)的時(shí)候赎瑰，存在精度損失的問(wèn)題，很可能在值的比較時(shí)破镰，得到不正確的結(jié)果餐曼。如果存儲(chǔ)的數(shù)據(jù)范圍超過(guò) decimal 的范圍，建議將數(shù)據(jù)拆成整數(shù)和小數(shù)分開(kāi)存儲(chǔ)鲜漩。
- 【強(qiáng)制】如果存儲(chǔ)的字符串長(zhǎng)度幾乎相等源譬，使用 char 定長(zhǎng)字符串類(lèi)型。
- 【強(qiáng)制】 varchar 是可變長(zhǎng)字符串孕似，不預(yù)先分配存儲(chǔ)空間踩娘，長(zhǎng)度不要超過(guò)5000，如果存儲(chǔ)長(zhǎng)度大于此值喉祭，定義字段類(lèi)型為 text养渴，獨(dú)立出來(lái)一張表，用主鍵來(lái)對(duì)應(yīng)泛烙，避免影響其它字段索引效率理卑。
- 【強(qiáng)制】表必備三字段： id, create_date, last_update_date。
- 說(shuō)明： 其中 id 必為主鍵蔽氨，類(lèi)型為 unsigned bigint藐唠、單表時(shí)自增、步長(zhǎng)為 1鹉究。 create_date,
last_update_date 的類(lèi)型均為 datetime 類(lèi)型宇立，前者現(xiàn)在時(shí)表示主動(dòng)創(chuàng)建，后者過(guò)去分詞表示被
動(dòng)更新自赔。
- 【推薦】表的命名最好是加上“業(yè)務(wù)名稱(chēng)_表的作用”妈嘹。
- 正例： hap_task / force_project / trade_config
- 【推薦】庫(kù)名與應(yīng)用名稱(chēng)盡量一致。
- 【推薦】如果修改字段含義或?qū)ψ侄伪硎镜臓顟B(tài)追加時(shí)匿级，需要及時(shí)更新字段注釋蟋滴。
- 【推薦】字段允許適當(dāng)冗余染厅，以提高查詢(xún)性能痘绎，但必須考慮數(shù)據(jù)一致津函。冗余字段應(yīng)遵循：
- 不是頻繁修改的字段。
- 不是 varchar 超長(zhǎng)字段孤页，更不能是 text 字段尔苦。
- 正例： 商品類(lèi)目名稱(chēng)使用頻率高， 字段長(zhǎng)度短行施，名稱(chēng)基本一成不變允坚， 可在相關(guān)聯(lián)的表中冗余存
儲(chǔ)類(lèi)目名稱(chēng)，避免關(guān)聯(lián)查詢(xún)蛾号。
- 【推薦】單表行數(shù)超過(guò) 500 萬(wàn)行或者單表容量超過(guò) 2GB稠项，才推薦進(jìn)行分庫(kù)分表。
- 說(shuō)明： 如果預(yù)計(jì)三年后的數(shù)據(jù)量根本達(dá)不到這個(gè)級(jí)別鲜结，請(qǐng)不要在創(chuàng)建表時(shí)就分庫(kù)分表展运。
- 【參考】合適的字符存儲(chǔ)長(zhǎng)度，不但節(jié)約數(shù)據(jù)庫(kù)表空間精刷、節(jié)約索引存儲(chǔ)拗胜，更重要的是提升檢索速度。
- 正例： 如下表怒允，其中無(wú)符號(hào)值可以避免誤存負(fù)數(shù)埂软，且擴(kuò)大了表示范圍。
| 對(duì)象 | 年齡區(qū)間 | 類(lèi)型 | 字節(jié) | 表示范圍 |
|---|---|---|---|---|
| 人 | 150歲之內(nèi) | unsigned tinyint | 1 | 無(wú)符號(hào)值： 0 到 255 |
| 龜 | 數(shù)百歲 | unsigned smallint | 2 | 無(wú)符號(hào)值： 0 到 65535 |
| 恐龍化石 | 數(shù)千萬(wàn)年 | unsigned int | 4 | 無(wú)符號(hào)值： 0 到約 42.9 億 |
| 太陽(yáng) | 約 50 億年 | unsigned bigint | 8 | 無(wú)符號(hào)值： 0 到約 10 的 19 次方 |
索引規(guī)約
- 【強(qiáng)制】業(yè)務(wù)上具有唯一特性的字段纫事，即使是多個(gè)字段的組合勘畔，也必須建成唯一索引。
- 說(shuō)明：不要以為唯一索引影響了insert速度丽惶，這個(gè)速度損耗可以忽略炫七，但提高查找速度是明顯的；另外蚊夫，即使在應(yīng)用層做了非常完善的校驗(yàn)控制诉字，只要沒(méi)有唯一索引，根據(jù)墨菲定律知纷，必然有臟數(shù)據(jù)產(chǎn)生壤圃。
- 【強(qiáng)制】超過(guò)三個(gè)表禁止join。需要join的字段琅轧，數(shù)據(jù)類(lèi)型必須絕對(duì)一致伍绳；多表關(guān)聯(lián)查詢(xún)時(shí)，保證被關(guān)聯(lián)的字段需要有索引乍桂。
- 說(shuō)明：即使雙表join也要注意表索引冲杀、SQL性能效床。
- 【強(qiáng)制】在varchar字段上建立索引時(shí)，必須指定索引長(zhǎng)度权谁，沒(méi)必要對(duì)全字段建立索引剩檀，根據(jù)實(shí)際文本區(qū)分度決定索引長(zhǎng)度即可。
- 說(shuō)明：索引的長(zhǎng)度與區(qū)分度是一對(duì)矛盾體旺芽，一般對(duì)字符串類(lèi)型數(shù)據(jù)沪猴，長(zhǎng)度為 20 的索引，區(qū)分度會(huì)高達(dá)90%以上采章，可以使用 count(distinct left(列名,索引長(zhǎng)度))/count(*)的區(qū)分度來(lái)確定运嗜。
- 【強(qiáng)制】頁(yè)面搜索嚴(yán)禁左模糊或者全模糊，如果需要請(qǐng)走搜索引擎來(lái)解決悯舟。
- 說(shuō)明：索引文件具有B-Tree的最左前綴匹配特性担租，如果左邊的值未確定，那么無(wú)法使用此索引抵怎。
- 【推薦】如果有order by的場(chǎng)景奋救，請(qǐng)注意利用索引的有序性。order by 最后的字段是組合索引的一部分便贵，并且放在索引組合順序的最后菠镇，避免出現(xiàn)file_sort的情況，影響查詢(xún)性能承璃。
- 正例： where a=? and b=? order by c; 索引： a_b_c
- 反例： 索引中有范圍查找利耍，那么索引有序性無(wú)法利用，如： WHERE a>10 ORDER BY b; 索引a_b無(wú)法排序盔粹。
- 【推薦】利用覆蓋索引來(lái)進(jìn)行查詢(xún)操作隘梨， 避免回表。
- 說(shuō)明：如果一本書(shū)需要知道第 11 章是什么標(biāo)題舷嗡，會(huì)翻開(kāi)第 11章對(duì)應(yīng)的那一頁(yè)嗎轴猎？目錄瀏覽一下就好，這個(gè)目錄就是起到覆蓋索引的作用进萄。
- 正例：能夠建立索引的種類(lèi)分為主鍵索引捻脖、唯一索引、普通索引三種中鼠，而覆蓋索引只是一種查詢(xún)的一種效果可婶，用explain 的結(jié)果，extra 列會(huì)出現(xiàn)： using index援雇。
- 【推薦】利用延遲關(guān)聯(lián)或者子查詢(xún)優(yōu)化超多分頁(yè)場(chǎng)景矛渴。
- 說(shuō)明：MySQL 并不是跳過(guò) offset 行，而是取 offset+N 行惫搏，然后返回放棄前offset行具温，返回N行蚕涤，那當(dāng) offset 特別大的時(shí)候，效率就非常的低下铣猩，要么控制返回的總頁(yè)數(shù)揖铜，要么對(duì)超過(guò)特定閾值的頁(yè)數(shù)進(jìn)行SQL改寫(xiě)。
- 正例：先快速定位需要獲取的 id 段剂习，然后再關(guān)聯(lián)：
SELECT a.* FROM 表 1 a, (select id from 表 1 where 條件 LIMIT 100000,20 ) b where a.id=b.id
- 【推薦】 SQL 性能優(yōu)化的目標(biāo)：至少要達(dá)到 range 級(jí)別蛮位，要求是ref級(jí)別较沪，如果可以是consts最好鳞绕。
- 說(shuō)明：
- consts 單表中最多只有一個(gè)匹配行（主鍵或者唯一索引），在優(yōu)化階段即可讀取到數(shù)據(jù)尸曼。
- ref 指的是使用普通的索引（normal index） 们何。
- range 對(duì)索引進(jìn)行范圍檢索。
- 反例： explain 表的結(jié)果控轿， type=index冤竹，索引物理文件全掃描，速度非常慢茬射，這個(gè) index 級(jí)別比較 range 還低鹦蠕，與全表掃描是小巫見(jiàn)大巫。
- 【推薦】建組合索引的時(shí)候在抛，區(qū)分度最高的在最左邊钟病。
- 正例： 如果 where a=? and b=? ， a列的幾乎接近于唯一值刚梭，那么只需要單建 idx_a 索引即
可肠阱。 - 說(shuō)明： 存在非等號(hào)和等號(hào)混合判斷條件時(shí)，在建索引時(shí)朴读，請(qǐng)把等號(hào)條件的列前置屹徘。如： where a>?
and b=? 那么即使 a 的區(qū)分度更高，也必須把 b 放在索引的最前列衅金。
- 【推薦】 防止因字段類(lèi)型不同造成的隱式轉(zhuǎn)換噪伊， 導(dǎo)致索引失效。
- 【參考】創(chuàng)建索引時(shí)避免有如下極端誤解：
- 寧濫勿缺氮唯。 認(rèn)為一個(gè)查詢(xún)就需要建一個(gè)索引鉴吹。
- 寧缺勿濫。認(rèn)為索引會(huì)消耗空間您觉、嚴(yán)重拖慢更新和新增速度拙寡。
- 抵制惟一索引。認(rèn)為業(yè)務(wù)的惟一性一律需要在應(yīng)用層通過(guò)“先查后插”方式解決琳水。
SQL 語(yǔ)句
- 【強(qiáng)制】不要使用 count(列名)或 count(常量)來(lái)替代 count(*)肆糕， count(*)是 SQL92 定義的標(biāo)準(zhǔn)統(tǒng)計(jì)行數(shù)的語(yǔ)法般堆，跟數(shù)據(jù)庫(kù)無(wú)關(guān)，跟 NULL 和非 NULL 無(wú)關(guān)诚啃。
- 說(shuō)明： count(*)會(huì)統(tǒng)計(jì)值為 NULL 的行淮摔，而 count(列名)不會(huì)統(tǒng)計(jì)此列為 NULL 值的行。
- 【強(qiáng)制】 count(distinct col) 計(jì)算該列除 NULL 之外的不重復(fù)行數(shù)始赎， 注意 count(distinct
col1, col2) 如果其中一列全為 NULL和橙，那么即使另一列有不同的值，也返回為 0造垛。 - 【強(qiáng)制】當(dāng)某一列的值全是 NULL 時(shí)魔招， count(col)的返回結(jié)果為 0，但 sum(col)的返回結(jié)果為
NULL五辽，因此使用 sum()時(shí)需注意 NPE 問(wèn)題办斑。
- 正例： 可以使用如下方式來(lái)避免 sum 的 NPE 問(wèn)題：
SELECT IF(ISNULL(SUM(g)),0,SUM(g))
FROM table;
- 【強(qiáng)制】使用 ISNULL()來(lái)判斷是否為 NULL 值。
說(shuō)明： NULL 與任何值的直接比較都為 NULL杆逗。- NULL<>NULL 的返回結(jié)果是 NULL乡翅， 而不是 false。
- NULL=NULL 的返回結(jié)果是 NULL罪郊， 而不是 true蠕蚜。
- NULL<>1 的返回結(jié)果是 NULL，而不是 true悔橄。
- 【強(qiáng)制】 在代碼中寫(xiě)分頁(yè)查詢(xún)邏輯時(shí)靶累，若 count 為 0 應(yīng)直接返回，避免執(zhí)行后面的分頁(yè)語(yǔ)句橄维。
- 【強(qiáng)制】不得使用外鍵與級(jí)聯(lián)尺铣，一切外鍵概念必須在應(yīng)用層解決。
- 說(shuō)明：以學(xué)生和成績(jī)的關(guān)系為例争舞，學(xué)生表中的 student_id是主鍵凛忿，那么成績(jī)表中的 student_id
則為外鍵。如果更新學(xué)生表中的 student_id竞川，同時(shí)觸發(fā)成績(jī)表中的 student_id 更新店溢， 即為級(jí)聯(lián)更新。外鍵與級(jí)聯(lián)更新適用于單機(jī)低并發(fā)委乌，不適合分布式床牧、高并發(fā)集群肖方；級(jí)聯(lián)更新是強(qiáng)阻塞科侈，存在數(shù)據(jù)庫(kù)更新風(fēng)暴的風(fēng)險(xiǎn):外鍵影響數(shù)據(jù)庫(kù)的插入速度厌杜。
- 【強(qiáng)制】禁止使用存儲(chǔ)過(guò)程，存儲(chǔ)過(guò)程難以調(diào)試和擴(kuò)展娩怎，更沒(méi)有移植性考润。
- 【強(qiáng)制】數(shù)據(jù)訂正（特別是刪除泌枪、 修改記錄操作） 時(shí)桦山，要先 select，避免出現(xiàn)誤刪除踏堡，確認(rèn)無(wú)誤才能執(zhí)行更新語(yǔ)句猎唁。
- 【推薦】 in 操作能避免則避免，若實(shí)在避免不了顷蟆，需要仔細(xì)評(píng)估 in 后邊的集合元素?cái)?shù)量诫隅，控制在 1000 個(gè)之內(nèi)。
- 【參考】 如果有全球化需要帐偎，所有的字符存儲(chǔ)與表示逐纬，均以 utf-8 編碼，注意字符統(tǒng)計(jì)函數(shù)的區(qū)別肮街。
- 說(shuō)明：
SELECT LENGTH("輕松工作")风题；\\返回為 12
SELECT CHARACTER_LENGTH("輕松工作")；\\返回為 4
如果需要存儲(chǔ)表情嫉父，那么選擇 utf8mb4 來(lái)進(jìn)行存儲(chǔ)，注意它與 utf-8 編碼的區(qū)別眼刃。
- 【參考】 TRUNCATE TABLE 比 DELETE 速度快绕辖，且使用的系統(tǒng)和事務(wù)日志資源少，但 TRUNCATE
無(wú)事務(wù)且不觸發(fā) trigger擂红，有可能造成事故仪际，故不建議在開(kāi)發(fā)代碼中使用此語(yǔ)句。
- 說(shuō)明： TRUNCATE TABLE 在功能上與不帶 WHERE 子句的 DELETE 語(yǔ)句相同昵骤。
ORM 映射
- 【強(qiáng)制】在表查詢(xún)中树碱，一律不要使用 * 作為查詢(xún)的字段列表，需要哪些字段必須明確寫(xiě)明变秦。
- 說(shuō)明：
- 增加查詢(xún)分析器解析成本.
- 增減字段容易與 resultMap 配置不一致成榜。
- 【強(qiáng)制】 POJO 類(lèi)的布爾屬性不能加 is，而數(shù)據(jù)庫(kù)字段必須加 is_蹦玫，要求在 resultMap 中進(jìn)行
字段與屬性之間的映射赎婚。 - 【強(qiáng)制】不要用 resultClass 當(dāng)返回參數(shù)，即使所有類(lèi)屬性名與數(shù)據(jù)庫(kù)字段一一對(duì)應(yīng)樱溉，也需要定義挣输；反過(guò)來(lái)，每一個(gè)表也必然有一個(gè)與之對(duì)應(yīng)福贞。
- 說(shuō)明： 配置映射關(guān)系撩嚼，使字段與 DO 類(lèi)解耦，方便維護(hù)。
- 【強(qiáng)制】sql.xml 配置參數(shù)使用： #{}完丽， #param# 不要使用${} 此種方式容易出現(xiàn) SQL 注入向瓷。
- 【強(qiáng)制】 iBATIS 自帶的 queryForList(String statementName,int start,int size)不推
薦使用。
- 說(shuō)明：其實(shí)現(xiàn)方式是在數(shù)據(jù)庫(kù)取到 statementName對(duì)應(yīng)的SQL語(yǔ)句的所有記錄舰涌，再通過(guò) subList
取 start,size 的子集合猖任。 - 正例：
Map<String, Object> map = new HashMap<String, Object>();
map.put("start", start);
map.put("size", size);
- 【強(qiáng)制】不允許直接拿 HashMap 與 Hashtable 作為查詢(xún)結(jié)果集的輸出。
- 說(shuō)明： resultClass=”Hashtable”瓷耙， 會(huì)置入字段名和屬性值朱躺，但是值的類(lèi)型不可控。
- 【強(qiáng)制】更新數(shù)據(jù)表記錄時(shí)搁痛，必須同時(shí)更新記錄對(duì)應(yīng)的 gmt_modified 字段值為當(dāng)前時(shí)間长搀。
- 【推薦】不要寫(xiě)一個(gè)大而全的數(shù)據(jù)更新接口。 傳入為 POJO 類(lèi)鸡典，不管是不是自己的目標(biāo)更新字
段源请，都進(jìn)行 update table set c1=value1,c2=value2,c3=value3; 這是不對(duì)的。執(zhí)行 SQL
時(shí)彻况， 不要更新無(wú)改動(dòng)的字段谁尸，一是易出錯(cuò)； 二是效率低纽甘； 三是增加 binlog 存儲(chǔ)良蛮。 - 【參考】 @Transactional 事務(wù)不要濫用。事務(wù)會(huì)影響數(shù)據(jù)庫(kù)的 QPS悍赢，另外使用事務(wù)的地方需要考慮各方面的回滾方案决瞳，包括緩存回滾、搜索引擎回滾左权、消息補(bǔ)償皮胡、統(tǒng)計(jì)修正等。
- 【參考】 <isEqual>中的 compareValue 是與屬性值對(duì)比的常量赏迟，一般是數(shù)字屡贺，表示相等時(shí)帶上此條件； <isNotEmpty>表示不為空且不為 null 時(shí)執(zhí)行瀑梗；<isNotNull>表示不為 null 值時(shí)執(zhí)行烹笔。
