mybatis升級為mybatis-plus踩到的坑
前言
最近使用RuoYi-Vue來做後臺管理腳手架。RuoYi-Vue 是一個 Java EE 企業級快速開發平臺，基於經典技術組合（Spring Boot、Spring Security、MyBatis、Jwt、Vue），內建模組如：部門管理、角色使用者、選單及按鈕授權、資料許可權、系統引數、日誌管理、程式碼生成等。線上定時任務配置；支援叢集，支援多資料來源。其官方文件如下
感興趣的朋友，可以點連結檢視。這個平臺目前的orm框架是mybatis，而專案組的orm框架是mybatis-plus。為了統一技術棧，專案組就決定把若依的orm框架升級為mybatis-plus。因為之前就有過把mybatis升級為mybatis-plus的經驗，就感覺這個升級是很簡單。但是在改造後，執行程式卻報了形如下異常
Invalid bound statement (not found): com.lybgeek.admin.file.mapper.FileMapper.insert
排查
從異常的字面意思是說，FIleMapper中的insert方法沒有繫結。檢視FileMapper.xml配置，確實沒有發現繫結insert這個sql語句塊。那是否加上insert的sql語句塊，就能解決問題？加上確實是能解決問題。
但如果用過mybatis-plus的朋友，應該會知道，mybatis-plus中BaseMapper已經幫我們封裝好了一系列的單表增刪改查，我們無需寫配置，就可以實現單表增刪改查。所以在xml配置insert是治標不治本。
那要如何排查呢？
1、方向一：是否是包衝突引起？
利用maven helper外掛包衝突
從圖可以看出不是包衝突引起的。
注： 因為之前吃過包衝突的虧，因此在把若依的orm改成mybatis-plus之前，就已經去除跟mybatis相關的 jar衝突了
方向二：是不是引入不同類包的BaseMapper
我們引入的必須是
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
而不是
import com.baomidou.mybatisplus.mapper.BaseMapper;
不過出現這個問題，通常也是引入不同版本的mybatis-plus jar才會出現。如果你是隻用3+以上版本，他引入就只有
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
方向三：通用方法（斷點除錯）
其實程式碼排查最怕就是異常棧被吃了，如果有異常資訊，排查方向相對比較好找。比如這個異常，其異常棧資訊為
Caused by: org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.lybgeek.admin.file.mapper.FileMapper.insert
at org.apache.ibatis.binding.MapperMethod$SqlCommand.<init>(MapperMethod.java:235)
at org.apache.ibatis.binding.MapperMethod.<init>(MapperMethod.java:53)
at org.apache.ibatis.binding.MapperProxy.lambda$cachedInvoker$0(MapperProxy.java:107)
at java.util.concurrent.ConcurrentHashMap.computeIfAbsent(ConcurrentHashMap.java:1660)
at org.apache.ibatis.binding.MapperProxy.cachedInvoker(MapperProxy.java:94)
at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:85)
at com.sun.proxy.$Proxy129.insert(Unknown Source)
at com.baomidou.mybatisplus.extension.service.IService.save(IService.java:59)
at com.baomidou.mybatisplus.extension.service.IService$$FastClassBySpringCGLIB$$f8525d18.invoke(<generated>)
at org.springframework.cglib.proxy.MethodProxy.invoke(MethodProxy.java:218)
我們從異常棧資訊，我們可以知道這個異常從
org.apache.ibatis.binding.MapperMethod
這個類丟擲，於是我們可以把斷點先設定到這邊。通過原始碼我們可以得知org.apache.ibatis.mapping.MappedStatement空了，導致報瞭如上異常，而MappedStatement又是由
org.apache.ibatis.session.Configuration
提供。而Configuration是通過
org.apache.ibatis.session.SqlSessionFactory
進行設定。然後繼續排查，就會發現
com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration
這個自動裝配類。裡面有這麼一段程式碼
@Bean
@ConditionalOnMissingBean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
// TODO 使用 MybatisSqlSessionFactoryBean 而不是 SqlSessionFactoryBean
MybatisSqlSessionFactoryBean factory = new MybatisSqlSessionFactoryBean();
factory.setDataSource(dataSource);
factory.setVfs(SpringBootVFS.class);
if (StringUtils.hasText(this.properties.getConfigLocation())) {
factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
}
applyConfiguration(factory);
if (this.properties.getConfigurationProperties() != null) {
factory.setConfigurationProperties(this.properties.getConfigurationProperties());
}
if (!ObjectUtils.isEmpty(this.interceptors)) {
factory.setPlugins(this.interceptors);
}
if (this.databaseIdProvider != null) {
factory.setDatabaseIdProvider(this.databaseIdProvider);
}
if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
}
if (this.properties.getTypeAliasesSuperType() != null) {
factory.setTypeAliasesSuperType(this.properties.getTypeAliasesSuperType());
}
if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
}
if (!ObjectUtils.isEmpty(this.typeHandlers)) {
factory.setTypeHandlers(this.typeHandlers);
}
Resource[] mapperLocations = this.properties.resolveMapperLocations();
if (!ObjectUtils.isEmpty(mapperLocations)) {
factory.setMapperLocations(mapperLocations);
}
// TODO 對原始碼做了一定的修改(因為原始碼適配了老舊的mybatis版本,但我們不需要適配)
Class<? extends LanguageDriver> defaultLanguageDriver = this.properties.getDefaultScriptingLanguageDriver();
if (!ObjectUtils.isEmpty(this.languageDrivers)) {
factory.setScriptingLanguageDrivers(this.languageDrivers);
}
Optional.ofNullable(defaultLanguageDriver).ifPresent(factory::setDefaultScriptingLanguageDriver);
// TODO 自定義列舉包
if (StringUtils.hasLength(this.properties.getTypeEnumsPackage())) {
factory.setTypeEnumsPackage(this.properties.getTypeEnumsPackage());
}
// TODO 此處必為非 NULL
GlobalConfig globalConfig = this.properties.getGlobalConfig();
// TODO 注入填充器
this.getBeanThen(MetaObjectHandler.class, globalConfig::setMetaObjectHandler);
// TODO 注入主鍵生成器
this.getBeanThen(IKeyGenerator.class, i -> globalConfig.getDbConfig().setKeyGenerator(i));
// TODO 注入sql注入器
this.getBeanThen(ISqlInjector.class, globalConfig::setSqlInjector);
// TODO 注入ID生成器
this.getBeanThen(IdentifierGenerator.class, globalConfig::setIdentifierGenerator);
// TODO 設定 GlobalConfig 到 MybatisSqlSessionFactoryBean
factory.setGlobalConfig(globalConfig);
return factory.getObject();
}
作者在註釋上都寫了，要用
MybatisSqlSessionFactoryBean 而不是 SqlSessionFactoryBean
於是檢視若依程式碼，發現在若依中的mybatis配置類中有配置如下程式碼片段
@Bean
public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception
{
String typeAliasesPackage = env.getProperty("mybatis.type-aliases-package");
String mapperLocations = env.getProperty("mybatis.mapper-locations");
String configLocation = env.getProperty("mybatis.config-location");
typeAliasesPackage = setTypeAliasesPackage(typeAliasesPackage);
VFS.addImplClass(SpringBootVFS.class);
final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
sessionFactory.setDataSource(dataSource);
sessionFactory.setTypeAliasesPackage(typeAliasesPackage);
sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(mapperLocations));
sessionFactory.setConfigLocation(new DefaultResourceLoader().getResource(configLocation));
return sessionFactory.getObject();
}
從MybatisPlusAutoConfiguration的原始碼中，我們可以得知，當專案已經有配置SqlSessionFactory。mybatis-plus將不會自動幫我們注入SqlSessionFactory，而使用我們自己定義的SqlSessionFactory。而若依專案配置的SqlSessionFactory不是MybatisSqlSessionFactoryBean
修復
1、方法一
把mybatis的SqlSessionFactoryBean替換成mybatis-plus的MybatisSqlSessionFactoryBean
2、方法二
去掉專案中sqlSessionFactory。這樣mybatis-plus就會自動幫我們注入sqlSessionFactory
總結
可能有朋友會覺得遇到異常問題，直接通過搜尋引擎找答案不就可以了。這確實是一個挺好的方法，但有時候可能搜尋半天都沒找到答案，我們就可以通過異常資訊棧、以及除錯執行緒棧，就可以得出一些比較有用的資訊。出現異常並不可怕，可怕的是出了問題，異常日誌資訊被吞，都不知道從何排查。最後安利一下若依這個腳手架，管理後臺開發神器，誰用誰知道