SpringBoot - MyBatis-Plus使用详解3（主键策略、UUID、Sequence）

梦里梦外; 2022-12-05 09:51 113阅读 0赞

## 三、主键策略 ##

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

### 1，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 引入了时间戳，基本上保持自增的。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Data</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserInfo { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//指定主键生成策略使用雪花算法（默认策略）</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@TableId</code><code>(type = IdType.ASSIGN_ID)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Long id;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String userName;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String passWord;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

[![原文:SpringBoot - MyBatis-Plus使用详解3（主键策略、UUID、Sequence）][SpringBoot - MyBatis-Plus_3_UUID_Sequence]][SpringBoot - MyBatis-Plus_3_UUID_Sequence_SpringBoot - MyBatis-Plus_3_UUID_Sequence]

### 2，ASSIGN\_UUID（不含中划线的UUID） ###

如果使用 IdType.ASSIGN\_UUID 策略，则会自动生成不含中划线的 UUID 作为主键。主键类型为 String，对应 MySQL 的表字段为 VARCHAR(32)

提示：该策略使用接口 IdentifierGenerator 的方法 nextUUID

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Data</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserInfo { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//指定主键生成策略为不含中划线的UUID</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@TableId</code><code>(type = IdType.ASSIGN_UUID)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String id;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String userName;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String passWord;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

[![原文:SpringBoot - MyBatis-Plus使用详解3（主键策略、UUID、Sequence）][SpringBoot - MyBatis-Plus_3_UUID_Sequence 1]][SpringBoot - MyBatis-Plus_3_UUID_Sequence_SpringBoot - MyBatis-Plus_3_UUID_Sequence]

### 3，AUTO（数据库 ID 自增） ###

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Data</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserInfo { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//指定主键使用数据库ID自增策略</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@TableId</code><code>(type = IdType.AUTO)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Integer id;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String userName;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String passWord;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

[![原文:SpringBoot - MyBatis-Plus使用详解3（主键策略、UUID、Sequence）][SpringBoot - MyBatis-Plus_3_UUID_Sequence 2]][SpringBoot - MyBatis-Plus_3_UUID_Sequence_SpringBoot - MyBatis-Plus_3_UUID_Sequence]

### 4，INPUT（insert 前自行 set 主键值） ###

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

提示：

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

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

*  DB2KeyGenerator
 *  H2KeyGenerator
 *  KingbaseKeyGenerator
 *  OracleKeyGenerator
 *  PostgreKeyGenerator

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>@Bean</code> <code>public</code>&nbsp;<code>OracleKeyGenerator oracleKeyGenerator(){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>new</code>&nbsp;<code>OracleKeyGenerator();</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

（3）然后实体类配置主键 Sequence，指定主键策略为 IdType.INPUT 即可：

提示：支持父类定义 @KeySequence 子类使用，这样就可以几个表共用一个 Sequence

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>@TableName</code><code>(</code><code>"TEST_SEQUSER"</code><code>)</code> <code>@KeySequence</code><code>(</code><code>"SEQ_TEST"</code><code>)</code><code>//类注解</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>TestSequser{ </code> <code>&nbsp;&nbsp;</code><code>@TableId</code><code>(value =&nbsp;</code><code>"ID"</code><code>, type = IdType.INPUT)</code> <code>&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Long id;</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

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

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>@KeySequence</code><code>(value =&nbsp;</code><code>"SEQ_ORACLE_STRING_KEY"</code><code>, clazz = String.</code><code>class</code><code>)</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>YourEntity{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@TableId</code><code>(value =&nbsp;</code><code>"ID_STR"</code><code>, type = IdType.INPUT)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>String idStr;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### 5，NONE（无状态） ###

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

## 附：全局策略配置 ##

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>mybatis-plus.global-config.db-config.id-type=auto</code> </td> 
 </tr> 
 </tbody> 
</table>

[SpringBoot - MyBatis-Plus_3_UUID_Sequence]: https://img-service.csdnimg.cn/img_convert/d9417abcbdeddcfb02ca8bfa1c5f0ca5.png
[SpringBoot - MyBatis-Plus_3_UUID_Sequence_SpringBoot - MyBatis-Plus_3_UUID_Sequence]: /images/20221123/2cfa9ec250f84c429d0404bc3c9e352b.png
[SpringBoot - MyBatis-Plus_3_UUID_Sequence 1]: https://img-service.csdnimg.cn/img_convert/81d217e3171980923666c853c8e593a3.png
[SpringBoot - MyBatis-Plus_3_UUID_Sequence 2]: https://img-service.csdnimg.cn/img_convert/024e136ac7f5829c39201bac59088bfb.png