spring mybatis多半據源實例詳解

spring mybatis多半據源實例詳解。本站提示廣大學習愛好者：（spring mybatis多半據源實例詳解）文章只能為提供參考，不一定能成為您想要的結果。以下是spring mybatis多半據源實例詳解正文

統一個項目有時會觸及到多個數據庫，也就是多半據源。多半據源又可以分為兩種情形：

1）兩個或多個數據庫沒有相干性，各自自力，其實這類可以作為兩個項目來開辟。好比在游戲開辟中一個數據庫是平台數據庫，其它還有平台下的游戲對應的數據庫；

2）兩個或多個數據庫是master-slave的關系，好比有mysql搭建一個 master-master，厥後又帶有多個slave；或許采取MHA搭建的master-slave復制；

今朝我所曉得的 Spring 多半據源的搭建年夜概有兩種方法，可以依據多半據源的情形停止選擇。

1. 采取spring設置裝備擺設文件直接設置裝備擺設多個數據源

好比針對兩個數據庫沒有相干性的情形，可以采取直接在spring的設置裝備擺設文件中設置裝備擺設多個數據源，然後分離停止事務的設置裝備擺設，以下所示：

<context:component-scan base-package="net.aazj.service,net.aazj.aop" />
<context:component-scan base-package="net.aazj.aop" />
<!-- 引入屬性文件 -->
<context:property-placeholder location="classpath:config/db.properties" />
 
<!-- 設置裝備擺設數據源 -->
<bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
  <property name="url" value="${jdbc_url}" />
  <property name="username" value="${jdbc_username}" />
  <property name="password" value="${jdbc_password}" />
  <!-- 初始化銜接年夜小 -->
  <property name="initialSize" value="0" />
  <!-- 銜接池最年夜應用銜接數目 -->
  <property name="maxActive" value="20" />
  <!-- 銜接池最年夜余暇 -->
  <property name="maxIdle" value="20" />
  <!-- 銜接池最小余暇 -->
  <property name="minIdle" value="0" />
  <!-- 獲得銜接最年夜期待時光 -->
  <property name="maxWait" value="60000" />
</bean>
 
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
 <property name="dataSource" ref="dataSource" />
 <property name="configLocation" value="classpath:config/mybatis-config.xml" />
 <property name="mapperLocations" value="classpath*:config/mappers/**/*.xml" />
</bean>
 
<!-- Transaction manager for a single JDBC DataSource -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource" />
</bean>
 
<!-- 應用annotation界說事務 -->
<tx:annotation-driven transaction-manager="transactionManager" /> 
 
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
 <property name="basePackage" value="net.aazj.mapper" />
 <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
</bean>
 
<!-- Enables the use of the @AspectJ style of Spring AOP -->
<aop:aspectj-autoproxy/>

第二個數據源的設置裝備擺設

<bean name="dataSource_2" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
  <property name="url" value="${jdbc_url_2}" />
  <property name="username" value="${jdbc_username_2}" />
  <property name="password" value="${jdbc_password_2}" />
  <!-- 初始化銜接年夜小 -->
  <property name="initialSize" value="0" />
  <!-- 銜接池最年夜應用銜接數目 -->
  <property name="maxActive" value="20" />
  <!-- 銜接池最年夜余暇 -->
  <property name="maxIdle" value="20" />
  <!-- 銜接池最小余暇 -->
  <property name="minIdle" value="0" />
  <!-- 獲得銜接最年夜期待時光 -->
  <property name="maxWait" value="60000" />
</bean>
 
<bean id="sqlSessionFactory_slave" class="org.mybatis.spring.SqlSessionFactoryBean">
 <property name="dataSource" ref="dataSource_2" />
 <property name="configLocation" value="classpath:config/mybatis-config-2.xml" />
 <property name="mapperLocations" value="classpath*:config/mappers2/**/*.xml" />
</bean>
 
