資料庫表及欄位命名規範(一)
一、【操作規範】
1. 如無備註,則表中的第一個id欄位一定是主鍵且為自動增長;
2. 如無備註,則數值型別的欄位請使用UNSIGNED屬性;
3. 如無備註,排序欄位order_id在程式中預設使用降序排列;
4. 如無備註,所有欄位都設定NOT NULL,並設定預設值;
5. 如無備註,所有的布林值欄位,如is_hot、is_deleted,都必須設定一個預設值,並設為0;
6. 所有的數字型別欄位,都必須設定一個預設值,並設為0;
7. 針對varchar型別欄位的程式處理,請驗證使用者輸入,不要超出其預設的長度;
8. 建表時將資料字典中的欄位中文名和屬性備註寫入資料表的備註中(“PK、自動增長”不用寫);
9. 如無說明,建表時一律採用innodb引擎;
二、【常用表名約定】
0. 說明:表字首用專案名稱首字母縮寫;所以表名都小寫,單詞之間用下劃線分開,單詞都用單數形式
1. user – 使用者
2. category – 分類
3. goods – 商品、產品等一切可交易網站的物品都用此命名
4. good_gallery – 物品的相簿
5. good_cate – 物品的分類,除了單獨作為表名,其他地方分類單詞一律用縮寫cate
4. attr – 屬性
5. article – 文章、新聞、幫助中心等以文章形式出現的,一般都用此命名
6. cart – 購物車
7. feedback – 使用者反饋
8. order – 訂單
9. site_nav – 包括頁頭和頁尾導航
10. site_config – 系統配置表
11. admin – 後臺使用者 【RBAC標準表】
12. role – 後臺使用者角色【RBAC標準表】
13. access – 後臺操作許可權,相當於action【RBAC標準表】
14. role_admin – 後臺使用者對應的角色【RBAC標準表】
15. access_role – 後臺角色對應的許可權【RBAC標準表】
16. 待續
三、【常用列名約定】
1. 表名_id – 通常用作外來鍵命名
2. cid – 特殊的編號,帶有元資料,方便關聯查詢,你可以把它理解成類別(層次)編號。舉個例子,產品在分類時,往往需要將其歸類到子分類下,相應的欄位中也一般只記錄子分類的id,這時若需要知道該產品屬於哪個主分類,就需要通過子分類資訊再查詢到主分類資訊,這是比較麻煩的,cid欄位就是要解決這個問題。一般的站點幾十個分類肯定是夠用了,所以這裡假設某一主分類的cid為11,則子分類的cid從1101開始編號,處理時只需擷取前兩位數值便可知道該產品屬於哪一個主分類了。
3. add_time – 新增時間、上架時間等
4. last_time – 最後操作時間,如登入、修改記錄
5. expire_time – 過期時間
6. name – 商品名稱、商家名稱等,不要跟title混用,title只用於文章標題、職稱等
7. price – 價格
8. thumb – 只要是列表頁面中的視窗圖,一律用此命名
9. image_src – 相簿中的圖片地址一律用此命名,不要出現各種img,image,img_url,thumb_url等
10. head_thumb – 使用者頭像, 雖然有點長,一定要遵守。不要出現上述情況
11. image_alt – 相簿中圖片的alt屬性
12. desc – 描述、簡介,比如goods_desc,不要出現goods_txt這種
13. details – 詳情、文章內容等
14. order_id – 排序
15. telephone – 座機號碼
16. mobile – 手機號碼
17. phone – 當不區分手機和座機時,請用phone命名
18. address – 地址,單獨出現不要用addr縮寫,組合出現時需用縮寫,比如mac地址,mac_addr
19. zipcode – 郵編
20. region – 地區,大的區域,比如記錄杭州市、溫州市等
21. area – 區域,小的,比如上城區,江乾區等
22. avg_cost – 人均消費
23. 待續
四、【資料表字段設計範例】
分類表(t_category)
欄位名 | 列名 | 型別 | 屬性備註 | 說明 |
流水號 | id | int(10) | PK、自動增長 | |
特殊編號 | cid | varchar(4) | 第一個主分類為11、第一個子分類為1101,類推,僅支援二級分類 | |
名稱 | name | varchar(10) | 頁面中需註明輸入不超過10個字 | |
父分類 | pid | int(10) | ||
統計量 | count | int(10) | ||
是否熱門 | is_hot | tinyint(1) | ||
首頁顯示 | is_index | tinyint(1) | ||
排序 | order_id | int(10) |
[表命名規範]
1.具備統一字首,對相關功能的表應當使用相同字首,如acl_xxx,house_xxx,ppc_xxx;其中字首通常為這個表的模組或依賴主實體物件的名字,通常來講表名為:業務_動作_型別,或是業務_型別;
2.表名使用英文小寫單詞,如果有多個單詞則使用下劃線隔開;
3.表名簡介,使用常見單詞,避免使用長單詞和生僻詞;
4.表引擎取決於實際應用場景及當前資料庫中的已經存在的儲存引擎;日誌及報表類表建議用myisam,與交易,稽核,金額相關的表建議用innodb引擎。總體來講資料庫預設innodb;
5.資料表必須有主鍵,且建議均使用auto_increment的id作為主鍵(與業務無關),和業務相關的要做為唯一索引;
6.預設使用utf8字符集(由於資料庫定義使用了預設,資料表可以不再定義,但為保險起見,建議都寫上);
7.所有的表都必須有備註,寫明白這個表中存放的資料內容;
8.預估表資料量,如果資料量較大(超過500w)則需要考慮分表策略。可以等量均衡分表或根據業務規則分表均可。要分表的資料表必須與DBA商量分表策略;
9.職責相近的表,命名規則應該相同;如合同申請,賬戶資訊,交友相關等;
舉個例子,一張線上衝值記錄表:user_bank_deposit這個就非常符合標準,如果叫做userBankDeposit或是user_chongzhi,就非常不友好。
CREATE TABLE `house_refresh_log` (
`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '自增ID',
`fangid` int(11) NOT NULL COMMENT '房貼子ID',
`refresh_time` int(11) NOT NULL COMMENT '重新整理時間',
PRIMARY KEY (`id`),
UNIQUE KEY `fangid` (`fangid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='房重新整理記錄表';
[欄位命名規範]
1.資料庫欄位命名與表名命名類似:
2.使用小寫英文單詞,如果有多個單詞使用下劃線隔開;
3.使用簡單單詞,避免生僻詞;
4.欄位應當有註釋,描述該欄位的用途及可能儲存的內容,如列舉值則建議將該欄位中使用的內容都定義出來;
5.是別的表的外來鍵均使用xxx_id的方式來表明;
6.表的主鍵一般都約定成為id,自增型別;
7.時間欄位,除特殊情況一律採用int來記錄unix_timestamp;
8.網路IP欄位,除特殊情況一律用bigint來記錄inet_aton值;
9.所有欄位,均為非空,最好顯示指定預設值;
10.有些驅動對tinyint支援不夠好,通常建義按容量來選擇欄位;
11. text欄位儘量少用,或是拆到冗餘表中;
CREATE TABLE `wanted_post` (
`id` int(10) NOT NULL AUTO_INCREMENT,
`puid` int(10) unsigned NOT NULL,
`user_id` int(10) NOT NULL COMMENT '發貼使用者的id',
`username` varchar(50) NOT NULL COMMENT '發貼使用者的使用者名稱',
`city` smallint(4) NOT NULL COMMENT '所在城市',
`ip` bigint(14) NOT NULL COMMENT '發帖人的ip',
`district_id` tinyint(2) NOT NULL COMMENT '所在區域的id',
`district_name` varchar(20) NOT NULL COMMENT '行政區名字',
`street_id` tinyint(2) NOT NULL COMMENT '所在街道(地標)的id',
`street_name` varchar(20) NOT NULL COMMENT '小區名字',
`title` varchar(255) NOT NULL COMMENT '帖子的標題',
`description` text NOT NULL COMMENT '帖子詳情描述',
`post_at` int(11) NOT NULL COMMENT '使用者發帖時間,資料建立的時間,使用整型儲存',
`refresh_at` int(11) NOT NULL COMMENT '帖子被修改的時間,整型儲存',
`show_time` int(11) NOT NULL COMMENT '帖子顯示時間',
`age_max` int(11) NOT NULL DEFAULT '0' COMMENT '招聘最小年齡',
`age_min` int(11) NOT NULL DEFAULT '0' COMMENT '招聘最大年齡',
`post_refresh_at` int(11) NOT NULL COMMENT '重新整理時間',
PRIMARY KEY (`id`),
UNIQUE KEY `idx_puid` (`puid`),
KEY `user_id_index` (`user_id`),
KEY `post_at_index` (`post_at`),
KEY `refresh_at_index` (`refresh_at`),
KEY `show_time_index` (`show_time`)
) ENGINE=InnoDB AUTO_INCREMENT=55295 DEFAULT CHARSET=utf8 COMMENT='招聘帖子表';