Mybatis-Plus默認主鍵策略導致自動生成19位長度主鍵id的坑
某天檢查一位離職同事寫的代碼，發(fā)現(xiàn)其對應表雖然設置了AUTO_INCREMENT自增，但頁面新增功能生成的數(shù)據主鍵id很詭異，長度達到了19位，且不是從1開始遞增的——
我檢查了一下，發(fā)現(xiàn)該表目前自增主鍵已經變成從1468844351843872770開始遞增了——
這就很奇怪了，目前該表數(shù)據量很少，且主鍵是設置AUTO_INCREMENT，正常而言，應該自增id仍在1000范圍內，但目前已經變成一串長數(shù)字。
底層ORM框架用的是Mybatis-Plus，我尋思了一下，這看起來像是在插入數(shù)據庫就自動生成的id，導致并非默認使用MySql的自增AUTO_INCREMENT來生成id。
因此，決定一步步定位，先給Mybatis-Plus打印出sql日志，看下其insert語句是否自動生成了一個id后才插入數(shù)據庫。
按照網上的教程，我在yaml文件里對應的mybatis-plus配置處設置了開啟sql打印日志——
mybatis-plus:
mapper-locations: classpath*:mapper/*.xml
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
然而，很詭異的是，執(zhí)行操作時并沒有打印出sql日志，故而，某一瞬間，我忽然覺得，這群家伙可能都是互相抄的，沒有驗證當springboot集成了logback時，單純這樣設置并沒有效果。
最后額外在yaml加了以下配置，才能正常打印MP的sql日志信息——
logging:
? level:
? ? com:
? ? ? zhu:
? ? ? ? test:
? ? ? ? ? mapper: debug? ?
接下來，驗證一番后，發(fā)現(xiàn)，Mybatis-Plus在做insert操作時，確實自動生成一條長19的數(shù)字當做該條數(shù)據的id插入到MySql，導致雖然MySql表設置了自增，但被Mybatis-Plus生成的id為1468844351843872769所影響，導致下一條數(shù)據自動遞增值變成1468844351843872770，這種過長的id值，在做索引維護時，是很影響效率，占用空間過大，故而，這個問題必須得解決。
到這里，就確定，這個長數(shù)字的id，是在代碼層次就自動生成了，最后進入對應的實體類中，發(fā)現(xiàn)該映射數(shù)據表的id字段，并沒有顯示設置對應的主鍵生成策略。
@Data
@TableName("test")
public class Test extends Model<Test> implements Serializable {
private Long id;
......
}
Mybatis-Plus主要有以下幾種主鍵生成策略——
@Getter
public enum IdType {
/**
* 數(shù)據庫ID自增
*/
AUTO(0),
/**
* 該類型為未設置主鍵類型
*/
NONE(1),
/**
* 用戶輸入ID
* 該類型可以通過自己注冊自動填充插件進行填充
*/
INPUT(2),
/* 以下3種類型、只有當插入對象ID 為空，才自動填充。 */
/**
* 全局唯一ID (idWorker)，根據雪花算法生成19位數(shù)字，long類型
*/
ID_WORKER(3),
/**
* 全局唯一ID (UUID)
*/
UUID(4),
/**
* 字符串全局唯一ID (idWorker 的字符串表示)，根據雪花算法生成19位字符串，String
*/
ID_WORKER_STR(5);
private int key;
IdType(int key) {
this.key = key;
}
}
這里驗證了一下，當設置成這樣時，就能正常生成數(shù)據庫自增的id了，使用數(shù)據庫AUTO_INCREMENT從1開始自增的效果了，當然，其實使用IdType.AUTO也是可以的——
@Data
@TableName("test")
public class Test extends Model<Test> implements Serializable {
@TableId(value = "id", type = IdType.INPUT)
private Long id;
......
}
百度網上的說法，當Mybatis-Plus實體類沒有顯示設置主鍵策略時，將默認使用雪花算法生成，也就是IdType.ID_WORKER或者IdType.ID_WORKER_STR，具體是long類型的19位還是字符串的19位，應該是根據字段定義類型來判斷。
snowflake算法是Twitter開源的分布式ID生成算法，結果是一個long類型的ID 。其核心思想：使用41bit作為毫秒數(shù)，10bit作為機器的ID（5bit數(shù)據中心，5bit的機器ID），12bit作為毫秒內的流水號（意味著每個節(jié)點在每個毫秒可以產生4096個ID），最后還有一個符號位，永遠是0。
接下來，先驗證Mybatis-Plus默認主鍵策略是如何的。
Mybatis-Plus項目在啟動時，會對注解實體類進行初始化，然后緩存到系統(tǒng)Map中。
這里，只需要關注Mybatis-Plus源碼TableInfoHelper類中的initTableInfo方法即可，這個方法在項目啟動時會被調用，然后初始化所有注解@TableName的實體類。與主鍵根據哪種策略來設置的邏輯在方法initTableFields(clazz, globalConfig, tableInfo)當中——
public synchronized static TableInfo initTableInfo(MapperBuilderAssistant builderAssistant, Class<?> clazz) {
TableInfo tableInfo = TABLE_INFO_CACHE.get(clazz.getName());
if (tableInfo != null) {
if (tableInfo.getConfigMark() == null && builderAssistant != null) {
tableInfo.setConfigMark(builderAssistant.getConfiguration());
}
return tableInfo;
}
/* 沒有獲取到緩存信息,則初始化 */
tableInfo = new TableInfo();
GlobalConfig globalConfig;
if (null != builderAssistant) {
tableInfo.setCurrentNamespace(builderAssistant.getCurrentNamespace());
tableInfo.setConfigMark(builderAssistant.getConfiguration());
tableInfo.setUnderCamel(builderAssistant.getConfiguration().isMapUnderscoreToCamelCase());
globalConfig = GlobalConfigUtils.getGlobalConfig(builderAssistant.getConfiguration());
} else {
// 兼容測試場景
globalConfig = GlobalConfigUtils.defaults();
}
/* 初始化表名相關 */
initTableName(clazz, globalConfig, tableInfo);
/* 初始化字段相關 */
initTableFields(clazz, globalConfig, tableInfo);
/* 放入緩存 */
TABLE_INFO_CACHE.put(clazz.getName(), tableInfo);
/* 緩存 Lambda 映射關系 */
LambdaUtils.createCache(clazz, tableInfo);
return tableInfo;
}
在初始化字段相關的initTableFields方法里，會判斷是否有@TableId 注解，如果沒有，就執(zhí)行initTableIdWithoutAnnotation方法，連續(xù)前文提到的，如果實體類id沒有加@TableId(value = "id", type = IdType.INPUT)，那么就會取默認的主鍵策略。這里的判斷是否有@TableId 注解，就是判斷是否需要取默認的主鍵策略，至于具體是如何設置默認主鍵的，我們可以直接進入到initTableIdWithoutAnnotation方法當中。
public static void initTableFields(Class<?> clazz, GlobalConfig globalConfig, TableInfo tableInfo) {
/* 數(shù)據庫全局配置 */
GlobalConfig.DbConfig dbConfig = globalConfig.getDbConfig();
List<Field> list = getAllFields(clazz);
// 標記是否讀取到主鍵
boolean isReadPK = false;
// 是否存在 @TableId 注解
boolean existTableId = isExistTableId(list);
List<TableFieldInfo> fieldList = new ArrayList<>();
for (Field field : list) {
/*
* 主鍵ID 初始化
*/
if (!isReadPK) {
if (existTableId) {
isReadPK = initTableIdWithAnnotation(dbConfig, tableInfo, field, clazz);
} else {
isReadPK = initTableIdWithoutAnnotation(dbConfig, tableInfo, field, clazz);
}
if (isReadPK) {
continue;
}
}
......
}
......
}
initTableIdWithoutAnnotation方法——
private static final String DEFAULT_ID_NAME = "id";
/**
* <p>
* 主鍵屬性初始化
* </p>
*
* @param tableInfo 表信息
* @param field 字段
* @param clazz 實體類
* @return true 繼續(xù)下一個屬性判斷，返回 continue;
*/
private static boolean initTableIdWithoutAnnotation(GlobalConfig.DbConfig dbConfig, TableInfo tableInfo,
Field field, Class<?> clazz) {
//獲取實體類字段名
String column = field.getName();
if (dbConfig.isCapitalMode()) {
column = column.toUpperCase();
}
//當字段名為id
if (DEFAULT_ID_NAME.equalsIgnoreCase(column)) {
if (StringUtils.isEmpty(tableInfo.getKeyColumn())) {
tableInfo.setKeyRelated(checkRelated(tableInfo.isUnderCamel(), field.getName(), column))
//設置表策略
.setIdType(dbConfig.getIdType())
.setKeyColumn(column)
.setKeyProperty(field.getName())
.setClazz(field.getDeclaringClass());
return true;
} else {
throwExceptionId(clazz);
}
}
return false;
}
Debug到這里，可以看到，如果沒有 @TableId 注解顯示設置主鍵策略情況下，默認設置的是 ID_WORKER(3)，即會根據雪花算法生成19位數(shù)字，long類型。
可以進一步發(fā)現(xiàn)，這里的 dbConfig是GlobalConfig.DbConfig實例，進入到DbConfig類，可以看到原來實體類映射的數(shù)據庫設置在這里，主鍵類型默認是IdType.ID_WORKER。
@Data
public static class DbConfig {
/**
* 數(shù)據庫類型
*/
private DbType dbType = DbType.OTHER;
/**
* 主鍵類型（默認 ID_WORKER）
*/
private IdType idType = IdType.ID_WORKER;
/**
* 表名前綴
*/
private String tablePrefix;
/**
* 表名、是否使用下劃線命名（默認 true:默認數(shù)據庫表下劃線命名）
*/
private boolean tableUnderline = true;
/**
* String 類型字段 LIKE
*/
private boolean columnLike = false;
/**
* 大寫命名
*/
private boolean capitalMode = false;
/**
* 表關鍵詞 key 生成器
*/
private IKeyGenerator keyGenerator;
/**
* 邏輯刪除全局值（默認 1、表示已刪除）
*/
private String logicDeleteValue = "1";
/**
* 邏輯未刪除全局值（默認 0、表示未刪除）
*/
private String logicNotDeleteValue = "0";
/**
* 字段驗證策略
*/
private FieldStrategy fieldStrategy = FieldStrategy.NOT_NULL;
}
至于如何生成雪花算法id，這里就不一一詳細介紹，具體邏輯是在MybatisDefaultParameterHandler類populateKeys方法里，核心代碼如下——
protected static Object populateKeys(MetaObjectHandler metaObjectHandler, TableInfo tableInfo,
MappedStatement ms, Object parameterObject, boolean isInsert) {
if (null == tableInfo) {
/* 不處理 */
return parameterObject;
}
/* 自定義元對象填充控制器 */
MetaObject metaObject = ms.getConfiguration().newMetaObject(parameterObject);
// 填充主鍵
if (isInsert && !StringUtils.isEmpty(tableInfo.getKeyProperty())
&& null != tableInfo.getIdType() && tableInfo.getIdType().getKey() >= 3) {
Object idValue = metaObject.getValue(tableInfo.getKeyProperty());
/* 自定義 ID */
if (StringUtils.checkValNull(idValue)) {
if (tableInfo.getIdType() == IdType.ID_WORKER) {
metaObject.setValue(tableInfo.getKeyProperty(), IdWorker.getId());
} else if (tableInfo.getIdType() == IdType.ID_WORKER_STR) {
metaObject.setValue(tableInfo.getKeyProperty(), IdWorker.getIdStr());
} else if (tableInfo.getIdType() == IdType.UUID) {
metaObject.setValue(tableInfo.getKeyProperty(), IdWorker.get32UUID());
}
}
}
......
}
前邊提到，默認的主鍵策略是IdType.ID_WORKER，這里有一個判斷tableInfo.getIdType() == IdType.ID_WORKER，對代碼Debug可以看到，metaObject的setValue(tableInfo.getKeyProperty(), IdWorker.getId())代碼的作用，是對注解id進行了值填充。
填充的值為IdWorker.getId()返回的1468970800437465089，剛好是19位長度，這就意味著，這里產生的id值，就是我們最后要找的。
IdWorker.getId()實現(xiàn)本質，正好是基于Snowflake實現(xiàn)64位自增ID算法，而Snowflake，正是引用了雪花算法——
/**
* <p>
* 高效GUID產生算法(sequence),基于Snowflake實現(xiàn)64位自增ID算法。 <br>
* 優(yōu)化開源項目 http://git.oschina.net/yu120/sequence
* </p>
*
* @author hubin
* @since 2016-08-01
*/
public class IdWorker {
/**
* 主機和進程的機器碼
*/
private static final Sequence WORKER = new Sequence();
public static long getId() {
return WORKER.nextId();
}
public static String getIdStr() {
return String.valueOf(WORKER.nextId());
}
/**
* <p>
* 獲取去掉"-" UUID
* </p>
*/
public static synchronized String get32UUID() {
return UUID.randomUUID().toString().replace(StringPool.DASH, StringPool.EMPTY);
}
}
到此這篇關于Mybatis-Plus默認主鍵策略導致自動生成19位長度主鍵id的坑的文章就介紹到這了,更多相關Mybatis-Plus id主鍵生成內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了使用Java 8中的Stream遍歷樹形結構,我們可以使用Java8中的Stream流一次性把數(shù)據查出來,然后通過流式處理,我們一起來看看,代碼實現(xiàn)為了實現(xiàn)簡單,就模擬查看數(shù)據庫所有數(shù)據到List里面,需要的朋友可以參考下2023-08-08
根據當前用戶本地IP地址,查詢IP地址庫,獲取IP所在的省市信息,目前有多種方式實現(xiàn)該功能,這篇文章主要給大家介紹了關于java如何根據用戶請求獲取ip地址并解析省市信息的相關資料,需要的朋友可以參考下2023-12-12
這篇文章主要為大家詳細介紹了Java實現(xiàn)簡單圖形界面計算器，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-04-04
這篇文章主要介紹了Spring Boot 多個定時器沖突問題的解決方法,實際開發(fā)中定時器需要解決多個定時器同時并發(fā)的問題，也要解決定時器之間的沖突問題，本文通過問題場景重現(xiàn)給大家介紹的非常詳細，需要的朋友參考下吧2022-05-05
SpringBoot 整合 Avro 與 Kafka的詳細過程
本文介紹了如何在Spring Boot中使用Avro和Kafka進行數(shù)據的序列化和反序列化,并通過MyBatisPlus將數(shù)據存入數(shù)據庫,感興趣的朋友跟隨小編一起看看吧2024-12-12
本文給大家分享了2個使用java檢測字符串中是否包含中文的代碼，都非常的實用，最后附上了各種字符的unicode編碼的范圍，方便我們以后使用正則進行匹配檢測。2015-10-10
本篇文章主要介紹了Maven鏡像更換為阿里云中央倉庫(精)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-12-12
這篇文章主要介紹了Java后臺處理Json格式數(shù)據的方法的相關資料,非常不錯具有參考借鑒價值，需要的朋友可以參考下2016-06-06
本文非常詳細的講解了java反射的相關資料，java反射在現(xiàn)今的使用中很頻繁，希望此文可以幫大家解答疑惑，可以幫助大家理解2021-11-11
這篇文章主要介紹了Java中StringBuilder常用構造方法解析,StringBuilder是一個可標的字符串類,我們可以吧它看成是一個容器這里的可變指的是StringBuilder對象中的內容是可變的,需要的朋友可以參考下2024-01-01