Spring(AbstractRoutingDataSource)实现动态数据源切换示例

一、前言

近期一项目A需实现数据同步到另一项目B数据库中，在不改变B项目的情况下，只好选择项目A中切换数据源，直接把数据写入项目B的数据库中。这种需求，在数据同步与定时任务中经常需要。

那么问题来了，该如何解决多数据源问题呢？不光是要配置多个数据源，还得能灵活动态的切换数据源。以spring+hibernate框架项目为例：

单个数据源绑定给sessionFactory，再在Dao层操作，若多个数据源的话，那不是就成了下图：

可见，sessionFactory都写死在了Dao层，若我再添加个数据源的话，则又得添加一个sessionFactory。所以比较好的做法应该是下图：

接下来就为大家讲解下如何用spring来整合这些数据源，同样以spring+hibernate配置为例。

二、实现原理

1、扩展Spring的AbstractRoutingDataSource抽象类（该类充当了DataSource的路由中介, 能有在运行时, 根据某种key值来动态切换到真正的DataSource上。）

从AbstractRoutingDataSource的源码中：

复制代码 代码如下:
public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean

我们可以看到，它继承了AbstractDataSource，而AbstractDataSource不就是javax.sql.DataSource的子类，So我们可以分析下它的getConnection方法：

public Connection getConnection() throws SQLException { 
 return determineTargetDataSource().getConnection(); 
} 
 
public Connection getConnection(String username, String password) throws SQLException { 
  return determineTargetDataSource().getConnection(username, password); 
}

获取连接的方法中，重点是determineTargetDataSource()方法，看源码：

/** 
  * Retrieve the current target DataSource. Determines the 
  * {@link #determineCurrentLookupKey() current lookup key}, performs 
  * a lookup in the {@link #setTargetDataSources targetDataSources} map, 
  * falls back to the specified 
  * {@link #setDefaultTargetDataSource default target DataSource} if necessary. 
  * @see #determineCurrentLookupKey() 
  */ 
 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; 
 }

上面这段源码的重点在于determineCurrentLookupKey()方法，这是AbstractRoutingDataSource类中的一个抽象方法，而它的返回值是你所要用的数据源dataSource的key值，有了这个key值，resolvedDataSource（这是个map,由配置文件中设置好后存入的）就从中取出对应的DataSource，如果找不到，就用配置默认的数据源。

看完源码，应该有点启发了吧，没错！你要扩展AbstractRoutingDataSource类，并重写其中的determineCurrentLookupKey()方法，来实现数据源的切换：

package com.datasource.test.util.database;
 
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
 
/**
 * 获取数据源（依赖于spring）
 * @author linhy
 */
public class DynamicDataSource extends AbstractRoutingDataSource{
 @Override
 protected Object determineCurrentLookupKey() {
  return DataSourceHolder.getDataSource();
 }
}

DataSourceHolder这个类则是我们自己封装的对数据源进行操作的类：

package com.datasource.test.util.database;
 
/**
 * 数据源操作
 * @author linhy
 */
public class DataSourceHolder {
 //线程本地环境
 private static final ThreadLocal<String> dataSources = new ThreadLocal<String>();
 //设置数据源
 public static void setDataSource(String customerType) {
  dataSources.set(customerType);
 }
 //获取数据源
 public static String getDataSource() {
  return (String) dataSources.get();
 }
 //清除数据源
 public static void clearDataSource() {
  dataSources.remove();
 }
 
}

2、有人就要问，那你setDataSource这方法是要在什么时候执行呢？当然是在你需要切换数据源的时候执行啦。手动在代码中调用写死吗？这是多蠢的方法，当然要让它动态咯。所以我们可以应用spring aop来设置，把配置的数据源类型都设置成为注解标签，在service层中需要切换数据源的方法上，写上注解标签，调用相应方法切换数据源咯（就跟你设置事务一样）：

@DataSource(name=DataSource.slave1)
public List getProducts(){

当然，注解标签的用法可能很少人用到，但它可是个好东西哦，大大的帮助了我们开发：

package com.datasource.test.util.database;
 
import java.lang.annotation.*;
 
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
 String name() default DataSource.master;
 
 public static String master = "dataSource1";
 
 public static String slave1 = "dataSource2";
 
 public static String slave2 = "dataSource3";
 
}

三、配置文件

为了精简篇幅，省略了无关本内容主题的配置。

项目中单独分离出application-database.xml，关于数据源配置的文件。

