1. 背景
最近手头上刚好需要整合mybatis-plus和shardingjdbc项目，那么框架是springboot，所以打算使用mybatis-plus的starter和shardingjdbc的starter。
2. 整合mybatis-plus和shardingjdbc
1.pom文件
<!-- Mybatis-plus时引入的配置 start -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.2.0</version>
</dependency>
<dependency>
<groupId>io.shardingsphere</groupId>
<artifactId>sharding-jdbc-spring-boot-starter</artifactId>
<version>3.1.0</version>
</dependency>
这里用的mybatis-plus-boot-starter版本是3.2.0，sharding-jdbc-spring-boot-starter是3.1.0。
整合好了以后就把常规的mybatis-plus相关配置配一下，还有shardingjdb的配置，如下：
# sharding-jdbc配置
sharding:
jdbc:
datasource:
names: test1,test2
test1: # 数据源1
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://xx:3306/xx?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true&useSSL=false
username: xx
password: xx
test2: # 数据源2
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://yyy:3306/activitycore?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true&useSSL=false
username: yy
password: yy
config:
sharding:
tables:
config:
database-strategy:
standard:
sharding-column: code
# 分片规则class
precise-algorithm-class-name: com.yy.yy.ModuloShardingDatabaseAlgorithm
# mybatis-plus配置
mybatis-plus:
mapper-locations: classpath:/mapper/*.xml
type-aliases-package: com.yyy.entity
configuration:
cache-enabled: false
map-underscore-to-camel-case: true
call-setters-on-nulls: true
## mybatis日志上线时关闭，仅用于本地调试
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
3.发现问题
1.配置好了以后，启动一下，发现报错
Caused by: java.lang.IllegalArgumentException: Property 'sqlSessionFactory' or 'sqlSessionTemplate' are required
at org.springframework.util.Assert.notNull(Assert.java:198) ~[spring-core-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.mybatis.spring.support.SqlSessionDaoSupport.checkDaoConfig(SqlSessionDaoSupport.java:122) ~[mybatis-spring-2.0.2.jar:2.0.2]
at org.mybatis.spring.mapper.MapperFactoryBean.checkDaoConfig(MapperFactoryBean.java:73) ~[mybatis-spring-2.0.2.jar:2.0.2]
at org.springframework.dao.support.DaoSupport.afterPropertiesSet(DaoSupport.java:44) ~[spring-tx-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1855) ~[spring-beans-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1792) ~[spring-beans-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:595) ~[spring-beans-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:517) ~[spring-beans-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:323) ~[spring-beans-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:226) ~[spring-beans-5.2.7.RELEASE.jar:5.2.7.RELEASE]
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:321) ~[spring-beans-5.2.7.RELEASE.jar:5.2.7.RELEASE]
2.看一下代码
就是这个东西为空报错了，这个sqlSessionTemplate是空的导致的，然后我们这边找一下赋值的地方。
发现是空的，那是在哪写入的值呢，这里先留个谜底。
3.虽然我们不知道那里写入的这个值，但是我们知道肯定是要赋值这个sqlSessionTemplate的，不然就报错了。那么对于sqlSessionTemplate这个基本上都是放到spring的ioc去管理的，所以需要看一下在哪注入到spring的ioc中的。
4.这个sqlSessionTemplate很容易就让我们想到了应该是在mybatisplus的configuration的时候@bean写进去的。那么到这个mybatis-plus的自动装配类：MybatisPlusAutoConfiguration
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisPlusProperties.class)
@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisPlusAutoConfiguration implements InitializingBean {
//xxxx
// xxxx
@Bean
@ConditionalOnMissingBean
public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
ExecutorType executorType = this.properties.getExecutorType();
if (executorType != null) {
return new SqlSessionTemplate(sqlSessionFactory, executorType);
} else {
return new SqlSessionTemplate(sqlSessionFactory);
}
}
}
看到了，就是在MybatisPlusAutoConfiguration注入的，那么打上断点。
5.发现确实没进来，那么为啥没进来，看这个上面有@ConditionalOnMissingBean注解，难道是已经注入了过了，然后我这次又在spring初始化单例bean的时候打上断点，发现并没有初始化过名字是sqlSessionTemplate的bean。
6.那么很有可能是这整个MybatisPlusAutoConfiguration都是没加载的，多打几个断点，发现确实都没进入
7.那么怎么排查MybatisPlusAutoConfiguration加载情况呢？
8.在application.yml加上debug=true，就会打印出加载情况
9.可以看到这里是由于缺少了datasource的bean，导致MybatisPlusAutoConfiguration没有注入，然后sqlSessionTemplate也没注入。
4.解决问题
1.那么找到原因是因为没有datasource的bean，其实正常的业务来说是需要配置spring.datasource.xxx来配置数据源，这样就能注入了。但是由于这里接入了shardingjdbc，那么默认的数据源就需要用shardingjdbc，所以没配置spring.datasource.xxx。
因此我们需要将shardingjdbc包装成数据源，放到mybatisplus里面。
2.这里也是看一下shardingjdbc的starter的configuration
@Configuration
@EnableConfigurationProperties({
SpringBootShardingRuleConfigurationProperties.class, SpringBootMasterSlaveRuleConfigurationProperties.class,
SpringBootConfigMapConfigurationProperties.class, SpringBootPropertiesConfigurationProperties.class
})
@RequiredArgsConstructor
public class SpringBootConfiguration implements EnvironmentAware {
private final SpringBootShardingRuleConfigurationProperties shardingProperties;
private final SpringBootMasterSlaveRuleConfigurationProperties masterSlaveProperties;
private final SpringBootConfigMapConfigurationProperties configMapProperties;
private final SpringBootPropertiesConfigurationProperties propMapProperties;
private final Map<String, DataSource> dataSourceMap = new LinkedHashMap<>();
/**
* Get data source bean.
*
* @return data source bean
* @throws SQLException SQL exception
*/
@Bean
public DataSource dataSource() throws SQLException {
return null == masterSlaveProperties.getMasterDataSourceName()
? ShardingDataSourceFactory
.createDataSource(dataSourceMap, shardingProperties.getShardingRuleConfiguration(), configMapProperties.getConfigMap(), propMapProperties.getProps())
: MasterSlaveDataSourceFactory.createDataSource(
dataSourceMap, masterSlaveProperties.getMasterSlaveRuleConfiguration(), configMapProperties.getConfigMap(), propMapProperties.getProps());
}
@Override
public final void setEnvironment(final Environment environment) {
setDataSourceMap(environment);
}
@SuppressWarnings("unchecked")
private void setDataSourceMap(final Environment environment) {
String prefix = "sharding.jdbc.datasource.";
String dataSources = environment.getProperty(prefix + "names");
for (String each : dataSources.split(",")) {
try {
Map<String, Object> dataSourceProps = PropertyUtil.handle(environment, prefix + each.trim(), Map.class);
Preconditions.checkState(!dataSourceProps.isEmpty(), "Wrong datasource properties!");
DataSource dataSource = DataSourceUtil
.getDataSource(dataSourceProps.get("type").toString(), dataSourceProps);
dataSourceMap.put(each, dataSource);
} catch (final ReflectiveOperationException ex) {
throw new ShardingException("Can't find datasource type!", ex);
}
}
}
}
这里很简单，可以看到shardingjdbc是自动注入了datasource了，但是为啥mybatisplus的configuration没有找到呢？
3.原因就是加载的顺序，在datasouce还没注入的时候mybatis的configuration就已经开始加载了，自然就加载不到
4.解决办法
@AutoConfigureAfter(SpringBootConfiguration.class)
@Configuration
public class CustomMybatisPlusAutoConfiguration extends MybatisPlusAutoConfiguration {
public CustomMybatisPlusAutoConfiguration(MybatisPlusProperties properties, ObjectProvider<Interceptor[]> interceptorsProvider, ObjectProvider<TypeHandler[]> typeHandlersProvider, ObjectProvider<LanguageDriver[]> languageDriversProvider, ResourceLoader resourceLoader, ObjectProvider<DatabaseIdProvider> databaseIdProvider, ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider, ObjectProvider<List<MybatisPlusPropertiesCustomizer>> mybatisPlusPropertiesCustomizerProvider, ApplicationContext applicationContext) {
super(properties, interceptorsProvider, typeHandlersProvider, languageDriversProvider, resourceLoader,
databaseIdProvider, configurationCustomizersProvider, mybatisPlusPropertiesCustomizerProvider, applicationContext);
}
}
将MybatisPlusAutoConfiguration单独拉出来集成，然后配置，通过@AutoConfigureAfter让他加载顺在jdbc的SpringBootConfiguration之后。
- 这样就顺利解决了
5.sqlsessionTemplete的注入之谜
1.对于上面有一个点，sqlsessionTemplete发现是空的，然后找赋值的地方发现没地方给赋值。
2.对于这种情况，那么首先就想到的就是这个注入是通过反射写入的，在反射的地方拿出这个数据，然后给设置值。
3.通过断点发现是有调用的这个
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
if (this.sqlSessionTemplate == null || sqlSessionFactory != this.sqlSessionTemplate.getSqlSessionFactory()) {
this.sqlSessionTemplate = createSqlSessionTemplate(sqlSessionFactory);
}
}
但是这个是为啥能调用呢，难道方法名和属性名一致，然后注入bean的时候就会自动填充？但是这里也没有@Autowired相关的使用
private SqlSessionTemplate sqlSessionTemplate;
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
if (this.sqlSessionTemplate == null || sqlSessionFactory != this.sqlSessionTemplate.getSqlSessionFactory()) {
this.sqlSessionTemplate = createSqlSessionTemplate(sqlSessionFactory);
}
}
4.我们在调用setSqlSessionFactory的地方加上断点，然后在上几层调用栈发现确实是需要填充这个sqlSessionFactory字段。
5.这里我们一路跟到源头是哪里给这个属性赋值的，方法：org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#populateBean
6.当可以看出，当前的resolveAuotwireMode是2，也就是AutowireCapableBeanFactory.AUTOWIRE_BY_TYPE，这里就会把这些字段加载进去。
7.那么这个值在哪设置的呢？查看setAutowireMode方法
这里就能看到是在扫描mapper的时候，注入bean定义时设置的。
这个处理bean定义会在这个org.mybatis.spring.mapper.MapperScannerConfigurer调用。
public class MapperScannerConfigurer
implements BeanDefinitionRegistryPostProcessor, InitializingBean, ApplicationContextAware, BeanNameAware {
//xxxxx
}
看这个类实现了BeanDefinitionRegistryPostProcessor就知道，会在bean定义注册后调用。
7.BeanDefinition的autowireMode
1.在上面我们提到了BeanDefinition的autowireMode。
这里对这个值解释一下：
0 AUTOWIRE_NO： 默认装配模式， 目前非xml配置都是使用这种方式，然后程序员使用注解手动注入
1 AUTOWIRE_BY_NAME: 通过set方法，并且 set方法的名称需要和bean的name一致 byName
2 AUTOWIRE_BY_TYPE: 通过set方法,并且再根据bean的类型，注入属性，是通过类型配置 byType
这个有点像@Autowired注解，但是这个不一样的是针对bean的所有字段，这样只要你设置了这个值，相当于所有字段默认会去spring ioc中填充。
2.例子：
2.1 这里ConfigServiceImpl定义了一个成员变量：userService
@Service
public class ConfigServiceImpl implements ConfigService {
@Override
public void add() {
}
private UserService userService;
public UserService getUserService() {
return userService;
}
public void setUserService(UserService UserService) {
this.userService = UserService;
}
}
2.2 这样直接启动，setUserService函数是不会被调用的，因为Bean定义的autowireMode是AUTOWIRE_NO
2.3 那么我们试着修改一下bean的定义，把它改成AUTOWIRE_BY_NAME
@Component
public class UpdateAutowireModeBeanFactory implements BeanDefinitionRegistryPostProcessor {
@Override
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
BeanDefinition bd = registry.getBeanDefinition("configServiceImpl");
if (bd == null) {
return;
}
GenericBeanDefinition gbd = (GenericBeanDefinition) bd;
gbd.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
return;
}
}
2.4 再启动，就能看到setUserService函数被调用了，并且userService有值了