<!-- Transaction manager for a single JDBC DataSource -->
<bean id="transactionManager_2" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource_2" />
</bean>
 
<!-- 應用annotation界說事務 -->
<tx:annotation-driven transaction-manager="transactionManager_2" /> 
 
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
 <property name="basePackage" value="net.aazj.mapper2" />
 <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory_2"/>
</bean>

如上所示，我們分離設置裝備擺設了兩個 dataSource，兩個sqlSessionFactory，兩個transactionManager，和症結的處所在於 MapperScannerConfigurer 的設置裝備擺設——應用sqlSessionFactoryBeanName屬性，注入分歧的sqlSessionFactory的稱號，如許的話，就為分歧的數 據庫對應的 mapper 接口注入了對應的 sqlSessionFactory。

須要留意的是，多個數據庫的這類設置裝備擺設是不支撐散布式事務的，也就是統一個事務中，不克不及操作多個數據庫。這類設置裝備擺設方法的長處是很簡略，然則卻不靈 活。關於master-slave類型的多半據源設置裝備擺設而言不太順應，master-slave性的多半據源的設置裝備擺設，須要特殊靈巧，須要依據營業的類型停止 過細的設置裝備擺設。好比關於一些耗時特殊年夜的select語句，我們願望放到slave上履行，而關於update,delete等操作確定是只能在 master上履行的，別的關於一些及時性請求很高的select語句，我們也能夠須要放到master上履行——好比一個場景是我去商城購置一件武器， 購置操作的很定是master，同時購置完成以後，須要從新查詢出我所具有的武器和金幣，那末這個查詢能夠也須要避免master上履行，而不克不及放在 slave上去履行，由於slave上能夠存在延時，我們可不願望玩家發明購置勝利以後，在背包中卻找不到武器的情形湧現。

所以關於master-slave類型的多半據源的設置裝備擺設，須要依據營業來停止靈巧的設置裝備擺設，哪些select可以放到slave上，哪些select不克不及放到slave上。所以下面的那種所數據源的設置裝備擺設就不太順應了。

2. 基於 AbstractRoutingDataSource 和 AOP 的多半據源的設置裝備擺設

根本道理是，我們本身界說一個DataSource類ThreadLocalRountingDataSource，來繼續 AbstractRoutingDataSource，然後在設置裝備擺設文件中向ThreadLocalRountingDataSource注入 master 和 slave 的數據源，然後經由過程 AOP 來靈巧設置裝備擺設，在哪些處所選擇  master 數據源，在哪些處所須要選擇 slave數據源。上面看代碼完成：

1）先界說一個enum來表現分歧的數據源：

package net.aazj.enums;
 
/**
 * 數據源的種別：master/slave
 */
public enum DataSources {
  MASTER, SLAVE
}
 

2）經由過程 TheadLocal 來保留每一個線程選擇哪一個數據源的標記(key)：

package net.aazj.util;
 
import net.aazj.enums.DataSources;
 
public class DataSourceTypeManager {
  private static final ThreadLocal<DataSources> dataSourceTypes = new ThreadLocal<DataSources>(){
    @Override
    protected DataSources initialValue(){
      return DataSources.MASTER;
    }
  };
   
  public static DataSources get(){
    return dataSourceTypes.get();
  }
   
  public static void set(DataSources dataSourceType){
    dataSourceTypes.set(dataSourceType);
  }
   
  public static void reset(){
    dataSourceTypes.set(DataSources.MASTER0);
  }
}
 

3）界說 ThreadLocalRountingDataSource，繼續AbstractRoutingDataSource：

package net.aazj.util;
 
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
 
public class ThreadLocalRountingDataSource extends AbstractRoutingDataSource {
  @Override
  protected Object determineCurrentLookupKey() {
    return DataSourceTypeManager.get();
  }
}

4）在設置裝備擺設文件中向 ThreadLocalRountingDataSource 注入 master 和 slave 的數據源：

