spring boot 2升级为spring boot 3中数据库连接池druid的问题-编程知识

ConfigurationClassPostProcessor

ConfigurationClassBeanDefinitionReader

MybatisPlusAutoConfiguration

ConditionEvaluator

OnBeanCondition

总结

近期给了一个任务，要求是对现有的 spring boot 2.x 项目进行升级，由于 spring boot 2.x 版本已经结束技术支持，所以需要升级为 spring boot 3.x

https://spring.io/blog/2023/11/23/spring-boot-2-7-18-available-now/

升级后报了一个 mybatis 的问题，如下

Caused by: java.lang.IllegalArgumentException: Property 'sqlSessionFactory' or 'sqlSessionTemplate' are requiredat org.springframework.util.Assert.notNull(Assert.java:172)at org.mybatis.spring.support.SqlSessionDaoSupport.checkDaoConfig(SqlSessionDaoSupport.java:125)at org.mybatis.spring.mapper.MapperFactoryBean.checkDaoConfig(MapperFactoryBean.java:73)at org.springframework.dao.support.DaoSupport.afterPropertiesSet(DaoSupport.java:44)at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1822)at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1771)... 49 common frames omitted

即 SqlSessionFactory 没获取到，这个是操作 mybatis 必须要用的对象，这个竟然没有。

目前项目中使用的 mybatis 是增强版的 mybatis-plus，即在启动的时候启动 spring ioc 容器的时候没有找到 sqlSessionFactory 对象，鉴于是升级到新版本，考虑到版本变动大，所以自己新建了一个 spring boot 3 项目，来验证一下新的是否可以正常执行。

spring boot 3 项目中的 pom.xml 依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>3.2.0</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.example</groupId><artifactId>mybatis-plus-spring-boot-3</artifactId><version>0.0.1-SNAPSHOT</version><name>mybatis-plus-spring-boot-3</name><description>Demo project for Spring Boot</description><properties><java.version>21</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-webflux</artifactId></dependency><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-spring-boot3-starter</artifactId><version>3.5.5</version></dependency><dependency><groupId>com.mysql</groupId><artifactId>mysql-connector-j</artifactId></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

启动之后，发现正常。

那就是 mybatis-plus 哪里有问题了，跟进通过 AbstractApplicationContext#refresh() 跟进，发现在 ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry() 调用 ConfigurationClassBeanDefinitionReader#loadBeanDefinitions() 时出现了问题。

ConfigurationClassPostProcessor

ConfigurationClassBeanDefinitionReader

主要在 ConfigurationClassBeanDefinitionReader#loadBeanDefinitions() 中

其中，正常的 shouldSkip() 的返回值是 false，即执行接下来的 MybatisPlusAutoConfiguration$MapperScannerRegistrarNotFoundConfiguration 中的逻辑，将 MapperScannerConfigurer 类注册到 spring ioc 容器中。

MybatisPlusAutoConfiguration

看看 shouldSkip() 的 true 值是怎么来的

ConditionEvaluator

查看是如下的判断

这里有两个类，分别是 OnBeanCondition 和 OnClassCondition，其中 OnClassCondition 执行无异常，问题主要在 OnBeanCondition 上。

接下来对比一下看看两者变量赋值的区别

新项目没问题的

OnClassConditionrequiredPhase == null
truerequiredPhase == phase
false(requiredPhase == null || requiredPhase == phase)
truecondition.matches(this.context, metadata)
true!condition.matches(this.context, metadata)
false(requiredPhase == null || requiredPhase == phase) && !condition.matches(this.context, metadata)
falseOnBeanConditionrequiredPhase == null
falserequiredPhase == phase
true(requiredPhase == null || requiredPhase == phase)
truecondition.matches(this.context, metadata)
true!condition.matches(this.context, metadata)
false(requiredPhase == null || requiredPhase == phase) && !condition.matches(this.context, metadata)
false

原项目有问题的

OnClassConditionrequiredPhase == null
truerequiredPhase == phase
false(requiredPhase == null || requiredPhase == phase)
truecondition.matches(this.context, metadata)
true!condition.matches(this.context, metadata)
false(requiredPhase == null || requiredPhase == phase) && !condition.matches(this.context, metadata)
falseOnBeanConditionrequiredPhase == null
falserequiredPhase == phase
true(requiredPhase == null || requiredPhase == phase)
truecondition.matches(this.context, metadata)
false!condition.matches(this.context, metadata)
true(requiredPhase == null || requiredPhase == phase) && !condition.matches(this.context, metadata)
true

可以看到是 OnBeanCondition#matches() 返回有问题。

那就调试进去看一下

OnBeanCondition

发现在升级项目中变量 unmatchedTypes 中多了一个 javax.sql.DataSource 导致了返回结果为 false，进而导致了接下来的问题。

其中，isAllMatched() 的判断逻辑为 unmatchedAnnotations、unmatchedNames、unmatchedTypes 必须为空。

这就让我想到了数据源的问题，项目中使用了阿里巴巴开源的连接池 druid，是不是没注册进这个对象？后面发现了引入的依赖中没有针对 spring boot 3 的自动装配进行处理。

在项目的 src/main/resources 下创建文件 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

内容如下

com.alibaba.druid.spring.boot.autoconfigure.DruidDataSourceAutoConfigure

启动正常。

后面又去 github 上看了一下

https://github.com/alibaba/druid

发现对于 spring boot 3 做了适配

https://github.com/alibaba/druid/releases/tag/1.2.20

可以看到，在 2023.10.08 日处理了这个问题。

看 maven 仓库，引入 1.20.0 及以上的版本即可。

<dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-3-starter</artifactId><version>1.2.21</version>
</dependency>

通过源码对比，发现 druid-spring-boot-starter 不兼容 druid-spring-boot-3-starter，druid-spring-boot-3-starter 是专门对 spring boot 3 进行了适配。

对比源码发现，1.2.18 和 1.2.19 对于 spring boot 3 适配都有问题。

总结

针对项目中的问题很多，尤其是 spring boot 3 带来的变化大，针对一些问题，需要从源码层次入手看问题。

之前整理的升级相关的文章

https://blog.csdn.net/zlpzlpzyd/article/details/134203560

https://blog.csdn.net/zlpzlpzyd/article/details/133160643

https://blog.csdn.net/zlpzlpzyd/article/details/132779246

参考链接

https://blog.csdn.net/weixin_43333483/article/details/131355109

https://www.cnblogs.com/jimmyhu/p/17300314.html

https://juejin.cn/post/7165884190028726308