mybatis-plus实体类主键生成策略

一、MyBatis-Plus 主键生成策略

MyBatis-Plus 提供了多种主键生成策略,可以通过注解 @TableId 在实体类中指定主键生成方式。以下是常见的几种策略及其用法:

1. 自动递增(AUTO)

适用于数据库主键自增(如 MySQL 的 AUTO_INCREMENT)。数据库自动生成主键值,无需手动设置。

java 复制代码
@TableId(type = IdType.AUTO)
private Long id;
2. 雪花算法(ASSIGN_ID)

默认策略 ,使用雪花算法生成分布式唯一 ID(Long 类型),@TableId 不配置 type 默认使用雪花算法生成键。适合分布式系统。

java 复制代码
@TableId(type = IdType.ASSIGN_ID)
private Long id;
3. 用户输入(INPUT)

由用户手动设置主键值。如果不赋值,数据库可能会报错(若主键为非空字段)。

java 复制代码
@TableId(type = IdType.INPUT)
private Long id;
4. UUID(ASSIGN_UUID)

生成 32 位 UUID 字符串(String 类型)。需确保数据库字段类型为字符串(如 VARCHAR)。

java 复制代码
@TableId(type = IdType.ASSIGN_UUID)
private String id;
5. 无主键(NONE)

表示无主键,需确保表无主键列或通过其他方式处理。

java 复制代码
@TableId(type = IdType.NONE)
private Long id;
6. 自定义主键生成器

通过实现 IdentifierGenerator 接口自定义主键生成逻辑,并在注解中指定生成器类。

java 复制代码
public class CustomIdGenerator implements IdentifierGenerator {
    @Override
    public Number nextId(Object entity) {
        // 自定义生成逻辑
        return 自定义ID值;
    }
}
java 复制代码
@TableId(type = IdType.ASSIGN_ID, generator = "CustomIdGenerator")
private Long id;

二、默认主键策略

默认策略:IdType.ASSIGN_ID(雪花算法)。
若不配置任何策略(实体类无 @TableId 注解且未全局配置),MyBatis-Plus 自动使用雪花算法生成 Long 类型 ID

全局默认值:

GlobalConfig.DbConfig 中 id-type 的默认值为 ASSIGN_ID

可在 application.ymlapplication.properties 中设置全局默认策略:

yaml 复制代码
mybatis-plus:
  global-config:
    db-config:
      id-type: assign_id  # 默认为雪花算法

三、配置方式与优先级

配置生效优先级:局部注解 > 全局配置 > 默认策略。

局部注解配置(实体类字段上):

java 复制代码
@TableId(type = IdType.AUTO)  // 示例:数据库自增
private Long id;

全局配置(application.yml):

yaml 复制代码
mybatis-plus:
  global-config:
    db-config:
      id-type: auto  # 可选值:auto(自增)、assign_id(雪花)、assign_uuid(UUID)等

四、注意事项

  • 全局配置对所有实体类生效,但被 @TableId 注解的字段会覆盖全局设置
  • 数据库表的主键字段需与实体类字段类型匹配(如 ASSIGN_ID 对应 Long,ASSIGN_UUID 对应 String)。
  • 若使用 AUTO,需确保数据库支持自增主键。
  • 自定义生成器需注册为 Spring Bean。
相关推荐
阳光九叶草LXGZXJ3 分钟前
达梦数据库-学习-47-DmDrs控制台命令(LSN、启停、装载)
linux·运维·数据库·sql·学习
Hgfdsaqwr15 分钟前
掌握Python魔法方法(Magic Methods)
jvm·数据库·python
s1hiyu25 分钟前
使用Scrapy框架构建分布式爬虫
jvm·数据库·python
2301_7634724631 分钟前
使用Seaborn绘制统计图形:更美更简单
jvm·数据库·python
Fleshy数模40 分钟前
从数据获取到突破限制:Python爬虫进阶实战全攻略
java·开发语言
像少年啦飞驰点、1 小时前
零基础入门 Spring Boot:从“Hello World”到可上线的 Web 应用全闭环指南
java·spring boot·web开发·编程入门·后端开发
苍煜1 小时前
万字详解Maven打包策略:从基础插件到多模块实战
java·maven
熊文豪1 小时前
金仓数据库如何以“多模融合“重塑文档数据库新范式
数据库·金仓数据库·电科金仓·mongodb迁移
有来技术1 小时前
Spring Boot 4 + Vue3 企业级多租户 SaaS:从共享 Schema 架构到商业化套餐设计
java·vue.js·spring boot·后端
霖霖总总1 小时前
[小技巧56]深入理解 MySQL 聚簇索引与非聚簇索引:原理、差异与实践
数据库·mysql