利用Spring的AbstractRoutingDataSource解决多数据源的问题

最新推荐文章于 2024-10-12 08:49:44 发布
最新推荐文章于 2024-10-12 08:49:44 发布
阅读量1.4k 收藏
点赞数
分类专栏： javaEE 数据库

一、前言

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

    那么问题来了，该如何解决多数据源问题呢？不光是要配置多个数据源，还得能灵活动态的切换数据源。以spring+hibernate框架项目为例（引用：http://blog.csdn.NET/wangpeng047/article/details/8866239博客的图片）：

    

    单个数据源绑定给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分布式事务处理。你怎么看？

shenjianxz
关注
专栏目录
Spring(AbstractRoutingDataSource)实现动态数据源切换示例
08-31
本篇文章主要介绍了详解Spring(AbstractRoutingDataSource)实现动态数据源切换，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
浅谈利用Spring的AbstractRoutingDataSource解决多数据源的问题
08-29
总结起来，利用Spring的`AbstractRoutingDataSource`解决多数据源问题的关键在于自定义一个继承自`AbstractRoutingDataSource`的类，实现数据源的选择逻辑，以及使用`ThreadLocal`保持线程上下文。配合AOP，可以在...
Spring(AbstractRoutingDataSource)实现动态数据源切换
weixin_34414650的博客
02-28 226
一、前言近期一项目A需实现数据同步到另一项目B数据库中，在不改变B项目的情况下，只好选择项目A中切换数据源，直接把数据写入项目B的数据库中。这种需求，在数据同步与定时任务中经常需要。那么问题来了，该如何解决多数据源问题呢？不光是要配置多个数据源，还得能灵活动态的切换数据源。以spring+hibernate框架项目为例（引用：http://blog.csdn....
重学SpringBoot3-AbstractRoutingDataSource介绍
最新发布
CoderJia的学习之路
10-12 897
在现代的应用开发中，尤其是在 SaaS 多租户架构、读写分离、或者多数据源的场景下，通常需要动态地切换数据源。Spring Boot 3 提供的 `AbstractRoutingDataSource` 类是实现这一功能的核心工具之一。
一种实现Spring动态数据源切换的方法 | 京东云技术团队
JDDTechTalk的博客
06-19 1000
实现不在现有查询代码逻辑上做任何改动，实现dao维度的数据源切换（即表维度）
Spring实现动态数据源切换
热门推荐
程序员的蜕变
09-15 2万+
如下流程是我在实现Spring数据源动态切换到过程中遇到的问题接处理方式。   1、编写数据源切换的类 //此类时用于切换数据源时所调用的类及方法 public class DataSourceContextHolder { public static final String DATA_SOURCE = "dataSource"; public static final String D...
Spring项目中使用两种方法动态切换数据源，多数据源切换
bobozai86的博客
04-07 3068
本文介绍两种动态切换数据库的方法。 方法一：数据源信息配置在xml中，适用于一般数据库切换。执行完某操作，切换数据库，执行另一个操作。 方法二：数据源信息配置在默认数据源中，适用于切换数据库操作同一方法，相当于批量执行方法。 两种方法核心都是AbstractRoutingDataSource，由spring提供，用来动态切换数据源。我们需要继承它，来进行操作。源码分析可以看下一篇文章源码分析 ...
详解利用Spring的AbstractRoutingDataSource解决多数据源的问题
08-31
Spring框架提供了多种方式来处理多数据源问题，其中`AbstractRoutingDataSource`是一个非常实用的解决方案。本文将详细解析如何利用`AbstractRoutingDataSource`来解决多数据源的问题。 `AbstractRoutingDataSource...
使用Spring的AbstractRoutingDataSource实现多数据源切换示例
08-31
`AbstractRoutingDataSource` 是Spring提供的一种动态数据源解决方案，它允许我们在运行时根据特定的规则（通常是业务上下文）选择使用哪个数据源。 `AbstractRoutingDataSource` 类本身是一个抽象类，它扩展了`...
Spring AbstractRoutingDataSource：多数据源切换示例及实现
在Spring框架中，实现多数据源的动态切换是一种常见的需求，尤其是在处理分布式系统或者需要跨项目数据交互的场景下。本文将重点介绍如何利用Spring提供的`AbstractRoutingDataSource`类来实现这一功能。`...
利用Spring的AbstractRoutingDataSource解决多数据源的问题（转）
08-21 207
多数据源问题很常见，例如读写分离数据库配置。 原来的项目出现了新需求，局方要求新增某服务器用以提供某代码，涉及到多数据源的问题。 研究成果如下： 1、首先配置多个datasource [html]view plaincopy <beanid="dataSource"class="org.apache.commons.d...
spring AbstractRoutingDataSource详解
u011463444的专栏
06-02 1万+
spring AbstractRoutingDataSource 详解1. AbstractRoutingDataSource 应用场景我们看AbstractRoutingDataSource类对应的注释：Abstract {@link javax.sql.DataSource} implementation that routes {@link #getConnection()} calls to
动态数据源-spring-AbstractRoutingDataSource
weixin_39937571的博客
11-24 4087
spring的动态数据源AbstractRoutingDataSource本质用的是多态和本地线程栈使用场景：当一个系统中需要多个数据库参与，我公司的业务是每个公司一个数据库，多个公司用同一个域名同一个网站，用的公司名（公司号）登录时。
Spring-AbstractRoutingDataSource
xiaopang2020的博客
10-15 897
注：spring提供了一个多数据源解决方案：AbstractRoutingDataSource。最近项目用到了多数据源。简单教练一下这个类，做个学习笔记。 从继承上看，AbstractRoutingDataSource继承AbstractDataSource。AbstractDataSource实现DataSource接口。那么AbstractRoutingDataSource就是一批DataSource实例的集合体。 操作数据库首先获取Connection。AbstracRoutingDataSour
【多数据源系列】在Sping Cloud（Spring Boot）中基于AbstractRoutingDataSource 实现多数据源动态切换
c18213590220的博客
12-14 1599
在近几年的业务需求中，我碰到了几个需要支持动态数据源切换的需求场景，如数据库读写优化，后台改为读写分离；需要在一个界面中同时支持读取不同数据库的数据（如Postgres和Oracle）。以在一个界面中同时支持读取不同数据库的数据。
基于注解的Spring多数据源配置和使用
dingsutan9712的博客
11-29 387
前一段时间研究了一下spring多数据源的配置和使用，为了后期从多个数据源拉取数据定时进行数据分析和报表统计做准备。由于之前做过的项目都是单数据源的，没有遇到这种场景，所以也一直没有去了解过如何配置多数据源。后来发现其实基于spring来配置和使用多数据源还是比较简单的，因为spring框架已经预留了这样的接口可以方便数据源的切换。先看一下spring获取数据源的源码： 可以看到A...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值