在團(tuán)隊(duì)開發(fā)過程中為了項(xiàng)目的穩(wěn)定，代碼的高效，管理的便捷制定內(nèi)部種開發(fā)設(shè)計(jì)規(guī)范是必不可少的，

這里分享一份我們定義MySQL開發(fā)設(shè)計(jì)規(guī)范包括表設(shè)計(jì)規(guī)范，字段設(shè)計(jì)規(guī)范，SQL編寫規(guī)范

數(shù)據(jù)庫對象命名規(guī)范

數(shù)據(jù)庫對象

命名規(guī)范的對象是指數(shù)據(jù)庫SCHEMA、表TABLE、索引INDEX、約束CONSTRAINTS等的命名約定

數(shù)據(jù)庫對象命名原則

命名使用具有意義的英文詞匯，詞匯中間以下劃線分隔

命名只能使用英文字母、數(shù)字、下劃線

避免用MySQL的保留字如：call、group等

所有數(shù)據(jù)庫對象使用小寫字母

數(shù)據(jù)庫命名規(guī)范

數(shù)據(jù)庫名不能超過30個字符

數(shù)據(jù)庫命名必須為項(xiàng)目英文名稱或有意義的簡寫

數(shù)據(jù)庫創(chuàng)建時(shí)必須添加默認(rèn)字符集和校對規(guī)則子句。默認(rèn)字符集為UTF8(已遷移dumbo的使用utf8mb4)

命名應(yīng)使用小寫

表命名規(guī)范

同一個模塊的表盡可能使用相同的前綴，表名稱盡可能表達(dá)含義

多個單詞以下劃線（_）分隔

表名不能超過30個字符

普通表名以t_開頭，表示為table，命名規(guī)則為t_模塊名（或有意義的簡寫）_+table_name

臨時(shí)表(運(yùn)營、開發(fā)或數(shù)據(jù)庫人員臨時(shí)用作臨時(shí)進(jìn)行數(shù)據(jù)采集用的中間表)命名規(guī)則：加上tmp前綴和8位時(shí)間后綴（tmp_test_user_20181109）

備份表（DBA備份用作保存歷史數(shù)據(jù)的中間表）命名規(guī)則：加上bak前綴和8位時(shí)間后綴（bak_test_user_20181109）

命名應(yīng)使用小寫

字段命名規(guī)范

字段命名需要表示其實(shí)際含義的英文單詞或簡寫，單詞之間用下劃線（_）進(jìn)行連接

各表之間相同意義的字段必須同名

字段名不能超過30個字符

用戶命名規(guī)范

生產(chǎn)使用的用戶命名格式為 code_應(yīng)用

只讀用戶命名規(guī)則為 read_應(yīng)用

數(shù)據(jù)庫對象設(shè)計(jì)規(guī)范

存儲引擎的選擇

如無特殊需求，必須使用innodb存儲引擎

字符集的選擇

如無特殊要求，必須使用utf8或utf8mb4

表設(shè)計(jì)規(guī)范

不同應(yīng)用間所對應(yīng)的數(shù)據(jù)庫表之間的關(guān)聯(lián)應(yīng)盡可能減少，不允許使用外鍵對表之間進(jìn)行關(guān)聯(lián)，確保組件對應(yīng)的表之間的獨(dú)立性，為系統(tǒng)或表結(jié)構(gòu)的重構(gòu)提供可能性

表設(shè)計(jì)的角度不應(yīng)該針對整個系統(tǒng)進(jìn)行數(shù)據(jù)庫設(shè)計(jì)，而應(yīng)該根據(jù)系統(tǒng)架構(gòu)中組件劃分，針對每個組件所處理的業(yè)務(wù)進(jìn)行數(shù)據(jù)庫設(shè)計(jì)

表必須要有PK

一個字段只表示一個含義

表不應(yīng)該有重復(fù)列

禁止使用復(fù)雜數(shù)據(jù)類型(數(shù)組,自定義等)

需要join的字段(連接鍵),數(shù)據(jù)類型必須保持絕對一致，避免隱式轉(zhuǎn)換

設(shè)計(jì)應(yīng)至少滿足第三范式,盡量減少數(shù)據(jù)冗余。一些特殊場景允許反范式化設(shè)計(jì)，但在項(xiàng)目評審時(shí)需要對冗余字段的設(shè)計(jì)給出解釋

TEXT字段必須放在獨(dú)立的表中,用PK與主表關(guān)聯(lián)。如無特殊需要，禁止使用TEXT、BLOB字段

需要定期刪除(或者轉(zhuǎn)移)過期數(shù)據(jù)的表,通過分表解決

單表字段數(shù)不要太多，建議最多不要大于50個

MySQL在處理大表時(shí)，性能就開始明顯降低，所以建議單表物理大小限制在16GB，表中數(shù)據(jù)控制在2000W內(nèi)

如果數(shù)據(jù)量或數(shù)據(jù)增長在前期規(guī)劃時(shí)就較大，那么在設(shè)計(jì)評審時(shí)就應(yīng)加入分表策略

無特殊需求，嚴(yán)禁使用分區(qū)表

字段設(shè)計(jì)規(guī)范

INT：如無特殊需要，存放整型數(shù)字使用UNSIGNED INT型。整型字段后的數(shù)字代表顯示長度

DATETIME：所有需要精確到時(shí)間(時(shí)分秒)的字段均使用DATETIME,不要使用TIMESTAMP類型

