1. 程式人生 > >springboot-mybatis多數據源以及踩坑之旅

springboot-mybatis多數據源以及踩坑之旅

依賴 屬性 config 配置 rim auto solver 就會 註解處理器

首先,springboot項目結構如下

技術分享圖片

springboot配置文件內容如下

技術分享圖片

動態數據源的配置類如下(必須保證能被ComponentScan掃描到):

 1 package com.letzgo.config;
 2 
 3 import com.alibaba.druid.pool.DruidDataSource;
 4 import org.apache.ibatis.session.SqlSessionFactory;
 5 import org.mybatis.spring.SqlSessionFactoryBean;
 6 import org.mybatis.spring.SqlSessionTemplate;
 
7 import org.mybatis.spring.annotation.MapperScan; 8 import org.springframework.beans.factory.annotation.Qualifier; 9 import org.springframework.boot.context.properties.ConfigurationProperties; 10 import org.springframework.context.annotation.Bean; 11 import org.springframework.context.annotation.Configuration;
12 import org.springframework.context.annotation.Primary; 13 import org.springframework.core.io.support.PathMatchingResourcePatternResolver; 14 import org.springframework.jdbc.datasource.DataSourceTransactionManager; 15 16 import javax.sql.DataSource; 17 18 /** 19 * @author allen 20 * @date 2019-01-10 15:08 21
*/ 22 public class DynamicDatasourceConfig { 23 24 @Configuration 25 @MapperScan(basePackages = "com.letzgo.dao.master") 26 public static class Master { 27 @Primary 28 @Bean("masterDataSource") 29 @Qualifier("masterDataSource") 30 @ConfigurationProperties(prefix = "spring.datasource.master") 31 public DataSource dataSource() { 32 return new DruidDataSource(); 33 } 34 35 @Primary 36 @Bean("masterSqlSessionFactory") 37 @Qualifier("masterSqlSessionFactory") 38 public SqlSessionFactory sqlSessionFactory(@Qualifier("masterDataSource") DataSource dataSource) throws Exception { 39 SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean(); 40 factoryBean.setDataSource(dataSource); 41 factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/master/*.xml")); 42 return factoryBean.getObject(); 43 } 44 45 @Primary 46 @Bean("masterTransactionManager") 47 @Qualifier("masterTransactionManager") 48 public DataSourceTransactionManager transactionManager(@Qualifier("masterDataSource") DataSource dataSource) { 49 return new DataSourceTransactionManager(dataSource); 50 } 51 52 @Primary 53 @Bean("masterSqlSessionTemplate") 54 @Qualifier("masterSqlSessionTemplate") 55 public SqlSessionTemplate sqlSessionTemplate(@Qualifier("masterSqlSessionFactory") SqlSessionFactory sqlSessionFactory) { 56 return new SqlSessionTemplate(sqlSessionFactory); 57 } 58 59 } 60 61 @Configuration 62 @MapperScan(basePackages = "com.letzgo.dao.slave") 63 public static class Slave { 64 @Bean("slaveDataSource") 65 @Qualifier("slaveDataSource") 66 @ConfigurationProperties(prefix = "spring.datasource.slave") 67 public DataSource dataSource() { 68 return new DruidDataSource(); 69 } 70 71 @Bean("slaveSqlSessionFactory") 72 @Qualifier("slaveSqlSessionFactory") 73 public SqlSessionFactory sqlSessionFactory(@Qualifier("slaveDataSource") DataSource dataSource) throws Exception { 74 SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean(); 75 factoryBean.setDataSource(dataSource); 76 factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/slave/*.xml")); 77 return factoryBean.getObject(); 78 } 79 80 @Bean("slaveTransactionManager") 81 @Qualifier("slaveTransactionManager") 82 public DataSourceTransactionManager transactionManager(@Qualifier("slaveDataSource") DataSource dataSource) { 83 return new DataSourceTransactionManager(dataSource); 84 } 85 86 @Bean("slaveSqlSessionTemplate") 87 @Qualifier("slaveSqlSessionTemplate") 88 public SqlSessionTemplate sqlSessionTemplate(@Qualifier("slaveSqlSessionFactory") SqlSessionFactory sqlSessionFactory) { 89 return new SqlSessionTemplate(sqlSessionFactory); 90 } 91 } 92 93 }

完成基本配置之後,分別在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以下方法:

 1 private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
 2         Iterator var3 = beanDefinitions.iterator();
 3 
 4         while(var3.hasNext()) {
 5             BeanDefinitionHolder holder = (BeanDefinitionHolder)var3.next();
 6             GenericBeanDefinition definition = (GenericBeanDefinition)holder.getBeanDefinition();
 7             if (this.logger.isDebugEnabled()) {
 8                 this.logger.debug("Creating MapperFactoryBean with name ‘" + holder.getBeanName() + "‘ and ‘" + definition.getBeanClassName() + "‘ mapperInterface");
 9             }
10 
11             definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName());
12             definition.setBeanClass(this.mapperFactoryBean.getClass());
13             definition.getPropertyValues().add("addToConfig", this.addToConfig);
14             boolean explicitFactoryUsed = false;
15             if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
16                 definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
17                 explicitFactoryUsed = true;
18             } else if (this.sqlSessionFactory != null) {
19                 definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
20                 explicitFactoryUsed = true;
21             }
22 
23             if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
24                 if (explicitFactoryUsed) {
25                     this.logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
26                 }
27 
28                 definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
29                 explicitFactoryUsed = true;
30             } else if (this.sqlSessionTemplate != null) {
31                 if (explicitFactoryUsed) {
32                     this.logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
33                 }
34 
35                 definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
36                 explicitFactoryUsed = true;
37             }
38 
39             if (!explicitFactoryUsed) {
40                 if (this.logger.isDebugEnabled()) {
41                     this.logger.debug("Enabling autowire by type for MapperFactoryBean with name ‘" + holder.getBeanName() + "‘.");
42                 }
43 
44                 definition.setAutowireMode(2);
45             }
46         }
47 
48     }

44行是關鍵,但是有個條件,這個條件成立的原因就是@MapperScan註解沒有指定過sqlSessionTemplateRef或者sqlSessionFactoryRef,正因為沒有指定特定的sqlSessionTemplate或者sqlSessionFactory,mybatis默認采用按類型自動裝配的方式進行註入。

至此,問題解決方案已出:

代碼中的兩個@MapperScan用法分別改為:

1 @MapperScan(basePackages = "com.letzgo.dao.master", sqlSessionFactoryRef = "masterSqlSessionFactory", sqlSessionTemplateRef = "masterSqlSessionTemplate")
2  
3 @MapperScan(basePackages = "com.letzgo.dao.slave", sqlSessionFactoryRef = "slaveSqlSessionFactory", sqlSessionTemplateRef = "slaveSqlSessionTemplate")

重啟進行測試,問題解決。

PS:

還是對各種註解使用方法不了解(或者說對框架的源碼不了解),導致搞了這麽久的問題,還好最後查到了,記錄於此,給自己加深印象,也希望解決方案能幫到部分同行。以後還是要多看源碼,哈哈哈。

springboot-mybatis多數據源以及踩坑之旅