mybatis升級爲mybatis-plus踩到的坑

時間  2020-12-05
標籤 java spring sql apache session mybatis app 框架 maven ide 欄目 MyBatis 简体版
原文   原文鏈接

前言

最近使用RuoYi-Vue來作後臺管理腳手架。RuoYi-Vue 是一個 Java EE 企業級快速開發平臺，基於經典技術組合（Spring Boot、Spring Security、MyBatis、Jwt、Vue），內置模塊如：部門管理、角色用戶、菜單及按鈕受權、數據權限、系統參數、日誌管理、代碼生成等。在線定時任務配置；支持集羣，支持多數據源。其官方文檔以下java

http://doc.ruoyi.vip/spring

感興趣的朋友，能夠點連接查看。這個平臺目前的orm框架是mybatis，而項目組的orm框架是mybatis-plus。爲了統一技術棧，項目組就決定把若依的orm框架升級爲mybatis-plus。由於以前就有過把mybatis升級爲mybatis-plus的經驗，就感受這個升級是很簡單。可是在改造後，運行程序卻報了形以下異常sql

Invalid bound statement (not found): com.lybgeek.admin.file.mapper.FileMapper.insert

排查

從異常的字面意思是說，FIleMapper中的insert方法沒有綁定。查看FileMapper.xml配置，確實沒有發現綁定insert這個sql語句塊。那是否加上insert的sql語句塊，就能解決問題？加上確實是能解決問題。apache

但若是用過mybatis-plus的朋友，應該會知道，mybatis-plus中BaseMapper已經幫咱們封裝好了一系列的單表增刪改查，咱們無需寫配置，就能夠實現單表增刪改查。因此在xml配置insert是治標不治本。session

那要如何排查呢？mybatis

一、方向一：是不是包衝突引發？app

利用maven helper插件包衝突框架

包衝突.png 從圖能夠看出不是包衝突引發的。maven

注： 由於以前吃過包衝突的虧，所以在把若依的orm改爲mybatis-plus以前，就已經去除跟mybatis相關的 jar衝突了ide

方向二：是否是引入不一樣類包的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

修復

一、方法一

把mybatis的SqlSessionFactoryBean替換成mybatis-plus的MybatisSqlSessionFactoryBean

二、方法二

去掉項目中sqlSessionFactory。這樣mybatis-plus就會自動幫咱們注入sqlSessionFactory

總結

可能有朋友會以爲遇到異常問題，直接經過搜索引擎找答案不就能夠了。這確實是一個挺好的方法，但有時候可能搜索半天都沒找到答案，咱們就能夠經過異常信息棧、以及調試線程棧，就能夠得出一些比較有用的信息。出現異常並不可怕，可怕的是出了問題，異常日誌信息被吞，都不知道從何排查。最後安利一下若依這個腳手架，管理後臺開發神器，誰用誰知道

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程