<?xml version="1.0" encoding="UTF-8"?>
<!-- Spring 数据库相关配置 放在这里 -->
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:aop="http://www.springframework.org/schema/aop"
  xmlns:tx="http://www.springframework.org/schema/tx"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
  http://www.springframework.org/schema/beans/spring-beans.xsd
  http://www.springframework.org/schema/aop
  http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
  http://www.springframework.org/schema/tx
  http://www.springframework.org/schema/tx/spring-tx-3.0.xsd">
 
 <bean id = "dataSource1" class = "com.mysql.jdbc.jdbc2.optional.MysqlDataSource"> 
  <property name="url" value="${db1.url}"/>
  <property name = "user" value = "${db1.user}"/>
  <property name = "password" value = "${db1.pwd}"/>
  <property name="autoReconnect" value="true"/>
  <property name="useUnicode" value="true"/>
  <property name="characterEncoding" value="UTF-8"/>
 </bean>
 
 <bean id = "dataSource2" class = "com.mysql.jdbc.jdbc2.optional.MysqlDataSource">
  <property name="url" value="${db2.url}"/>
  <property name = "user" value = "${db2.user}"/>
  <property name = "password" value = "${db2.pwd}"/>
  <property name="autoReconnect" value="true"/>
  <property name="useUnicode" value="true"/>
  <property name="characterEncoding" value="UTF-8"/>
 </bean>
 
 <bean id = "dataSource3" class = "com.mysql.jdbc.jdbc2.optional.MysqlDataSource">
  <property name="url" value="${db3.url}"/>
  <property name = "user" value = "${db3.user}"/>
  <property name = "password" value = "${db3.pwd}"/>
  <property name="autoReconnect" value="true"/>
  <property name="useUnicode" value="true"/>
  <property name="characterEncoding" value="UTF-8"/>
 </bean>
 <!-- 配置多数据源映射关系 -->
 <bean id="dataSource" class="com.datasource.test.util.database.DynamicDataSource">
  <property name="targetDataSources">
   <map key-type="java.lang.String">
  <entry key="dataSource1" value-ref="dataSource1"></entry>
    <entry key="dataSource2" value-ref="dataSource2"></entry>
    <entry key="dataSource3" value-ref="dataSource3"></entry>
   </map>
  </property>
 <!-- 默认目标数据源为你主库数据源 -->
  <property name="defaultTargetDataSource" ref="dataSource1"/>
 </bean>
 
 <bean id="sessionFactoryHibernate" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
  <property name="dataSource" ref="dataSource"/>
  <property name="hibernateProperties">
   <props>
    <prop key="hibernate.dialect">com.datasource.test.util.database.ExtendedMySQLDialect</prop>
    <prop key="hibernate.show_sql">${SHOWSQL}</prop>
    <prop key="hibernate.format_sql">${SHOWSQL}</prop>
    <prop key="query.factory_class">org.hibernate.hql.classic.ClassicQueryTranslatorFactory</prop>
    <prop key="hibernate.connection.provider_class">org.hibernate.connection.C3P0ConnectionProvider</prop>
    <prop key="hibernate.c3p0.max_size">30</prop>
    <prop key="hibernate.c3p0.min_size">5</prop>
    <prop key="hibernate.c3p0.timeout">120</prop>
    <prop key="hibernate.c3p0.idle_test_period">120</prop>
    <prop key="hibernate.c3p0.acquire_increment">2</prop>
    <prop key="hibernate.c3p0.validate">true</prop>
    <prop key="hibernate.c3p0.max_statements">100</prop>
   </props>
  </property>
 </bean>
 
 <bean id="hibernateTemplate" class="org.springframework.orm.hibernate3.HibernateTemplate">
  <property name="sessionFactory" ref="sessionFactoryHibernate"/>
 </bean>
 
 <bean id="dataSourceExchange" class="com.datasource.test.util.database.DataSourceExchange"/>
 
 <bean id="transactionManager" class="org.springframework.orm.hibernate3.HibernateTransactionManager">
  <property name="sessionFactory" ref="sessionFactoryHibernate"/>
 </bean>
 
 <tx:advice id="txAdvice" transaction-manager="transactionManager">
  <tx:attributes>
   <tx:method name="insert*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="add*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="update*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="modify*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="edit*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="del*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="save*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="send*" propagation="NESTED" rollback-for="Exception"/>
   <tx:method name="get*" read-only="true"/>
   <tx:method name="find*" read-only="true"/>
   <tx:method name="query*" read-only="true"/>
   <tx:method name="search*" read-only="true"/>
   <tx:method name="select*" read-only="true"/>
   <tx:method name="count*" read-only="true"/>
  </tx:attributes>
 </tx:advice>
 
 <aop:config>
  <aop:pointcut id="service" expression="execution(* com.datasource..*.service.*.*(..))"/>
  <!-- 关键配置，切换数据源一定要比持久层代码更先执行（事务也算持久层代码） -->
  <aop:advisor advice-ref="txAdvice" pointcut-ref="service" order="2"/>
  <aop:advisor advice-ref="dataSourceExchange" pointcut-ref="service" order="1"/>
 </aop:config>
 
