AI 助理
备案控制台
开发者社区 数据库 文章 正文

Mybatis-Plus主键生成策略详解

2022-10-21 2146
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Mybatis-Plus主键生成策略详解

前言

很多人在使用Mybatis-Plus的时候可能会疑惑，自己明明没有配置主键的生成策略，但是执行新增操作时却自动生成了主键，而且还特别长。这是由于Mybatis-Plus默认就会采用雪花算法填充主键字段。


今天就和大家详解聊聊Mybatis-Plus中主键生成的相关策略。


一、官网

Mybatis-Plus主键策略：https://baomidou.com/pages/e131bd/


Mybatis-Plus自定义ID生成器：https://baomidou.com/pages/568eb2/


TIP⚠️：

推荐学习框架的时候，多研究下官网，获取第一手资料。


二、主键注解@TableId说明

1、源码

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface TableId {
    String value() default "";
    IdType type() default IdType.NONE;
}

30.png


2、作用

标识主键字段

使用@TableId可以标识实体对象中和数据库表中主键对应的字段。如果不添加@TableId注解，会默认匹配id字段为主键。


变量名称和主键字段名称的匹配

如果表中的主键字段名称和实体中的主键字段名称不相同，这时候就要通过@TableId中的value属性明确指出对应的数据库主键字段的名称。


指定主键的生成方式

可以通过@TableId注解中的type属性指定主键的生成策略，具体支持哪些策略可以在IdType枚举中查看。


3、使用

@TableName(value ="user")
@Data
public class User implements Serializable {
    /**
     * 主键ID
     */
    @TableId(value = "id",type = IdType.ASSIGN_ID)
    private Long userId;
    private String name;
    private Integer age;
    private String email;


三、主键生成策略-IdType枚举说明

通过查看IdType枚举类的源码，可以发现Mybatis-Plus中默认支持5种主键生成方式。


1、源码

public enum IdType {
    AUTO(0),
    NONE(1),
    INPUT(2),
    ASSIGN_ID(3),
    ASSIGN_UUID(4);
    private final int key;
    private IdType(int key) {
        this.key = key;
    }
    public int getKey() {
        return this.key;
    }
}


2、说明

值

描述

AUTO

数据库 ID自增，这种情况下将表中主键设置为自增，否则，没有设置主动设置id值进行插入时会报错

NONE

无状态，该类型为未设置主键类型（注解里等于跟随全局，全局里默认 ASSIGN_ID），注意这里官网文档有误

INPUT

insert 前自行 set 主键值，在采用IKeyGenerator类型的ID生成器时必须为INPUT

ASSIGN_ID

 分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)

ASSIGN_UUID

分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法)


3、全局设置

IdType默认的全局设置为IdType.ASSIGN_ID,即由mybatis-plus主动分配主键，默认情况下由默认主键生成器实现类DefaultIdentifierGenerator采用雪花算法填充主键。

public DbConfig() {
    this.idType = IdType.ASSIGN_ID;
    this.tableUnderline = true;
    this.capitalMode = false;
    this.logicDeleteValue = "1";
    this.logicNotDeleteValue = "0";
    this.insertStrategy = FieldStrategy.NOT_NULL;
    this.updateStrategy = FieldStrategy.NOT_NULL;
    this.whereStrategy = FieldStrategy.NOT_NULL;
}

在spring boot中，可以通过如下配置更改全局配置。

mybatis-plus.global-config.db-config.id-type=assign_id


三、ID生成器介绍

Mybatis-Plus中的ID生成器主要分为2类，一类是IdentifierGenerator，另一类是IKeyGenerator。

29.png


1、IdentifierGenerator

源码如下：

public interface IdentifierGenerator {
    //根据id是否为null判断是否需要主动分配Id
    default boolean assignId(Object idValue) {
        return StringUtils.checkValNull(idValue);
    }
    //生成数值型Id
    Number nextId(Object entity);
    //生成字符型uuid
    default String nextUUID(Object entity) {
        return IdWorker.get32UUID();
    }
}


说明：

IdentifierGenerator生成器中主要提供了3个方法。

其使用场景是：不依赖数据库生成ID，而是由mybatis-plus自己提供一套id生成算法。 对应的主键生成方式为IdType.ASSIGN_ID、ASSIGN_UUID。


assignId 是否需要分配id

nextId 获取下一个数值型Id

nextUUID 获取下一个uuid