VARCHAR：所有動態(tài)長度字符串 全部使用VARCHAR類型,類似于狀態(tài)等有限類別的字段,也使用可以比較明顯表示出實(shí)際意義的字符串,而不應(yīng)該使用INT之類的數(shù)字來代替；VARCHAR(N)，N表示的是字符數(shù)而不是字節(jié)數(shù)。比如VARCHAR(255)，可以最大可存儲255個字符（字符包括英文字母，漢字，特殊字符等）。但N應(yīng)盡可能小，因?yàn)镸ySQL一個表中所有的VARCHAR字段最大長度是65535個字節(jié)，且存儲字符個數(shù)由所選字符集決定。如UTF8存儲一個字符最大要3個字節(jié)，那么varchar在存放占用3個字節(jié)長度的字符時(shí)不應(yīng)超過21845個字符。同時(shí)，在進(jìn)行排序和創(chuàng)建臨時(shí)表一類的內(nèi)存操作時(shí)，會使用N的長度申請內(nèi)存。(如無特殊需要，原則上單個varchar型字段不允許超過255個字符)

TEXT:僅僅當(dāng)字符數(shù)量可能超過20000個的時(shí)候,才可以使用TEXT類型來存放字符類數(shù)據(jù),因?yàn)樗蠱ySQL數(shù)據(jù)庫都會使用UTF8字符集。所有使用TEXT類型的字段必須和原表進(jìn)行分拆,與原表主鍵單獨(dú)組成另外一個表進(jìn)行存放。如無特殊需要，嚴(yán)禁開發(fā)人員使用MEDIUMTEXT、TEXT、LONGTEXT類型

對于精確浮點(diǎn)型數(shù)據(jù)存儲，需要使用DECIMAL，嚴(yán)禁使用FLOAT和DOUBLE

如無特殊需要，嚴(yán)禁開發(fā)人員使用BLOB類型

如無特殊需要，字段建議使用NOT NULL屬性，可用默認(rèn)值代替NULL

自增字段類型必須是整型且必須為UNSIGNED，推薦類型為INT或BIGINT，并且自增字段必須是主鍵或者主鍵的一部分

索引設(shè)計(jì)規(guī)范

索引必須創(chuàng)建在索引選擇性選擇性較高的列上,選擇性的計(jì)算方式為: select count(distinct(col_name))/count(*) from tb_name;如果結(jié)果小于0.2，則不建議在此列上創(chuàng)建索引，否則大概率會拖慢SQL執(zhí)行

組合索引的首字段,必須在where條件中，對于確定需要組成組合索引的多個字段,建議將選擇性高的字段靠前放

禁止使用外鍵

Text類型字段如果需要創(chuàng)建索引，必須使用前綴索引

單張表的索引數(shù)量理論上應(yīng)控制在5個以內(nèi)。經(jīng)常有大批量插入、更新操作表，應(yīng)盡量少建索引

ORDER BY，GROUP BY，DISTINCT的字段需要添加在索引的后面，形成覆蓋索引

盡量使用Btree索引，不要使用其它類型索引

約束設(shè)計(jì)規(guī)范

PK應(yīng)該是有序并且無意義的,盡量由開發(fā)人員自定義,且盡可能短，使用自增序列。

表中除PK以外,還存在唯一性約束的,可以在數(shù)據(jù)庫中創(chuàng)建以“uidx_”作為前綴的唯一約束索引。

PK字段不允許更新。

禁止創(chuàng)建外鍵約束,外鍵約束由應(yīng)用控制。

如無特殊需要，所有字段必須添加非空約束，即not null。

如無特殊需要，所有字段必須有默認(rèn)值。

SQL編寫規(guī)范

盡量避免使用select *，join語句使用select *可能導(dǎo)致只需要訪問索引即可完成的查詢需要回表取數(shù)

嚴(yán)禁使用select * from table而不加任何where條件

MySQL中的text類型字段存儲的時(shí)候不是和由其他普通字段類型的字段組成的記錄存放在一起,而且讀取效率本身也不如普通字段塊。如果不需要取回text字段，又使用了select *,會讓完成相同功能的sql所消耗的io量大很多,而且增加部分的io效率也更低下

在取出字段上可以使用相關(guān)函數(shù)，但應(yīng)盡可能避免出現(xiàn)now(),rand(),sysdate(),current_user()等不確定結(jié)果的函數(shù)，在Where條件中的過濾條件字段上嚴(yán)禁使用任何函數(shù)，包括數(shù)據(jù)類型轉(zhuǎn)換函數(shù)

所有連接的SQL必須使用Join ... On ...方式進(jìn)行連接，而不允許直接通過普通的Where條件關(guān)聯(lián)方式。外連接的SQL語句,可以使用Left Join On的Join方式，且所有外連接一律寫成Left Join，而不要使用Right Join

分頁查詢語句全部都需要帶有排序條件,除非應(yīng)用方明確要求不要使用任何排序來隨機(jī)展示數(shù)據(jù)

WHERE條件中嚴(yán)禁在索引列上進(jìn)行數(shù)學(xué)運(yùn)算或函數(shù)運(yùn)算

用in()/union替換or，并注意in的個數(shù)小于300

嚴(yán)禁使用%前綴進(jìn)行模糊前綴查詢:如：select id,val from table where val like ‘%name';可以使用%模糊后綴查詢?nèi)纾?code>select id,val from table where val like ‘name%'

嚴(yán)禁使用INSERT ON DUPLICATE KEY UPDATE、REPLACE INTO、INSERT IGNORE

本文做個拋磚引玉，每個團(tuán)隊(duì)都有自己的開發(fā)設(shè)計(jì)規(guī)范，Mysql開發(fā)設(shè)計(jì)規(guī)范不單單只有這些，希望本文對您有所啟發(fā)

最新評論