文档章节

【Spring】使用Spring的AbstractRoutingDataSource实现多数据源切换

weknow
 weknow
发布于 2017/02/19 15:45
字数 1361
阅读 660
收藏 1

最近因为项目需要在做两个项目间数据同步的需求,具体是项目1的数据通过消息队列同步到项目2中,因为这个更新操作还涉及到更新多个库的数据,所以就需要多数据源切换的操作。下面就讲讲在Spring中如何进行数据源切换。这里是使用AbstractRoutingDataSource类来完成具体的操作,AbstractRoutingDataSource是Spring2.0后增加的。

实现数据源切换的功能就是自定义一个类扩展AbstractRoutingDataSource抽象类,其实该相当于数据源DataSourcer的路由中介,可以实现在项目运行时根据相应key值切换到对应的数据源DataSource上。先看看AbstractRoutingDataSource的源码:

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean {
    /* 只列出部分代码 */
    private Map<Object, Object> targetDataSources;

    private Object defaultTargetDataSource;

    private boolean lenientFallback = true;

    private DataSourceLookup dataSourceLookup = new JndiDataSourceLookup();

    private Map<Object, DataSource> resolvedDataSources;

    private DataSource resolvedDefaultDataSource;

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

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

    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;
    }

    protected abstract Object determineCurrentLookupKey();
}

从源码可以看出AbstractRoutingDataSource继承了AbstractDataSource并实现了InitializingBean,AbstractRoutingDataSource的getConnection()方法调用了determineTargetDataSource()的该方法,这里重点看determineTargetDataSource()方法代码,方法里使用到了determineCurrentLookupKey()方法,它是AbstractRoutingDataSource类的抽象方法,也是实现数据源切换要扩展的方法,该方法的返回值就是项目中所要用的DataSource的key值,拿到该key后就可以在resolvedDataSource中取出对应的DataSource,如果key找不到对应的DataSource就使用默认的数据源。

自定义类扩展AbstractRoutingDataSource类时就是要重写determineCurrentLookupKey()方法来实现数据源切换功能。下面是自定义的扩展AbstractRoutingDataSource类的实现:

/**
 * 获得数据源
 */
public class MultipleDataSource extends AbstractRoutingDataSource{

    @Override
    protected Object determineCurrentLookupKey() {
         return DynamicDataSourceHolder.getRouteKey();
    }
}

DynamicDataSourceHolder类如下,实现对数据源的操作功能:

/**
 * 数据源操作类
 */
public class DynamicDataSourceHolder {
    private static ThreadLocal<String> routeKey = new ThreadLocal<String>();

    /**
     * 获取当前线程的数据源路由的key
     */
    public static String getRouteKey()
    {
        String key = routeKey.get();
        return key;
    }

    /**
     * 绑定当前线程数据源路由的key
     * 使用完成后必须调用removeRouteKey()方法删除
     */
    public static void  setRouteKey(String key)
    {
        routeKey.set(key);
    }

    /**
     * 删除与当前线程绑定的数据源路由的key
     */
    public static void removeRouteKey()
    {
        routeKey.remove();
    }
}

下面在xml文件中配置多个数据源:

<!-- 数据源 -->
<bean id="dataSource1" class="org.apache.commons.dbcp.BasicDataSource">
     <property name="driverClassName" value="net.sourceforge.jtds.jdbc.Driver">
     </property>
     <property name="url" value="jdbc:jtds:sqlserver://127.0.0.1;databaseName=test">
     </property>
     <property name="username" value="***"></property>
     <property name="password" value="***"></property>
 </bean>
 <bean id="dataSource2" class="org.apache.commons.dbcp.BasicDataSource">
     <property name="driverClassName" value="net.sourceforge.jtds.jdbc.Driver">
     </property>
     <property name="url" value="jdbc:jtds:sqlserver://127.0.0.2:1433;databaseName=test">
     </property>
     <property name="username" value="***"></property>
     <property name="password" value="***"></property>
</bean>

<!-- 配置多数据源映射 -->
<bean id="multipleDataSource" class="MultipleDataSource" >
     <property name="targetDataSources">
         <map key-type="java.lang.String">
             <entry value-ref="dataSource1" key="dataSource1"></entry>
             <entry value-ref="dataSource2" key="dataSource2"></entry>
         </map>
     </property>
     <!-- 默认数据源 -->
     <property name="defaultTargetDataSource" ref="dataSource1" >
     </property>
