乐趣区

关于mybatis:mybatis升级为mybatisplus踩到的坑

jiezi

前言

最近应用 RuoYi-Vue 来做后盾治理脚手架。RuoYi-Vue 是一个 Java EE 企业级疾速开发平台，基于经典技术组合（Spring Boot、Spring Security、MyBatis、Jwt、Vue），内置模块如：部门治理、角色用户、菜单及按钮受权、数据权限、零碎参数、日志治理、代码生成等。在线定时工作配置；反对集群，反对多数据源。其官网文档如下

http://doc.ruoyi.vip/

感兴趣的敌人，能够点链接查看。这个平台目前的 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

总结

可能有敌人会感觉遇到异样问题，间接通过搜索引擎找答案不就能够了。这的确是一个挺好的办法，但有时候可能搜寻半天都没找到答案，咱们就能够通过异样信息栈、以及调试线程栈，就能够得出一些比拟有用的信息。出现异常并不可怕，可怕的是出了问题，异样日志信息被吞，都不晓得从何排查。最初安利一下若依这个脚手架，治理后盾开发神器，谁用谁晓得

退出移动版