MyBatisPlus主键生成策略

简介

我们可以通过 @TableId 注解的 type 属性来设置主键 id 的增长策略，一共有如下几种主键策略，可根据情况自由配置。

AUTO（数据库 ID 自增）

对于像 MySQL 这样的支持主键自动递增的数据库，我们可以使用 IdType.AUTO 策略。

@TableName("tb_user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

NONE（无状态）

如果使用 IdType.NONE 策略，表示未设置主键类型（注解里等于跟随全局，全局里约等于 INPUT） INPUT（insert 前自行 set 主键值）

针对有序列的数据库：比如 Oracle，SQLServer 等，当需要建立一个自增字段时，需要用到 sequence。

• 在 Oracle 11g 中，设置自增字段，需要先创建序列（SQUENCE），再创建一个触发器（TRIGGER）。
• 在 Oracle 12c 中，只需要使用 IDENTITY 属性就可以了，和 MySQL 一样简单。

Mybatis-Plus 已经定义好了常见的数据库主键序列，我们首先只需要在 @Configuration 类中定义好 @Bean。Mybatis-Plus 内置了如下数据库主键序列（如果内置支持不满足你的需求，可实现 IKeyGenerator 接口来进行扩展）：

• DB2KeyGenerator
• H2KeyGenerator
• KingbaseKeyGenerator
• OracleKeyGenerator
• PostgreKeyGenerator 示例：

@Bean
public OracleKeyGenerator oracleKeyGenerator(){
    return new OracleKeyGenerator();
}

然后实体类配置主键Sequence，指定主键策略为 IdType.INPUT 即可： 提示：支持父类定义 @KeySequence 子类使用，这样就可以几个表共用一个 Sequence

示例：

@TableName("TEST_SEQUSER")
@KeySequence("SEQ_TEST")//类注解
public class TestSequser{
    @TableId(value = "ID", type = IdType.INPUT)
    private Long id;
}

如果主键是 String 类型的，也可以使用： 如何使用 Sequence 作为主键，但是实体主键类型是 String 也就是说，表的主键是 varchar2，但是需要从 sequence 中取值

• 实体定义 @KeySequence 注解 clazz 指定类型 String.class
• 实体定义主键的类型 String 注意：oracle 的 sequence 返回的是 Long 类型，如果主键类型是 Integer，可能会引起 ClassCastException。 示例：

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

ASSIGN_ID（ ★★★★★）

如果不设置 type 值，默认则使用 IdType.ASSIGN_ID 策略（自 3.3.0 起）。该策略会使用雪花算法自动生成主键 ID，主键类型为 Long 或 String（分别对应 MySQL 的表字段为 BIGINT 和 VARCHAR） 提示：该策略使用接口 IdentifierGenerator 的方法 nextId（默认实现类为 DefaultIdentifierGenerator 雪花算法）。

雪花算法（SnowFlake）是 Twitter 开源的分布式 id 生成算法。其核心思想就是：使用一个 64 bit 的 long 型的数字作为全局唯一 id。在分布式系统中的应用十分广泛，且 ID 引入了时间戳，基本上保持自增的。 最高位不用，41bit保存时间戳，单位是毫秒，10bit的机器位，12bit的唯一序列号，可以理解是某一毫秒内，某台机器生成了不重复的序列号 10bit 一般一会分为5bit的datacenterId存储位和5bit的workerId存储位

示例：

@Data
public class User {
    //指定主键生成策略使用雪花算法（默认策略）
    @TableId(type = IdType.ASSIGN_ID)
    private Long id;
    private String userName;
    private String passWord;
}

注意：

• 类字段类型需要为Long
• 数据库表字段类型为bigint

ASSIGN_UUID（不含中划线的UUID）

如果使用 IdType.ASSIGN_UUID 策略，则会自动生成不含中划线的 UUID 作为主键。主键类型为 String，对应 MySQL 的表字段为 VARCHAR(32) 提示：该策略使用接口 IdentifierGenerator 的方法 nextUUID

示例：

@Data
public class User {
    //指定主键生成策略为不含中划线的UUID
    @TableId(type = IdType.ASSIGN_UUID)
    private String id;
    private String userName;
    private String passWord;
}

全局策略配置

假设我们希望默认全部都使用 AUTO 策略（数据库 ID 自增），那么可以在 application.properties 中添加如下配置进行修改：

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