Mybatis-Plus主鍵生成策略的方法
前言
很多人在使用Mybatis-Plus的時候可能會疑惑，自己明明沒有配置主鍵的生成策略，但是執(zhí)行新增操作時卻自動生成了主鍵，而且還特別長。這是由于Mybatis-Plus默認就會采用雪花算法填充主鍵字段。
今天就和大家詳解聊聊Mybatis-Plus中主鍵生成的相關(guān)策略。
一、官網(wǎng)
Mybatis-Plus主鍵策略：https://baomidou.com/pages/e131bd/
Mybatis-Plus自定義ID生成器：https://baomidou.com/pages/568eb2/
TIP??：
推薦學(xué)習(xí)框架的時候，多研究下官網(wǎng)，獲取第一手資料。
二、主鍵注解@TableId說明
1、源碼
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface TableId {
String value() default "";
IdType type() default IdType.NONE;
}
2、作用
標識主鍵字段
使用@TableId可以標識實體對象中和數(shù)據(jù)庫表中主鍵對應(yīng)的字段。如果不添加@TableId注解，會默認匹配id字段為主鍵。
變量名稱和主鍵字段名稱的匹配
如果表中的主鍵字段名稱和實體中的主鍵字段名稱不相同，這時候就要通過@TableId中的value屬性明確指出對應(yīng)的數(shù)據(jù)庫主鍵字段的名稱。
指定主鍵的生成方式
可以通過@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枚舉類的源碼，可以發(fā)現(xiàn)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 | 數(shù)據(jù)庫 ID自增，這種情況下將表中主鍵設(shè)置為自增，否則，沒有設(shè)置主動設(shè)置id值進行插入時會報錯 |
| NONE | 無狀態(tài)，該類型為未設(shè)置主鍵類型（注解里等于跟隨全局，全局里默認 ASSIGN_ID），注意這里官網(wǎng)文檔有誤 |
| INPUT | insert 前自行 set 主鍵值，在采用IKeyGenerator類型的ID生成器時必須為INPUT |
| ASSIGN_ID | 分配 ID(主鍵類型為 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默認實現(xiàn)類為DefaultIdentifierGenerator雪花算法) |
| ASSIGN_UUID | 分配 UUID,主鍵類型為 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默認 default 方法) |
3、全局設(shè)置
IdType默認的全局設(shè)置為IdType.ASSIGN_ID,即由mybatis-plus主動分配主鍵，默認情況下由默認主鍵生成器實現(xiàn)類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。
1、IdentifierGenerator
源碼如下：
public interface IdentifierGenerator {
//根據(jù)id是否為null判斷是否需要主動分配Id
default boolean assignId(Object idValue) {
return StringUtils.checkValNull(idValue);
}
//生成數(shù)值型Id
Number nextId(Object entity);
//生成字符型uuid
default String nextUUID(Object entity) {
return IdWorker.get32UUID();
}
}
說明：
IdentifierGenerator生成器中主要提供了3個方法。
其使用場景是：不依賴數(shù)據(jù)庫生成ID，而是由mybatis-plus自己提供一套id生成算法。 對應(yīng)的主鍵生成方式為IdType.ASSIGN_ID、ASSIGN_UUID。
assignId是否需要分配idnextId獲取下一個數(shù)值型IdnextUUID獲取下一個uuid
典型的實現(xiàn)是默認的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的實現(xiàn)類
如果是默認的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 {
//執(zhí)行sql生成id
String executeSql(String incrementerName);
//獲取數(shù)據(jù)庫類型
DbType dbType();
}
說明：IKeyGenerator 生成器主要是根據(jù)不同的數(shù)據(jù)庫類型，執(zhí)行sql語句生成對應(yīng)的主鍵。典型的數(shù)據(jù)庫如Oracle，Postgre，需要根據(jù)序列器生成表主鍵。
相關(guān)實現(xiàn)類：
OracleKeyGenerator中的實現(xiàn)：
可以發(fā)現(xiàn)，是通過執(zhí)行sql調(diào)用序列器生成的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具體實現(xiàn)類
@Bean
public IKeyGenerator keyGenerator() {
return new OracleKeyGenerator();
}
也可以通過配置項指定：
mybatis-plus.global-config.db-config.key-generators=com.baomidou.mybatisplus.extension.incrementer.OracleKeyGenerator
四、自定義主鍵生成器
自定義主鍵生成器也有2種方式。如果需要通過執(zhí)行sql語句來生成id的，可以通過實現(xiàn)IKeyGenerator接口來自定義。 如果不想依賴數(shù)據(jù)庫，完全自定義一套主鍵生成策略，那么可以通過實現(xiàn)IdentifierGenerator接口來擴展。
下面演示如何通過實現(xiàn)IdentifierGenerator接口，自定義主鍵生成器。
1、自定義id生成器
@Component
public class CustomIdGenerator implements IdentifierGenerator {
@Override
public Long nextId(Object entity) {
//可以將當前傳入的class全類名來作為bizKey,或者提取參數(shù)來生成bizKey進行分布式Id調(diào)用生成.
String bizKey = entity.getClass().getName();
//根據(jù)bizKey調(diào)用分布式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;
總結(jié)
本文主要是介紹了Mybatis-Plus主鍵生成策略及其相關(guān)的擴展方法。
1、詳細介紹了@TableId注解的屬性和作用，推薦項目中在實體的主鍵字段上明確添加@TableId注解，標識id字段以及id生成策略IdType。
2、目前mybatis-plus中有5種Id生成策略IdType，搞清楚各種的用法和使用場景。
AUTO數(shù)據(jù)庫 ID自增NONE未設(shè)置主鍵類型，也就是跟隨全局策略，全局策略默認為ASSIGN_IDINPUTinsert 前自行 set 主鍵值ASSIGN_ID分配 IDASSIGN_UUID分配 UUID
3、Mybatis-Plus中的ID生成器主要分為2類，一類是IdentifierGenerator，另一類是IKeyGenerator，搞清楚他們的區(qū)別和各自的使用場景。
IdentifierGenerator 適用于不依賴數(shù)據(jù)庫，用戶自定義的主鍵生成場景。
IKeyGenerator 依賴數(shù)據(jù)庫，通過執(zhí)行sql語句生成主鍵的場景。
到此這篇關(guān)于Mybatis-Plus主鍵生成策略的方法的文章就介紹到這了,更多相關(guān)Mybatis-Plus主鍵生成策略內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
使用IDEA搭建SSM框架的詳細教程(spring + springMVC +MyBatis)
這篇文章主要介紹了使用IDEA搭建SSM框架的詳細教程 spring + springMVC +MyBatis,本文通過圖文并茂的形式給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-05-05
SpringBoot?Test的webEnvironment源碼解讀
這篇文章主要為大家介紹了SpringBoot?Test的webEnvironment源碼解讀,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-09-09
TCP是一種傳輸控制協(xié)議，是面向連接的、可靠的、基于字節(jié)流之間的傳輸層通信協(xié)議，由IETF的RFC 793定義。在簡化的計算機網(wǎng)絡(luò)OSI模型中，TCP完成第四層傳輸層所指定的功能2021-06-06
今天帶大家分析java攔截器和過濾器的區(qū)別,文中有非常詳細的解釋說明,對正在學(xué)習(xí)java的小伙伴們有很好的幫助,需要的朋友可以參考下2021-05-05
這篇文章主要介紹了Java參數(shù)傳遞實現(xiàn)代碼及過程圖解,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-11-11
Java中基于DeferredResult的異步服務(wù)詳解
這篇文章主要介紹了Java中基于DeferredResult的異步服務(wù)詳解,DeferredResult字面意思是"延遲結(jié)果",它允許Spring MVC收到請求后,立即釋放(歸還)容器線程,以便容器可以接收更多的外部請求,提升吞吐量,需要的朋友可以參考下2023-12-12
這篇文章主要介紹了spring @Component注解原理解析,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-02-02
這篇文章主要介紹了Java快速批量移動文件的實現(xiàn)方法,需要的朋友可以參考下2014-03-03
下面小編就為大家?guī)硪黄容^排序之快速排序(實例代碼)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-06-06
SpringBoot項目中分頁插件PageHelper無效的問題及解決方法
這篇文章主要介紹了解決SpringBoot項目中分頁插件PageHelper無效的問題，本文通過實例代碼給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-06-06