<context:component-scan base-package="net.aazj.service,net.aazj.aop" />
<context:component-scan base-package="net.aazj.aop" />
<!-- 引入屬性文件 -->
<context:property-placeholder location="classpath:config/db.properties" />  
<!-- 設置裝備擺設數據源Master -->
<bean name="dataSourceMaster" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
  <property name="url" value="${jdbc_url}" />
  <property name="username" value="${jdbc_username}" />
  <property name="password" value="${jdbc_password}" />
  <!-- 初始化銜接年夜小 -->
  <property name="initialSize" value="0" />
  <!-- 銜接池最年夜應用銜接數目 -->
  <property name="maxActive" value="20" />
  <!-- 銜接池最年夜余暇 -->
  <property name="maxIdle" value="20" />
  <!-- 銜接池最小余暇 -->
  <property name="minIdle" value="0" />
  <!-- 獲得銜接最年夜期待時光 -->
  <property name="maxWait" value="60000" />
</bean>  
<!-- 設置裝備擺設數據源Slave -->
<bean name="dataSourceSlave" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
  <property name="url" value="${jdbc_url_slave}" />
  <property name="username" value="${jdbc_username_slave}" />
  <property name="password" value="${jdbc_password_slave}" />
  <!-- 初始化銜接年夜小 -->
  <property name="initialSize" value="0" />
  <!-- 銜接池最年夜應用銜接數目 -->
  <property name="maxActive" value="20" />
  <!-- 銜接池最年夜余暇 -->
  <property name="maxIdle" value="20" />
  <!-- 銜接池最小余暇 -->
  <property name="minIdle" value="0" />
  <!-- 獲得銜接最年夜期待時光 -->
  <property name="maxWait" value="60000" />
</bean>  
<bean id="dataSource" class="net.aazj.util.ThreadLocalRountingDataSource">
  <property name="defaultTargetDataSource" ref="dataSourceMaster" />
  <property name="targetDataSources">
    <map key-type="net.aazj.enums.DataSources">
      <entry key="MASTER" value-ref="dataSourceMaster"/>
      <entry key="SLAVE" value-ref="dataSourceSlave"/>
      <!-- 這裡還可以加多個dataSource -->
    </map>
  </property>
</bean>  
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
 <property name="dataSource" ref="dataSource" />
 <property name="configLocation" value="classpath:config/mybatis-config.xml" />
 <property name="mapperLocations" value="classpath*:config/mappers/**/*.xml" />
</bean>  
<!-- Transaction manager for a single JDBC DataSource -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource" />
</bean>  
<!-- 應用annotation界說事務 -->
<tx:annotation-driven transaction-manager="transactionManager" /> 
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
 <property name="basePackage" value="net.aazj.mapper" />
 <!-- <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/> -->
</bean>
  

 下面spring的設置裝備擺設文件中，我們針對master數據庫和slave數據庫分離界說了dataSourceMaster和 dataSourceSlave兩個dataSource，然後注入到<bean id="dataSource" class="net.aazj.util.ThreadLocalRountingDataSource"> 中，如許我們的dataSource便可以來依據 key 的分歧來選擇dataSourceMaster和 dataSourceSlave了。

 5）應用Spring AOP 來指定 dataSource 的 key ，從而dataSource會依據key選擇 dataSourceMaster 和 dataSourceSlave：

package net.aazj.aop;
 
import net.aazj.enums.DataSources;
import net.aazj.util.DataSourceTypeManager;
 
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
 
@Aspect  // for aop
@Component // for auto scan
public class DataSourceInterceptor {  
  @Pointcut("execution(public * net.aazj.service..*.getUser(..))")
  public void dataSourceSlave(){};
   
