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。
相关推荐
妖灵翎幺4 分钟前
Java应届生求职八股(2)---Mysql篇
数据库·mysql
HMBBLOVEPDX7 分钟前
MySQL的事务日志:
数据库·mysql
Java小白程序员9 分钟前
Spring Framework :IoC 容器的原理与实践
java·后端·spring
xuTao66743 分钟前
Easy Rules 规则引擎详解
java·easy rules
m0_480502641 小时前
Rust 入门 KV存储HashMap (十七)
java·开发语言·rust
杨DaB2 小时前
【SpringBoot】Swagger 接口工具
java·spring boot·后端·restful·swagger
YA3332 小时前
java基础(九)sql基础及索引
java·开发语言·sql
桦说编程2 小时前
方法一定要有返回值 \ o /
java·后端·函数式编程
weixin_419658312 小时前
MySQL数据库备份与恢复
数据库·mysql
小李是个程序2 小时前
登录与登录校验:Web安全核心解析
java·spring·web安全·jwt·cookie