SpringMVC 利用AbstractRoutingDataSource实现动态数据源切换

SpringMVC 利用AbstractRoutingDataSource实现动态数据源切换

本文转载至:http://exceptioneye.iteye.com/blog/1698064

Spring动态配置多数据源，即在大型应用中对数据进行切分，并且采用多个数据库实例进行管理，这样可以有效提高系统的水平伸缩性。而这样的方案就会不同于常见的单一数据实例的方案，这就要程序在运行时根据当时的请求及系统状态来动态的决定将数据存储在哪个数据库实例中，以及从哪个数据库提取数据。

Spring对于多数据源，以数据库表为参照，大体上可以分成两大类情况： 
一是，表级上的跨数据库。即，对于不同的数据库却有相同的表（表名和表结构完全相同）。 
二是，非表级上的跨数据库。即，多个数据源不存在相同的表。 
Spring2.x的版本中采用Proxy模式，就是我们在方案中实现一个虚拟的数据源，并且用它来封装数据源选择逻辑，这样就可以有效地将数据源选择逻辑从Client中分离出来。Client提供选择所需的上下文（因为这是Client所知道的），由虚拟的DataSource根据Client提供的上下文来实现数据源的选择。 
具体的实现就是，虚拟的DataSource仅需继承AbstractRoutingDataSource实现determineCurrentLookupKey（）在其中封装数据源的选择逻辑。

一、原理

首先看下AbstractRoutingDataSource类结构，继承了AbstractDataSource

<span>public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean</span>

既然是AbstractDataSource，当然就是javax.sql.DataSource的子类，于是我们自然地回去看它的getConnection方法：

<span>public Connection getConnection() throws SQLException {
        return determineTargetDataSource().getConnection();
    }

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

原来关键就在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()，该方法返回需要使用的DataSource的key值，然后根据这个key从resolvedDataSources这个map里取出对应的DataSource，如果找不到，则用默认的resolvedDefaultDataSource。

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

二、Spring配置多数据源的方式和具体使用过程

建立一个获得和设置上下文环境的类，主要负责改变上下文数据源的名称

public class DynamicDataSourceHolder {

    private static final ThreadLocal<String> contextHolder = new ThreadLocal<String>();

    public static void setDataSourceType(String dataSourceType) {
        contextHolder.set(dataSourceType);
    }  

    public static String getDataSourceType() {
        return contextHolder.get();
    }  

    public static void clearDataSourceType() {
        contextHolder.remove();
    }  

}

建立动态数据源类，注意，这个类必须继承AbstractRoutingDataSource，且实现方法 determineCurrentLookupKey，该方法返回一个Object，一般是返回字符串

public class DynamicDataSource extends AbstractRoutingDataSource {

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

}

编写spring的配置文件配置多个数据源

<!-- 数据源相同的内容 -->

    <bean id="parentDataSource"
        class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClass"
            value="oracle.jdbc.pool.OracleConnectionPoolDataSource" />
        <property name="url" value="jdbc:oracle:thin:@127.0.0.1:1521:orcl" />
        <property name="user" value="isc_v10" />
        <property name="password" value="isc" />
    </bean>

    <!-- 数据源 -->
    <bean id="orclDataSource" parent="parentDataSource">
        <property name="user" value="orcl" />
        <property name="password" value="orcl" />
    </bean>

    <!-- 数据源 -->
    <bean id="iscDataSource" parent="parentDataSource">
        <property name="user" value="isc_v10" />
        <property name="password" value="isc" />
    </bean>

    <!-- 编写spring 配置文件的配置多数源映射关系 -->
    <bean id="dataSource" class="com.wy.config.DynamicDataSource">
        <property name="targetDataSources">
            <map key-type="java.lang.String">
                <entry key="ORCL" value-ref="orclDataSource"></entry>
                <entry key="ISC" value-ref="iscDataSource"></entry>
            </map>
        </property>
        <property name="defaultTargetDataSource" ref="orclDataSource">
        </property>
    </bean>

    <bean id="sessionFactory"
        class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
</bean>

测试

    public void testSave() {
        // hibernate创建实体
        DynamicDataSourceHolder.setDataSourceType(DynamicDataSourceGlobal.ORCL);// 设置为另一个数据源
        com.wy.domain.Test user = new com.wy.domain.Test();

        user.setName("WY");
        user.setAddress("BJ");

        testDao.save(user);// 使用dao保存实体

        DynamicDataSourceHolder.setDataSourceType(DynamicDataSourceGlobal.ISC);// 设置为另一个数据源

        testDao.save(user);// 使用dao保存实体到另一个库中

    }