典型的实现是默认的id生成器DefaultIdentifierGenerator,基于雪花算法生成id。`

public class DefaultIdentifierGenerator implements IdentifierGenerator {
    private final Sequence sequence;
    public DefaultIdentifierGenerator() {
        this.sequence = new Sequence((InetAddress)null);
    }
    public DefaultIdentifierGenerator(InetAddress inetAddress) {
        this.sequence = new Sequence(inetAddress);
    }
    public DefaultIdentifierGenerator(long workerId, long dataCenterId) {
        this.sequence = new Sequence(workerId, dataCenterId);
    }
    public DefaultIdentifierGenerator(Sequence sequence) {
        this.sequence = sequence;
    }
    public Long nextId(Object entity) {
        return this.sequence.nextId();
    }
}


具体使用：

1、声明由mybatis-plus分配主键值

@TableName(value ="user")
@Data
public class User implements Serializable {
    /**
     * 主键ID
     */
    @TableId(value = "id",type = IdType.ASSIGN_ID)
    private Long userId;
    private String name;
    private Integer age;
    private String email;


2、指定idGenerator的实现类

如果是默认的DefaultIdentifierGenerator，则不需要用户重新指定。

@Configuration
public class IdAutoConfig {
    @Value("${mybatis-plus.zookeeper.serverLists}")
    private String zkServerLists;
    @Bean
    public IdentifierGenerator idGenerator() {
        return new ImadcnIdentifierGenerator(zkServerLists);
    }
}


2、IKeyGenerator

源码如下：

public interface IKeyGenerator {
    //执行sql生成id
    String executeSql(String incrementerName);
    //获取数据库类型
    DbType dbType();
}


说明：

IKeyGenerator 生成器主要是根据不同的数据库类型，执行sql语句生成对应的主键。典型的数据库如Oracle，Postgre，需要根据序列器生成表主键。


相关实现类：

28.png

OracleKeyGenerator中的实现：

可以发现，是通过执行sql调用序列器生成的id。

public class OracleKeyGenerator implements IKeyGenerator {
    public OracleKeyGenerator() {
    }
    public String executeSql(String incrementerName) {
        return "SELECT " + incrementerName + ".NEXTVAL FROM DUAL";
    }
    public DbType dbType() {
        return DbType.ORACLE;
    }
}


具体使用:

1、在实体中通过@KeySequence指定序列器名称，并通过@TableId指定主键生成策略为IdType.INPUT

@KeySequence(value = "SEQ_ORACLE_STRING_KEY", clazz = String.class)
public class YourEntity {
    @TableId(value = "ID_STR", type = IdType.INPUT)
    private String idStr;
}


2、spring boot配置列中配置keyGenerator具体实现类


@Bean
public IKeyGenerator keyGenerator() {
    return new OracleKeyGenerator();
}


也可以通过配置项指定：

mybatis-plus.global-config.db-config.key-generators=com.baomidou.mybatisplus.extension.incrementer.OracleKeyGenerator


四、自定义主键生成器

自定义主键生成器也有2种方式。

如果需要通过执行sql语句来生成id的，可以通过实现IKeyGenerator接口来自定义。 如果不想依赖数据库，完全自定义一套主键生成策略，那么可以通过实现IdentifierGenerator接口来扩展。


下面演示如何通过实现IdentifierGenerator接口，自定义主键生成器。


1、自定义id生成器

@Component
public class CustomIdGenerator implements IdentifierGenerator {
    @Override
    public Long nextId(Object entity) {
        //可以将当前传入的class全类名来作为bizKey,或者提取参数来生成bizKey进行分布式Id调用生成.
        String bizKey = entity.getClass().getName();
        //根据bizKey调用分布式ID生成
        long id = ....;
        //返回生成的id值即可.
        return id;
    }
}


2、配置类中指定id生成器


@Bean
public IdentifierGenerator idGenerator() {
    return new CustomIdGenerator();
}


3、实体类中指定主键分配策略IdType.ASSIGN_ID

@TableName(value ="user")
@Data
public class User implements Serializable {
    /**
     * 主键ID
     */
    @TableId(value = "id",type = IdType.ASSIGN_ID)
    private Long userId;
    private String name;
    private Integer age;
    private String email;


总结

本文主要是介绍了Mybatis-Plus主键生成策略及其相关的扩展方法。


1、详细介绍了@TableId注解的属性和作用，推荐项目中在实体的主键字段上明确添加@TableId注解，标识id字段以及id生成策略IdType。


2、目前mybatis-plus中有5种Id生成策略IdType，搞清楚各种的用法和使用场景。


AUTO 数据库 ID自增

NONE 未设置主键类型，也就是跟随全局策略，全局策略默认为ASSIGN_ID

INPUT insert 前自行 set 主键值

ASSIGN_ID 分配 ID

ASSIGN_UUID 分配 UUID

3、Mybatis-Plus中的ID生成器主要分为2类，一类是IdentifierGenerator，另一类是IKeyGenerator，搞清楚他们的区别和各自的使用场景。


IdentifierGenerator 适用于不依赖数据库，用户自定义的主键生成场景。

IKeyGenerator 依赖数据库，通过执行sql语句生成主键的场景。

文章标签：
Java
SQL
关系型数据库
Oracle
Spring
算法
数据库
关键词：
MyBatis策略
MyBatis主键
MyBatis主键策略
星繁
目录
相关文章
风水道人
|
7月前
|
Java 数据库连接 mybatis
Mybatis Plus保存数据返回主键id
Mybatis Plus保存数据返回主键id
风水道人
288 1
最好zzz
|
3月前
|
前端开发 JavaScript Java
技术分享：使用Spring Boot3.3与MyBatis-Plus联合实现多层次树结构的异步加载策略
在现代Web开发中，处理多层次树形结构数据是一项常见且重要的任务。这些结构广泛应用于分类管理、组织结构、权限管理等场景。为了提升用户体验和系统性能，采用异步加载策略来动态加载树形结构的各个层级变得尤为重要。本文将详细介绍如何使用Spring Boot3.3与MyBatis-Plus联合实现这一功能。
最好zzz
126 2
香吧香
|
5月前
|
Java 数据库连接 测试技术
mybatis plus 获取新增实体的主键
mybatis plus 获取新增实体的主键
香吧香
155 8
香吧香
|
5月前
|
算法 Java 数据库连接
mybatis plus 主键策略
mybatis plus 主键策略
香吧香
56 2
杭州小哥哥
|
5月前
|
Oracle 关系型数据库 Java
mybatis使用statement.getGenreatedKeys()； useGeneratedKeys=”true”；使用自增主键获取主键值策略和Oracle不支持自增，Oracle使用序列
mybatis使用statement.getGenreatedKeys()； useGeneratedKeys=”true”；使用自增主键获取主键值策略和Oracle不支持自增，Oracle使用序列
杭州小哥哥
65 9
多多!
|
6月前
|
SQL Java 数据库连接
2万字实操案例之在Springboot框架下基于注解用Mybatis开发实现基础操作MySQL之预编译SQL主键返回增删改查
2万字实操案例之在Springboot框架下基于注解用Mybatis开发实现基础操作MySQL之预编译SQL主键返回增删改查
多多!
78 2
叶落闲庭
|
7月前
|
算法 BI 数据库
MyBatisPlus查询条件设置、映射匹配兼容性、id生成策略、多数据操作
MyBatisPlus查询条件设置、映射匹配兼容性、id生成策略、多数据操作
叶落闲庭
381 3
咕噜咕噜wy
|
7月前
|
SQL 存储 算法
Mybatis-Plus- CRUD接口-主键策略-自动填充和乐观锁-分页-逻辑删除-条件构造器和常用接口
Mybatis-Plus- CRUD接口-主键策略-自动填充和乐观锁-分页-逻辑删除-条件构造器和常用接口
咕噜咕噜wy
75 0
薛伟同学
|
7月前
|
缓存 Java 数据库连接
MyBatis三级缓存实战：高级缓存策略的实现与应用
MyBatis三级缓存实战：高级缓存策略的实现与应用
薛伟同学
153 0
MyBatis三级缓存实战：高级缓存策略的实现与应用
快乐阿超
|
7月前
|
Apache
修改mybatis-plus更新策略
修改mybatis-plus更新策略
快乐阿超
132 0

热门文章

最新文章

  • 1
    SpringMvc+Spring+MyBatis 基于注解整合
  • 2
    还在使用MyBatis Generator？试试这个工具
  • 3
    05_MyBatis基于注解的开发
  • 4
    springboot 3 下连接 mysql 数据库以及整合 mybatis-plus
  • 5
    （三）mybatisPlus自定义Sql语句
  • 6
    Mybatis plus 存储 List、Map
  • 7
    mybatis学习(21):MySQL 字符串 转换 CAST与CONVERT 函数的用法
  • 8
    MyBatis快速入门（四） MyBatis和Spring集成
  • 9
    MyBatis——关于一对多（＜collection＞）& 多对一（＜association＞）的案例详解
  • 10
    聊聊Hibernate和Mybatis的区别
  • 1
    mybatis的一对多
    47
  • 2
    mybatis动态sql
    43
  • 3
    【JAVA进阶篇教学】第九篇：MyBatis-Plus用法介绍
    221
  • 4
    解决一个mybatisplus left join里有ur报错问题
    66
  • 5
    java mysql druid mybatis-plus里使用多表删除出错的一种处理方式
    97
  • 6
    nbcio-boot升级springboot、mybatis-plus和JSQLParser后的LocalDateTime日期json问题
    78
  • 7
    基于jeecg-boot的nbcio-boot因升级mybatis-plus到3.5.3.1和JSQLParser 到4.6而引起的在线报表配置报错处理
    169
  • 8
    升级mybatis-plus到3.5.3.1和JSQLParser 从4.3升级到4.6版本引起的插入问题解决
    528
  • 9
    MyBatis #与$的区别以及动态SQL
    43
  • 10
    MyBatis 解决上篇的参数绑定问题以及XML方式交互
    67

    • 相关课程

    更多
  • MyBatis持久层框架入门

    • 相关电子书

    更多
  • Java Spring Boot开发实战系列课程【第6讲】：Spring Boot 2.0实战MyBatis与优化(Java面试题)
  • 低代码开发师（初级）实战教程
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月