</bean>

到这里基本的配置就完成了,下面只要在需要切换数据源的地方调用方法就行了,一般是在dao层操作数据库前进行切换的,只需在数据库操作前加上如下代码即可:

DynamicDataSourceHolder.setRouteKey("dataSource2");

上面介绍的是在dao层当需要切换数据源时手动加上切换数据源的代码,也可以使用AOP的方式,把配置的数据源类型都设置成注解标签,在dao层中需要切换数据源操作的方法或类上写上注解标签,这样实现起来可操作性也更强。

@DataSourceKey("dataSource1")
public interface TestEntityMapper extends MSSQLMapper<TestEntity> {
    public void insertTest(TestEntity testEntity);
}

DataSourceKey注解代码如下:

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSourceKey {
    String value() default "";
}

注解配置完后就要写一个实现数据源切换的类,如下:

public class MultipleDataSourceExchange {

    /** 
     * 拦截目标方法,获取由@DataSource指定的数据源标识,设置到线程存储中以便切换数据源 
     */  
    public void beforeDaoMethod(JoinPoint point) throws Exception {  
        Class<?> target = point.getTarget().getClass();  
        MethodSignature signature = (MethodSignature) point.getSignature();  
        // 默认使用目标类型的注解,如果没有则使用其实现接口的注解类  
        for (Class<?> cls : target.getInterfaces()) {  
            resetDataSource(cls, signature.getMethod());  
        }  
        resetDataSource(target, signature.getMethod());  
    }  


    /** 
     * 提取目标对象方法注解和类注解中的数据源标识 
     */  
    private void resetDataSource(Class<?> cls, Method method) {  
        try {  
            Class<?>[] types = method.getParameterTypes();  
            // 默认使用类注解  
            if (cls.isAnnotationPresent(DataSourceKey.class)) {  
                DataSourceKey source = cls.getAnnotation(DataSourceKey.class);  
                DynamicDataSourceHolder.setRouteKey(source.value());  
            }  
            // 方法注解可以覆盖类注解  
            Method m = cls.getMethod(method.getName(), types);  
            if (m != null && m.isAnnotationPresent(DataSourceKey.class)) {  
                DataSourceKey source = m.getAnnotation(DataSourceKey.class);   
                DynamicDataSourceHolder.setRouteKey(source.value());  
            }  
        } catch (Exception e) {  
            System.out.println(cls + ":" + e.getMessage());  
        }  
    }  
}

代码写完后就要在xml配置文件上添加配置了(只列出部分配置):

<bean id="multipleDataSourceExchange" class="MultipleDataSourceExchange "/>

<bean id="txManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="multipleDataSource" />
</bean>

<tx:advice id="txAdvice" transaction-manager="txManager">
    <tx:attributes>
       <tx:method name="insert*" propagation="NESTED" rollback-for="Exception"/>
       <tx:method name="add*" propagation="NESTED" rollback-for="Exception"/>
       ...
    </tx:attributes>
</tx:advice>

<aop:config>
    <aop:pointcut id="service" expression="execution(* com.datasource..*.service.*.*(..))"/>
    <!-- 注意切换数据源操作要比持久层代码先执行 -->
    <aop:advisor advice-ref="multipleDataSourceExchange" pointcut-ref="service" order="1"/>
    <aop:advisor advice-ref="txAdvice" pointcut-ref="service" order="2"/>
</aop:config>

到此就完成使用AOP的方式实现多数据源的动态切换了。

 

 

© 著作权归作者所有

weknow
粉丝 62
博文 140
码字总数 66678
作品 0
广州
高级程序员
私信 提问
加载中

评论(9)

覃勇铖
覃勇铖
MultipleDataSourceExchange 不用实现advice相关接口吗
美丽不打折
美丽不打折
你多个数据源事务怎么控制?
S
Sudos

引用来自“Sudos”的评论

这样在代码里硬编码实现不是一个好的解决办法, 参考一下下面这种做法吧,

使用mycat或者sharding-jdbc这种思想, 就不用关心什么时候要手动切换数据库的问题了, 如果说错了,别打我😆

引用来自“weknow”的评论

说得对,使用mycat或者sharding-jdbc当然方便,我上面写的相当比较原生的实现啦。。
😆
weknow
weknow 博主