  @Before("dataSourceSlave()")
  public void before(JoinPoint jp) {
    DataSourceTypeManager.set(DataSources.SLAVE);
  }
  // ... ...
}

 這裡我們界說了一個 Aspect 類，我們應用 @Before 來在相符 @Pointcut("execution(public * net.aazj.service..*.getUser(..))") 中的辦法被挪用之前，挪用 DataSourceTypeManager.set(DataSources.SLAVE) 設置了 key 的類型為 DataSources.SLAVE，所以 dataSource 會依據key=DataSources.SLAVE 選擇 dataSourceSlave 這個dataSource。所以該辦法關於的sql語句會在slave數據庫上履行。

我們可以赓續的擴大 DataSourceInterceptor  這個 Aspect，在中停止各類各樣的界說，來為某個service的某個辦法指定適合的數據源對應的dataSource。

如許我們便可以應用 Spring AOP 的壯大功效來，非常靈巧停止設置裝備擺設了。

 6）AbstractRoutingDataSource道理分析

ThreadLocalRountingDataSource   繼續了   AbstractRoutingDataSource，    完成其籠統辦法 protected abstract Object determineCurrentLookupKey(); 從而完成對分歧數據源的路由功效。我們從源碼動手剖析下個中道理：

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean
AbstractRoutingDataSource 完成了 InitializingBean 那末spring在初始化該bean時，會挪用InitializingBean的接口
void afterPropertiesSet() throws Exception; 我們看下AbstractRoutingDataSource是若何完成這個接口的：
 
  @Override
  public void afterPropertiesSet() {
    if (this.targetDataSources == null) {
      throw new IllegalArgumentException("Property 'targetDataSources' is required");
    }
    this.resolvedDataSources = new HashMap<Object, DataSource>(this.targetDataSources.size());
    for (Map.Entry<Object, Object> entry : this.targetDataSources.entrySet()) {
      Object lookupKey = resolveSpecifiedLookupKey(entry.getKey());
      DataSource dataSource = resolveSpecifiedDataSource(entry.getValue());
      this.resolvedDataSources.put(lookupKey, dataSource);
    }
    if (this.defaultTargetDataSource != null) {
      this.resolvedDefaultDataSource = resolveSpecifiedDataSource(this.defaultTargetDataSource);
    }
  }
 

targetDataSources 是我們在xml設置裝備擺設文件中注入的 dataSourceMaster 和 dataSourceSlave. afterPropertiesSet辦法就是應用注入的。

dataSourceMaster 和 dataSourceSlave來結構一個HashMap——resolvedDataSources。便利前面依據 key 從該map 中獲得對應的dataSource。

我們在看下 AbstractDataSource 接口中的 Connection getConnection() throws SQLException; 是若何完成的：

@Override
  public Connection getConnection() throws SQLException {
    return determineTargetDataSource().getConnection();
  }

症結在於 determineTargetDataSource()，依據辦法名便可以看出，應當此處就決議了應用哪一個 dataSource ：

protected DataSource determineTargetDataSource() {
  Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");
  Object lookupKey = determineCurrentLookupKey();
  DataSource dataSource = this.resolvedDataSources.get(lookupKey);
  if (dataSource == null && (this.lenientFallback || lookupKey == null)) {
    dataSource = this.resolvedDefaultDataSource;
  }
  if (dataSource == null) {
    throw new IllegalStateException("Cannot determine target DataSource for lookup key [" + lookupKey + "]");
  }
  return dataSource;
}

 Object lookupKey = determineCurrentLookupKey(); 該辦法是我們完成的，在個中獲得ThreadLocal中保留的 key 值。取得了key以後，在從afterPropertiesSet()中初始化好了的resolvedDataSources這個map中取得key對應的dataSource。而ThreadLocal中保留的 key 值 是經由過程AOP的方法在挪用service中相干辦法之前設置好的。OK，到此弄定！

3. 總結

從本文中我們可以領會到AOP的壯大和靈巧。

以上就是sping，mybatis 多半據源處置的材料整頓，願望能贊助有須要的同伙