</beans>

四、疑问

多数据源切换是成功了，但牵涉到事务呢？单数据源事务是ok的，但如果多数据源需要同时使用一个事务呢？这个问题有点头大，网络上有人提出用atomikos开源项目实现JTA分布式事务处理。你怎么看？

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

# spring动态切换数据源  # spring  # 多数据源切换  # 动态数据源  # Spring AbstractRoutingDatasource 动态数据源的实例讲解  # 浅谈利用Spring的AbstractRoutingDataSource解决多数据源的问题  # 详解利用Spring的AbstractRoutingDataSource解决多数据源的问题  # 使用Spring的AbstractRoutingDataSource实现多数据源切换示例  # ​​​​​​​Spring多租户数据源管理 AbstractRoutingDataSour  # 这是  # 多个  # 我们可以  # 为例  # 数据库中  # 配置文件  # 是个  # 数据同步  # 是在  # 来了  # 放在  # 你要  # 子类  # 什么时候  # 则是  # 找不到  # 为你  # 这个问题  # 要在  # 这段 

相关文章： 在线制作视频网站免费,都有哪些好的动漫网站？  微网站制作教程,我微信里的网站怎么才能复制到浏览器里？  合肥做个网站多少钱,合肥本地有没有比较靠谱的交友平台？  css网站制作参考文献有哪些,易聊怎么注册？  建站之星导航菜单设置与功能模块配置全攻略  如何通过.red域名打造高辨识度品牌网站？  微信小程序 五星评分(包括半颗星评分)实例代码  制作营销网站公司,淘特是干什么用的？  建站主机是否等同于虚拟主机？  制作销售网站教学视频,销售网站有哪些？  建站之星备案流程有哪些注意事项？  如何设计高效校园网站？  建站之星在线版空间：自助建站+智能模板一键生成方案  网站制作大概多少钱一个,做一个平台网站大概多少钱？  网页设计网站制作软件,microsoft office哪个可以创建网页？  广州营销型建站服务商推荐：技术优势与SEO优化解析  如何通过虚拟主机快速完成网站搭建？  电影网站制作价格表,那些提供免费电影的网站，他们是怎么盈利的？  如何高效搭建专业期货交易平台网站？  太平洋网站制作公司,网络用语太平洋是什么意思？  php8.4新语法match怎么用_php8.4match表达式替代switch【方法】  上海制作企业网站有哪些,上海有哪些网站可以让企业免费发布招聘信息？  如何在Windows服务器上快速搭建网站？  建站之星导航配置指南：自助建站与SEO优化全解析  SAX解析器是什么，它与DOM在处理大型XML文件时有何不同？  微信网站制作公司有哪些,民生银行办理公司开户怎么在微信网页上查询进度？  如何在阿里云ECS服务器部署织梦CMS网站？  网站制作大概要多少钱一个,做一个平台网站大概多少钱？  如何在Mac上搭建Golang开发环境_使用Homebrew安装和管理Go版本  正规网站制作公司有哪些,目前国内哪家网页网站制作设计公司比较专业靠谱？口碑好？  开源网站制作软件,开源网站什么意思？  网站图片在线制作软件,怎么在图片上做链接？  如何通过虚拟机搭建网站？详细步骤解析  盘锦网站制作公司,盘锦大洼有多少5G网站？  如何在西部数码注册域名并快速搭建网站？  枣阳网站制作,阳新火车站打的到仙岛湖多少钱？  如何在万网主机上快速搭建网站？  如何制作新型网站程序文件,新型止水鱼鳞网要拆除吗？  如何快速搭建高效WAP手机网站吸引移动用户？  ,如何利用word制作宣传手册？  mc皮肤壁纸制作器,苹果平板怎么设置自己想要的壁纸我的世界？  如何用IIS7快速搭建并优化网站站点？  南宁网站建设制作定制,南宁网站建设可以定制吗？  婚礼视频制作网站,学习*后期制作的网站有哪些？  整人网站在线制作软件,整蛊网站退不出去必须要打我是白痴才能出去？  深圳网站制作设计招聘,关于服装设计的流行趋势，哪里的资料比较全面？  建站之星免费版是否永久可用？  做企业网站制作流程,企业网站制作基本流程有哪些？  如何用PHP工具快速搭建高效网站？  常州自助建站费用包含哪些项目？