引用来自“Sudos”的评论

这样在代码里硬编码实现不是一个好的解决办法, 参考一下下面这种做法吧,

使用mycat或者sharding-jdbc这种思想, 就不用关心什么时候要手动切换数据库的问题了, 如果说错了,别打我😆
说得对,使用mycat或者sharding-jdbc当然方便,我上面写的相当比较原生的实现啦。。
S
Sudos
这样在代码里硬编码实现不是一个好的解决办法, 参考一下下面这种做法吧,

使用mycat或者sharding-jdbc这种思想, 就不用关心什么时候要手动切换数据库的问题了, 如果说错了,别打我😆
weknow
weknow 博主

引用来自“lgl48128244”的评论

没看懂,aop也没告诉怎么配置?
亲,aop配置都在上面哦,看多几遍就懂了
weknow
weknow 博主

引用来自“the_feel”的评论

这个基于AOP注解 好像只能放在 service层上, dao层不适用
你好,dao层也是可以的,这里的Mapper其实就是我的dao层。当然具体业务还要根据场景来,但思路都是一样的。
the_feel
the_feel
这个基于AOP注解 好像只能放在 service层上, dao层不适用
lgl48128244
lgl48128244
没看懂,aop也没告诉怎么配置?
Spring+MyBatis多数据源配置实现

jdbc和log4j的配置 #定义输出格式ConversionPattern=%d %-5p [%t] %c - %m%n log4j.rootLogger=DEBUG,Consolelog4j.logger.com.cnblogs.lzrabbit=DEBUGlog4j.logger.org.springframework=ER......

引鸩怼孑
2015/06/17
305
3
Spring Boot 2 AOP方式实现多数据源切换

支持的数据源类型为druid和spring boot 2的默认数据源hikariCP ,如果需要支持其他类型数据源可自行添加。 实现思路为通过解析数据源配置文件创建数据源,然后使用Spring提供的AbstractRouti...

325G
06/20
129
1
spring+mybitas 实现多数据源动态切换

1 由于项目需要,需要将不同来源的数据存入不同的数据库,所以需要根据入参的信息动态切换数据源 项目core层采用了spring+mybitas 方式进行架构 1 在spring的配置中定义两个数据源 2创建一个...

black_c
2018/05/15
0
0
基于spring和ibatis的多数据源切换方案

基本介绍 在仅使用ibatis时,多数据源简直就是梦魇,每多一个数据源就需要多一份sql-map-config配置文件。 采用spring的AbstractRoutingDataSource就可以简单的解决这个问题。 AbstractRout...

Gmupload
2013/10/11
1K
1
怎样使用spring3.1多数据源分库查询?

使用AbstractRoutingDataSource抽象类能够自定义路由数据源策略,这我知道,但是spring什么时候确定的数据源?有很多人说是开启事务的时候,Service中的save方法加上事务之后确实能够在调用方...

狂盗一枝梅
2015/12/23
122
0

没有更多内容

加载失败,请刷新页面

加载更多

Mybatis Plus删除

/** @author beth @data 2019-10-17 00:30 */ @RunWith(SpringRunner.class) @SpringBootTest public class DeleteTest { @Autowired private UserInfoMapper userInfoMapper; /** 根据id删除......

一个yuanbeth
今天
4
0
总结

一、设计模式 简单工厂:一个简单而且比较杂的工厂,可以创建任何对象给你 复杂工厂:先创建一种基础类型的工厂接口,然后各自集成实现这个接口,但是每个工厂都是这个基础类的扩展分类,spr...

BobwithB
今天
4
0
java内存模型

前言 Java作为一种面向对象的,跨平台语言,其对象、内存等一直是比较难的知识点。而且很多概念的名称看起来又那么相似,很多人会傻傻分不清楚。比如本文我们要讨论的JVM内存结构、Java内存模...

ls_cherish
今天
4
0
友元函数强制转换

友元函数强制转换 p522

天王盖地虎626
昨天
5
0
js中实现页面跳转(返回前一页、后一页)

本文转载于:专业的前端网站➸js中实现页面跳转(返回前一页、后一页) 一:JS 重载页面,本地刷新,返回上一页 复制代码代码如下: <a href="javascript:history.go(-1)">返回上一页</a> <a h...

前端老手
昨天
5
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部