mcpField
M
mysql-design

mysql-design

github.com/youlaitech数据与数据库62102 次安装4 天前更新
代码仓库

关于 mysql-design

mysql-design 是面向 MySQL 数据库结构设计的规范技能,适用于设计表、字段和索引的开发者。它覆盖命名、类型、通用字段、SQL 编写与性能优化,并提供检查清单。

主要功能

  1. 01规范库表、字段和索引命名
  2. 02按场景选择字段类型与默认值
  3. 03设计通用字段、主键和索引
  4. 04编写安全且规范的 SQL
  5. 05检查字符集、引擎与性能设计

适用场景

  1. 01规划新表的字段与数据类型
  2. 02为查询场景设计索引
  3. 03审查 SQL 和数据库结构

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/youlaitech/youlai-skills --skill mysql-design

安装后在 Claude Code 中输入/mysql-design确认已加载。

详细介绍

来自项目 README

MySQL 数据库设计规范

触发条件

  • Design database table structures
  • Define field types and lengths
  • Create indexes
  • Name tables and fields

Part 1: 命名规范

库名命名
规则说明
小写字母youlai_admin
下划线分隔不用驼峰
业务前缀youlai_
表名命名
类型前缀示例
系统表sys_sys_user, sys_role
业务表biz_biz_order, biz_product
关联表rel_ 或主表前缀sys_user_role, rel_user_dept
配置表cfg_cfg_dict, cfg_config
日志表log_log_login, log_operation
字段命名
类型规范示例
主键idid
外键表名 + _iduser_id, dept_id
名称xxx_nameuser_name, dept_name
状态statusstatus
类型xxx_typemenu_type, log_type
时间xxx_timecreate_time, login_time
布尔is_xxxis_deleted, is_enabled
数量xxx_countlogin_count, view_count
排序sort 或 order_numsort
索引命名
类型前缀示例
主键pk_pk_user
唯一索引uk_uk_username
普通索引idx_idx_dept_id
组合索引idx_idx_dept_status
全文索引ft_ft_content

Part 2: 字段类型规范

