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 多数据源处理的资料整理，希望能帮助有需要的朋友