springboot mybatis調用多個數據源引發的錯誤問題
springboot mybatis調用多個數據源錯誤
報錯
'org.springframework.boot.autoconfigure.jdbc.DataSourceInitializerInvoker': Invocation of init method failed; nested exception is org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type 'javax.sql.DataSource' available: more than one 'primary' bean found among candidates: [mssqlDataSource, postgreDataSource]
從後往前復制的，加粗的是重點。
因為有多個數據源使用同一個mapper接口，但是都用@Primary,則會引起此錯誤。
如圖所示：
從上面兩圖可以看出都用瞭同一個mapper接口，都添加瞭@Primary。
解決方法
解決方法有兩種，一種是把其中一個數據源去掉@Primary，動態調用數據源，就是需要代碼切換使用的數據源。
如果要同時使用兩個數據源，那就用不同的mapper，相當於postgre用postgre部分的mapper，sqlserver用sqlserver部分的mapper，大傢互不幹擾，就算@primary也沒事
如圖所示，我將postgre的MapperScan改瞭
springboot-mybatis多數據源及踩坑
springboot項目結構如下
springboot配置文件內容如下
動態數據源的配置類如下
（必須保證能被ComponentScan掃描到）：
package com.letzgo.config;
import com.alibaba.druid.pool.DruidDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import javax.sql.DataSource;
/**
* @author allen
* @date 2019-01-10 15:08
*/
public class DynamicDatasourceConfig {
@Configuration
@MapperScan(basePackages = "com.letzgo.dao.master")
public static class Master {
@Primary
@Bean("masterDataSource")
@Qualifier("masterDataSource")
@ConfigurationProperties(prefix = "spring.datasource.master")
public DataSource dataSource() {
return new DruidDataSource();
}
@Primary
@Bean("masterSqlSessionFactory")
@Qualifier("masterSqlSessionFactory")
public SqlSessionFactory sqlSessionFactory(@Qualifier("masterDataSource") DataSource dataSource) throws Exception {
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(dataSource);
factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/master/*.xml"));
return factoryBean.getObject();
}
@Primary
@Bean("masterTransactionManager")
@Qualifier("masterTransactionManager")
public DataSourceTransactionManager transactionManager(@Qualifier("masterDataSource") DataSource dataSource) {
return new DataSourceTransactionManager(dataSource);
}
@Primary
@Bean("masterSqlSessionTemplate")
@Qualifier("masterSqlSessionTemplate")
public SqlSessionTemplate sqlSessionTemplate(@Qualifier("masterSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
return new SqlSessionTemplate(sqlSessionFactory);
}
}
@Configuration
@MapperScan(basePackages = "com.letzgo.dao.slave")
public static class Slave {
@Bean("slaveDataSource")
@Qualifier("slaveDataSource")
@ConfigurationProperties(prefix = "spring.datasource.slave")
public DataSource dataSource() {
return new DruidDataSource();
}
@Bean("slaveSqlSessionFactory")
@Qualifier("slaveSqlSessionFactory")
public SqlSessionFactory sqlSessionFactory(@Qualifier("slaveDataSource") DataSource dataSource) throws Exception {
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(dataSource);
factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/slave/*.xml"));
return factoryBean.getObject();
}
@Bean("slaveTransactionManager")
@Qualifier("slaveTransactionManager")
public DataSourceTransactionManager transactionManager(@Qualifier("slaveDataSource") DataSource dataSource) {
return new DataSourceTransactionManager(dataSource);
}
@Bean("slaveSqlSessionTemplate")
@Qualifier("slaveSqlSessionTemplate")
public SqlSessionTemplate sqlSessionTemplate(@Qualifier("slaveSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
return new SqlSessionTemplate(sqlSessionFactory);
}
}
}
完成基本配置之後，分別在master和slave中寫一個數據庫訪問操作，再開放兩個簡單的接口，分別觸發master和slave的數據看訪問操作。
至此沒項目基本結構搭建已完成，啟動項目，進行測試。
我們會發現這樣master的數據庫訪問是能正常訪問的，但是slave的數據庫操作是不行的，報錯信息如下：
org.apache.ibatis.binding.BindingException: Invalid bound statement (not found):***
對於這樣錯誤，起初企圖通過百度解決，大部分都是說xml文件的命名空間和dao接口全名不對應或者說是接口方法和xml中的方法不對應等等解決方法，
本人檢查瞭自己的代碼多遍重啟多遍均無法解決，並不是說這些方法不對，但是本案例的問題卻不是這些問題導致的。最後無奈，隻能硬著頭皮去看源碼，最後發現瞭問題所在。
debug源碼調試到最後，發現不論是執行mater還是slave的數據庫操作，使用瞭相同的SqlSession，同一個！！！這個肯定是有問題的。
繼續看源碼進行查，看SqlSession的註入過程。
我們知道mybatis隻要寫接口不用寫實現類（應該是3.0之後的版本），實際上是使用瞭代理，每個dao接口，在spring容器中其實是對應一個MapperFactoryBean（不懂FactoryBean的可以去多看看spring的一些核心接口，要想看懂spring源碼必須要知道的）。
當從容器中獲取bean的時候，MapperFactoryBean的getObject方法就會根據SqlSession實例生產一個MapperProxy對象的代理類。
問題的關鍵就在於MapperFactoryBean，他繼承瞭SqlSessionDaoSupport類，他有一個屬性，就是SqlSession，而且剛才所說的創建代理類所依賴的SqlSession實例就是這個。那我們看這個SqlSession實例是什麼時候註入的就可以瞭，就能找到為什麼註入瞭同一個對象瞭。
找spring註入的地方，spring註入的方式個人目前知道的有註解處理器如@Autowired的註解處理器AutowiredAnnotationBeanPostProcessor等類似的BeanPostProcessor接口的實現類，還有一種就是在BeanDefinition中定義器屬性的註入方式，在bean的定義階段就決定瞭的，前者如果不知道的可以看看，在此不做贅述，後者的處理過程源碼如下（隻截取核心部分，感興趣的可以自己看一下處理過程，調用鏈比較深，貼代碼會比較多，看著眼花繚亂）：
debug到dao接口類的的BeanDefinition（上文已說過其實是MapperFactoryBean），發現他的autowiremode是2，參照源碼
即可發現為按照類型自動裝配
最關鍵的來瞭
debug的時候發現，master的dao接口執行到this.autowireByType(beanName, mbd, bw, newPvs)方法中，給MapperFactoryBean中SqlSession屬性註入的實例是masterSqlSessionTemplate對象，
slave的dao接口執行該方法時註入的也是masterSqlSessionTemplate對象，按類型註入，spring容器中找到一個即註入（此時slaveSqlSessionTemplate也在容器中，為什麼按類型註入找到瞭masterSqlSessionTemplate卻沒報錯，應該是@Primary的作用）
至此，問題產生的原因已基本找到，那該如何解決呢？BeanDefinition為什麼會定義成autowiremode=2呢，隻能找@MapperScan看瞭，看這個註解的處理源碼，最後找到ClassPathMapperScanner以下方法：
private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
Iterator var3 = beanDefinitions.iterator();
while(var3.hasNext()) {
BeanDefinitionHolder holder = (BeanDefinitionHolder)var3.next();
GenericBeanDefinition definition = (GenericBeanDefinition)holder.getBeanDefinition();
if (this.logger.isDebugEnabled()) {
this.logger.debug("Creating MapperFactoryBean with name '" + holder.getBeanName() + "' and '" + definition.getBeanClassName() + "' mapperInterface");
}
definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName());
definition.setBeanClass(this.mapperFactoryBean.getClass());
definition.getPropertyValues().add("addToConfig", this.addToConfig);
boolean explicitFactoryUsed = false;
if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionFactory != null) {
definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
explicitFactoryUsed = true;
}
if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
if (explicitFactoryUsed) {
this.logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionTemplate != null) {
if (explicitFactoryUsed) {
this.logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
}
definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
explicitFactoryUsed = true;
}
if (!explicitFactoryUsed) {
if (this.logger.isDebugEnabled()) {
this.logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
}
definition.setAutowireMode(2);
}
}
}
44行是關鍵，但是有個條件，這個條件成立的原因就是@MapperScan註解沒有指定過sqlSessionTemplateRef或者sqlSessionFactoryRef，正因為沒有指定特定的sqlSessionTemplate或者sqlSessionFactory，mybatis默認采用按類型自動裝配的方式進行註入。
至此，問題解決方案已出：
代碼中的兩個@MapperScan用法分別改為：
@MapperScan(basePackages = "com.letzgo.dao.master", sqlSessionFactoryRef = "masterSqlSessionFactory", sqlSessionTemplateRef = "masterSqlSessionTemplate") @MapperScan(basePackages = "com.letzgo.dao.slave", sqlSessionFactoryRef = "slaveSqlSessionFactory", sqlSessionTemplateRef = "slaveSqlSessionTemplate")
重啟進行測試，問題解決。
PS：
還是對各種註解使用方法不瞭解（或者說對框架的源碼不瞭解），導致搞瞭這麼久的問題，還好最後查到瞭，記錄於此，給自己加深印象，以後還是要多看源碼。以上僅為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。
推薦閱讀：
- springboot如何連接兩個數據庫(多個)
- SpringBoot整合Mybatis Plus多數據源的實現示例
- Springboot如何同時裝配兩個相同類型數據庫
- 教你使用springboot配置多數據源
- Mybatis如何使用@Mapper和@MapperScan註解實現映射關系