主键
`id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键'
字符串类型
场景类型长度
用户名VARCHAR50
昵称VARCHAR50
密码(加密后)VARCHAR100
手机号VARCHAR20
邮箱VARCHAR100
URLVARCHAR500
标题VARCHAR200
简介VARCHAR500
详细描述TEXT-
JSON 数据JSON-
数值类型
场景类型说明
主键/IDBIGINT20 位
外键BIGINT关联主键类型
数量/计数INT-
金额(分)BIGINT避免浮点精度问题
排序号INT-
状态TINYINT0/1/2
类型TINYINT枚举值
百分比DECIMAL(5,2)0.00-100.00
时间类型
场景类型说明
创建时间DATETIMEcreate_time
更新时间DATETIMEupdate_time
日期DATEbirth_date
时间戳BIGINT毫秒级
布尔类型
`is_deleted` TINYINT(1) NOT NULL DEFAULT 0 COMMENT '是否删除(0否 1是)'
`is_enabled` TINYINT(1) NOT NULL DEFAULT 1 COMMENT '是否启用(0否 1是)'

Part 3: 通用字段

每张表必备字段
`id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键',
`create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
`create_by` BIGINT UNSIGNED DEFAULT NULL COMMENT '创建人',
`update_by` BIGINT UNSIGNED DEFAULT NULL COMMENT '更新人',
`deleted` TINYINT(1) NOT NULL DEFAULT 0 COMMENT '删除标志(0未删除 1已删除)',
PRIMARY KEY (`id`)
可选字段
`remark` VARCHAR(500) DEFAULT NULL COMMENT '备注',
`version` INT NOT NULL DEFAULT 0 COMMENT '乐观锁版本号',
`tenant_id` BIGINT UNSIGNED DEFAULT NULL COMMENT '租户ID',

Part 4: 索引规范

索引原则
原则说明
最左前缀组合索引按查询顺序建立
高选择性选择区分度高的列
控制数量单表索引不超过 5 个
组合优先组合索引优于多个单列索引
必建索引
-- 主键索引
PRIMARY KEY (`id`)

-- 外键索引
INDEX `idx_dept_id` (`dept_id`)

-- 状态索引(常用于筛选)
INDEX `idx_status` (`status`)

-- 创建时间索引(常用于排序)
INDEX `idx_create_time` (`create_time`)

-- 唯一索引(业务唯一字段)
UNIQUE INDEX `uk_username` (`username`)
组合索引
-- 组合索引:部门 + 状态
INDEX `idx_dept_status` (`dept_id`, `status`)

-- 组合索引:用户 + 创建时间
INDEX `idx_user_time` (`user_id`, `create_time`)
索引避坑
避免原因
LIKE '%xxx%'前缀模糊不走索引
OR 条件可能不走索引,改用 UNION
函数操作WHERE YEAR(create_time) = 2024 不走索引
类型转换字符串与数字比较会隐式转换
NOT IN改用 NOT EXISTS 或 LEFT JOIN ... IS NULL

Part 5: 表设计规范

用户表示例
CREATE TABLE `sys_user` (
  `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键',
  `username` VARCHAR(50) NOT NULL COMMENT '用户名',
  `password` VARCHAR(100) NOT NULL COMMENT '密码',
  `nickname` VARCHAR(50) NOT NULL COMMENT '昵称',
  `mobile` VARCHAR(20) DEFAULT NULL COMMENT '手机号',
  `email` VARCHAR(100) DEFAULT NULL COMMENT '邮箱',
  `gender` TINYINT NOT NULL DEFAULT 0 COMMENT '性别(0未知 1男 2女)',
  `avatar` VARCHAR(500) DEFAULT NULL COMMENT '头像URL',
  `status` TINYINT NOT NULL DEFAULT 1 COMMENT '状态(1正常 0禁用)',
  `dept_id` BIGINT UNSIGNED DEFAULT NULL COMMENT '部门ID',
  `create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `update_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  `create_by` BIGINT UNSIGNED DEFAULT NULL COMMENT '创建人',
  `update_by` BIGINT UNSIGNED DEFAULT NULL COMMENT '更新人',
  `deleted` TINYINT(1) NOT NULL DEFAULT 0 COMMENT '删除标志(0未删除 1已删除)',
  PRIMARY KEY (`id`),
  UNIQUE INDEX `uk_username` (`username`),
  INDEX `idx_dept_id` (`dept_id`),
  INDEX `idx_status` (`status`),
  INDEX `idx_create_time` (`create_time`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='用户表';
关联表示例
CREATE TABLE `sys_user_role` (
  `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '主键',
  `user_id` BIGINT UNSIGNED NOT NULL COMMENT '用户ID',
  `role_id` BIGINT UNSIGNED NOT NULL COMMENT '角色ID',
  `create_time` DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  PRIMARY KEY (`id`),
  UNIQUE INDEX `uk_user_role` (`user_id`, `role_id`),
  INDEX `idx_role_id` (`role_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='用户角色关联表';

Part 6: 字段默认值

字段类型默认值说明
字符串NULL 或 ''非必填用 NULL
数值0-
布尔0 或 1根据业务
时间CURRENT_TIMESTAMP-
外键NULL非必填关联
NULL vs NOT NULL
场景选择
必填字段NOT NULL
可选字段NULL
外键(非必填)NULL
状态字段NOT NULL DEFAULT 1

Part 7: 字符集与引擎

字符集
DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
设置说明
utf8mb4支持 4 字节字符(emoji)
utf8mb4_unicode_ci不区分大小写排序
存储引擎
ENGINE=InnoDB
引擎适用场景
InnoDB事务、外键、行锁
MyISAM只读、全文索引(旧版)
Memory临时表、缓存

Part 8: SQL 编写规范

SELECT
-- ✅ 指定字段
SELECT id, username, nickname FROM sys_user WHERE status = 1;

-- ❌ 避免 SELECT *
SELECT * FROM sys_user;

-- ✅ 分页查询
SELECT id, username FROM sys_user WHERE status = 1 LIMIT 0, 20;

-- ✅ 批量插入
INSERT INTO sys_user (username, nickname) VALUES ('user1', '用户1'), ('user2', '用户2');
UPDATE
-- ✅ 带 WHERE 条件
UPDATE sys_user SET nickname = '新昵称' WHERE id = 1;

-- ✅ 乐观锁
UPDATE sys_user SET nickname = '新昵称', version = version + 1 WHERE id = 1 AND version = 1;

-- ❌ 避免全表更新
UPDATE sys_user SET status = 0;
DELETE
-- ✅ 逻辑删除
UPDATE sys_user SET deleted = 1 WHERE id = 1;

-- ✅ 物理删除(慎用)
DELETE FROM sys_user_role WHERE user_id = 1;

Part 9: 性能优化

查询优化
优化点说明
避免 SELECT *只查需要的字段
避免 LIKE '%xxx%'用 LIKE 'xxx%' 或全文索引
避免大 OFFSETLIMIT 10000, 20 改用游标分页
避免 COUNT(*)大表用缓存或估算
批量操作批量插入/更新代替循环单条
表设计优化
优化点说明
垂直拆分大字段拆到扩展表
水平拆分大表按规则分表
适当冗余减少关联查询
归档历史冷数据迁移

Part 10: 设计检查清单

  • 表名使用小写 + 下划线
  • 字段名使用小写 + 下划线
  • 主键使用 BIGINT AUTO_INCREMENT
  • 包含通用字段(create_time, update_time, deleted)
  • 外键字段添加索引
  • 唯一业务字段添加唯一索引
  • 状态字段添加索引
  • 使用 utf8mb4 字符集
  • 使用 InnoDB 引擎
  • 每个字段添加 COMMENT
  • 表添加 COMMENT
  • 索引数量不超过 5 个

评论

支持 Markdown