【原】通過AOP實現MyBatis多數據源的動態切換

【環境參數】
1、開發框架：Spring + SpringMVC + MyBatis

2、數據庫A的URL：jdbc.url=jdbc:mysql://172.16.17.164:3306/ test?characterEncoding=UTF-8&useUnicode=TRUE&autoReconnect=true&failOverReadOnly=false

3、數據庫B的URL：bakdb.jdbc.url=jdbc:mysql://172.16.17.68:3306/bakDB?characterEncoding=UTF-8&useUnicode=TRUE&autoReconnect=true&failOverReadOnly=false

【需求描述】
（1）當用戶調用X方法“之前”，系統會首先切換當前數據源為A數據源（bakDb數據庫），之后再去調用方法X。
（2）當用戶調用Y方法“之前”，系統會首先切換當前的數據源為B數據源（testDb數據庫），之后再去調用方法Y。

（3）X方法和Y方法所在的包名

    X方法：該方法位於com.zjrodger.bakdata.service包下其子包下。

    Y方法：該方法位於com.zjrodger.datatobank.service或者com.zjrodger.zxtobank.service包及其子包下。

 

【具體步驟】
1、編寫動態數據源相關代碼。
(1) 編寫DynamicDataSource類。
DynamicDataSource的主要作用是以Map<Object, Object>的形式，來存儲多個數據源。
因為該類繼承了父類AbstractRoutingDataSource，在父類中，多數據源的實例是被存放在一個名為“targetDataSource”的Map類型的成員變量中。

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;

public class DynamicDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return DatabaseContextHolder.getDbType();
    }
}

(2) 編寫DatabaseContextHolder類。

public class DatabaseContextHolder {

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

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

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

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

 

2、編寫切換數據源的攔截器。

public class DataSourceInterceptor {
    
    /** 數據源切換常量 */
    public static final String DATASOURCE_TEST_DB="dataSourceKey4TestDb";
    public static final String DATASOURCE_BAK_DB="dataSourceKey4BakDb";

    /**
     * 設置數據源為test數據庫所對應的數據源。
     * @param jp
     */
    public void setdataSourceTestDb(JoinPoint jp) {
        DatabaseContextHolder.setDbType(DATASOURCE_TEST_DB);
    }
    
    /**
     * 設置數據源為bak數據庫所對應的數據源。
     * @param jp
     */
    public void setdataSourceBakDb(JoinPoint jp) {
        DatabaseContextHolder.setDbType(DATASOURCE_BAK_DB);
    }
}

 

3、在Spring配置文件中進行相關配置。
(1)配置兩個數據源
A.第一個數據源：

<bean id="c3p0DataSource4BakDb" class="com.mchange.v2.c3p0.ComboPooledDataSource"
    destroy-method="close" depends-on="propertyConfigurer">
    <property name="driverClass" value="${bakdb.jdbc.driverclass}" />
    <property name="jdbcUrl" value="${bakdb.jdbc.url}" />
    <property name="user" value="${bakdb.jdbc.username}" />
    <property name="password" value="${bakdb.jdbc.password}" />

    <!-- 初始化時獲取的連接數，取值應在minPoolSize與maxPoolSize之間。Default: 3 -->
    <property name="initialPoolSize" value="10" />
    <!-- 連接池中保留的最小連接數。 -->
    <property name="minPoolSize" value="5" />
    <!-- 連接池中保留的最大連接數。Default: 15 -->
    <property name="maxPoolSize" value="100" />
    <!-- 當連接池中的連接耗盡的時候c3p0一次同時獲取的連接數。Default: 3 -->
    <property name="acquireIncrement" value="5" />
    <!-- 最大空閑時間，10秒內未使用則連接被丟棄。若為0則永不丟棄。Default: 0 -->
    <property name="maxIdleTime" value="10" />
    <!-- JDBC的標准參數，用以控制數據源內加載的PreparedStatements數量。但由於預緩存的statements 屬於單個connection而不是整個連接池。所以設置這個參數需要考慮到多方面的因素。 
        如果maxStatements與maxStatementsPerConnection均為0，則緩存被關閉。Default: 0 -->
    <property name="maxStatements" value="0" />
    <!-- 連接池用完時客戶調用getConnection()后等待獲取連接的時間，單位：毫秒。超時后會拋出 SQLEXCEPTION，如果設置0，則無限等待。Default:0 -->
    <property name="checkoutTimeout" value="30000" />
</bean>

B.第二個數據源：

<bean id="c3p0DataSource4TestDb" class="com.mchange.v2.c3p0.ComboPooledDataSource"
    destroy-method="close" depends-on="propertyConfigurer">
    <property name="driverClass" value="${jdbc.driverclass}" />
    <property name="jdbcUrl" value="${jdbc.url}" />
    <property name="user" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />

    <!-- 初始化時獲取的連接數，取值應在minPoolSize與maxPoolSize之間。Default: 3 -->
    <property name="initialPoolSize" value="10" />
    <!-- 連接池中保留的最小連接數。 -->
    <property name="minPoolSize" value="5" />
    <!-- 連接池中保留的最大連接數。Default: 15 -->
    <property name="maxPoolSize" value="100" />
    <!-- 當連接池中的連接耗盡的時候c3p0一次同時獲取的連接數。Default: 3 -->
    <property name="acquireIncrement" value="5" />
    <!-- 最大空閑時間，10秒內未使用則連接被丟棄。若為0則永不丟棄。Default: 0 -->
    <property name="maxIdleTime" value="10" />
    <!-- JDBC的標准參數，用以控制數據源內加載的PreparedStatements數量。但由於預緩存的statements 屬於單個connection而不是整個連接池。所以設置這個參數需要考慮到多方面的因素。 
        如果maxStatements與maxStatementsPerConnection均為0，則緩存被關閉。Default: 0 -->
    <property name="maxStatements" value="0" />
    <!-- 連接池用完時客戶調用getConnection()后等待獲取連接的時間，單位：毫秒。超時后會拋出 SQLEXCEPTION，如果設置0，則無限等待。Default:0 -->
    <property name="checkoutTimeout" value="30000" />
</bean>

(2)兩個數據源所對應的properties屬性文件

# =========== Test數據庫相關信息 ============
jdbc.url=jdbc:mysql://172.16.17.164:3306/ test?characterEncoding=UTF-8&useUnicode=TRUE&autoReconnect=true&failOverReadOnly=false
jdbc.username=root
jdbc.password=123456
jdbc.driverclass=com.mysql.jdbc.Driver
jdbc.ip=172.16.5.64
jdbc.dbname=test


# =========== BakDB數據庫相關信息 ============
bakdb.jdbc.url=jdbc:mysql://172.16.17.68:3306/bakDB?characterEncoding=UTF-8&useUnicode=TRUE&autoReconnect=true&failOverReadOnly=false
bakdb.jdbc.username=root
bakdb.jdbc.password=123456
bakdb.jdbc.driverclass=com.mysql.jdbc.Driver
bakdb.jdbc.ip=172.16.17.68
bakdb.jdbc.dbname=bakDB

(3)配置DynamicDataSource這個Bean（關鍵）。
該DynamicDataSource的主要作用是以Map<Object, Object>的形式，來存儲多個數據源。

<!-- 配置可以存儲多個數據源的Bean -->
<bean id="dataSource" class="com.beebank.pub.datasource.DynamicDataSource">
    <property name="targetDataSources">
        <map key-type="java.lang.String">
            <entry key="dataSourceKey4TestDb" value-ref="c3p0DataSource4TestDb" />
            <entry key="dataSourceKey4BakDb" value-ref="c3p0DataSource4BakDb" />
        </map>
    </property>
    <property name="defaultTargetDataSource" ref="c3p0DataSource4HuihangDb" />
</bean>        

(4)配置DataSourceInterceptor這個Bean（關鍵）。

<!-- 配置切換數據源Key的攔截器 -->
<bean id="dataSourceInterceptor" class="com.zjrodger.pub.datasource.DataSourceInterceptor"></bean>

(5)利用AOP，配置控制數據源在特定條件下切換的切面（關鍵，重要）。

注意要添加aop名字空間。

<!-- 1.配置Spring框架自身提供的切面類 -->
<tx:advice id="userTxAdvice" transaction-manager="transactionManager">
    <tx:attributes>
        <tx:method name="delete*" propagation="REQUIRED" read-only="false"
            rollback-for="java.lang.Exception" no-rollback-for="java.lang.RuntimeException" />
        <tx:method name="insert*" propagation="REQUIRED" read-only="false"
            rollback-for="java.lang.Exception" />
        <tx:method name="update*" propagation="REQUIRED" read-only="false"
            rollback-for="java.lang.Exception" />
        <tx:method name="find*" propagation="SUPPORTS" />
        <tx:method name="get*" propagation="SUPPORTS" />
        <tx:method name="select*" propagation="SUPPORTS" />
    </tx:attributes>
</tx:advice>

<!-- 2.配置用戶自定義的切面，用於切換數據源Key -->
<bean id="dataSourceInterceptor" class="com.zjrodger.pub.datasource.DataSourceInterceptor"></bean>    

<!-- 3.（重要）配置Spring事務切面和自定義切面類，動態切換數據源，注意兩切面的執行順序 -->
<aop:config>                    
    <!-- (1) Spring框架自身提供的切面 -->
    <aop:advisor advice-ref="userTxAdvice" pointcut="execution(public * com.zjrodger.*.service..*.*(..))" order="2"/>                                    
     
    <!-- (2) 用戶自定義的切面，根據切入點，動態切換數據源。 -->        
    <aop:aspect id="dataSourceAspect" ref="dataSourceInterceptor" order="1">                                        
        <aop:before method="setdataSourceBakDb"  pointcut="execution(* com.zjrodger.bakdata.service..*.*(..))"/>                        
        <aop:before method="setdataSourceTestDb"  pointcut="execution(* com.zjrodger.datatobank.service..*.*(..))"/>
    </aop:aspect>        
</aop:config>

注意：

    A.注意上述兩個切面中的order屬性的配置。

    B.自定義切面類和Spring自帶事務切面類（即<aop:advisor>元素）的執行的先后順序要配置正確，否則就會導致導致數據源不能動態切換。

在AOP中，當執行同一個切入點時，不同切面的執行先后順序是由“每個切面的order屬性”而定的，order越小，則該該切面中的通知越先被執行。

上述<aop:config>元素中，引用了兩個切面類：“userTxAdvice類”和“dataSourceAspect類”，其中<aop:advisor>是Spring框架自定義的切面標簽。
根據兩個切面類order屬性的定義，當程序執行時並且觸發切入點后（即調用com.zjrodger.bakdata.service包及其子包下的方法），dataSourceAspect切面類中的setdatasourceBakDb()方通知法首先執行，之后才會執行userTxAdvice事務類中的相關通知方。

 說明

切面類“DataSourceInterceptor”中有兩個方法：setdataSourceTestDb()方法和setdataSourceBakDb()。
1）當用戶調用“com.zjrodger.bakdata.service”包及其子包下的方法X“之前”，系統會首先去調用setdataSourceBakDb()方法，設置當前數據源為bakDb的數據源，之后再去調用方法X。
2）當用戶調用“com.zjrodger.datatobank.service”或者“com.zjrodger.zxtobank.service”包及其子包下的方法Y之前，系統會首先去調調用setdataSourceTestDb()方法，設置當前的數據源為testDb數據庫的數據源，之后再去調用方法Y。

(6)完整的Spring配置文檔

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
    xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
    xmlns:p="http://www.springframework.org/schema/p" xmlns:mvc="http://www.springframework.org/schema/mvc"
    xmlns:task="http://www.springframework.org/schema/task"
    xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task.xsd
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">

    <!-- 該配置為自動掃描配置的包下所有使用@Controller注解的類 -->
    <context:component-scan base-package="com.zjrodger" />

    <bean id="propertyConfigurer"
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location">
            <value>classpath:properties/dbconfig.properties</value>
        </property>
        <property name="fileEncoding" value="utf-8" />
    </bean>
    
    <!-- 備份庫數據庫數據源  -->
    <bean id="c3p0DataSource4BakDb" class="com.mchange.v2.c3p0.ComboPooledDataSource"
        destroy-method="close" depends-on="propertyConfigurer">
        <property name="driverClass" value="${bakdb.jdbc.driverclass}" />
        <property name="jdbcUrl" value="${bakdb.jdbc.url}" />
        <property name="user" value="${bakdb.jdbc.username}" />
        <property name="password" value="${bakdb.jdbc.password}" />

        <!-- 初始化時獲取的連接數，取值應在minPoolSize與maxPoolSize之間。Default: 3 -->
        <property name="initialPoolSize" value="10" />
        <!-- 連接池中保留的最小連接數。 -->
        <property name="minPoolSize" value="5" />
        <!-- 連接池中保留的最大連接數。Default: 15 -->
        <property name="maxPoolSize" value="100" />
        <!-- 當連接池中的連接耗盡的時候c3p0一次同時獲取的連接數。Default: 3 -->
        <property name="acquireIncrement" value="5" />
        <!-- 最大空閑時間，10秒內未使用則連接被丟棄。若為0則永不丟棄。Default: 0 -->
        <property name="maxIdleTime" value="10" />
        <!-- JDBC的標准參數，用以控制數據源內加載的PreparedStatements數量。但由於預緩存的statements 屬於單個connection而不是整個連接池。所以設置這個參數需要考慮到多方面的因素。 
            如果maxStatements與maxStatementsPerConnection均為0，則緩存被關閉。Default: 0 -->
        <property name="maxStatements" value="0" />
        <!-- 連接池用完時客戶調用getConnection()后等待獲取連接的時間，單位：毫秒。超時后會拋出 SQLEXCEPTION，如果設置0，則無限等待。Default:0 -->
        <property name="checkoutTimeout" value="30000" />
    </bean>
    

    <!--Test數據庫數據源 -->
    <bean id="c3p0DataSource4TestDb" class="com.mchange.v2.c3p0.ComboPooledDataSource"
        destroy-method="close" depends-on="propertyConfigurer">
        <property name="driverClass" value="${jdbc.driverclass}" />
        <property name="jdbcUrl" value="${jdbc.url}" />
        <property name="user" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />

        <!-- 初始化時獲取的連接數，取值應在minPoolSize與maxPoolSize之間。Default: 3 -->
        <property name="initialPoolSize" value="10" />
        <!-- 連接池中保留的最小連接數。 -->
        <property name="minPoolSize" value="5" />
        <!-- 連接池中保留的最大連接數。Default: 15 -->
        <property name="maxPoolSize" value="100" />
        <!-- 當連接池中的連接耗盡的時候c3p0一次同時獲取的連接數。Default: 3 -->
        <property name="acquireIncrement" value="5" />
        <!-- 最大空閑時間，10秒內未使用則連接被丟棄。若為0則永不丟棄。Default: 0 -->
        <property name="maxIdleTime" value="10" />
        <!-- JDBC的標准參數，用以控制數據源內加載的PreparedStatements數量。但由於預緩存的statements 屬於單個connection而不是整個連接池。所以設置這個參數需要考慮到多方面的因素。 
            如果maxStatements與maxStatementsPerConnection均為0，則緩存被關閉。Default: 0 -->
        <property name="maxStatements" value="0" />
        <!-- 連接池用完時客戶調用getConnection()后等待獲取連接的時間，單位：毫秒。超時后會拋出 SQLEXCEPTION，如果設置0，則無限等待。Default:0 -->
        <property name="checkoutTimeout" value="30000" />
    </bean>
    
    <!-- 配置可以存儲多個數據源的Bean -->
    <bean id="dataSource" class="com.zjrodger.pub.datasource.DynamicDataSource">
        <property name="targetDataSources">
            <map key-type="java.lang.String">
                <entry key="dataSourceKey4TestDb" value-ref="c3p0DataSource4TestDb" />
                <entry key="dataSourceKey4BakDb" value-ref="c3p0DataSource4BakDb" />
            </map>
        </property>
        <property name="defaultTargetDataSource" ref="c3p0DataSource4TestDb" />
    </bean>        

    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- <property name="dataSource" ref="c3p0DataSource" /> -->
        <property name="dataSource" ref="dataSource" />

        <property name="mapperLocations" value="classpath*:com/zjrodger/**/dao/xml/*.xml" />
        <!-- 添加分頁插件 -->
        <property name="plugins">
            <list>
                <bean class="com.github.pagehelper.PageHelper">
                    <property name="properties">
                        <props>
                            <prop key="dialect">mysql</prop>
                            <prop key="offsetAsPageNum">true</prop>
                            <prop key="rowBoundsWithCount">true</prop>
                            <prop key="pageSizeZero">true</prop>
                            <prop key="reasonable">true</prop>
                        </props>
                    </property>
                </bean>
            </list>
        </property>

    </bean>

    <bean id="transactionManager"
        class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <!-- <property name="dataSource" ref="c3p0DataSource" /> -->
        <property name="dataSource" ref="dataSource" />
    </bean>

    <!-- 注解驅動，使spring的controller全部生效 -->
    <mvc:annotation-driven />
    <!-- 注解驅動，是spring的task全部生效 -->
    <task:annotation-driven />


    <aop:aspectj-autoproxy expose-proxy="true" />    
    <tx:annotation-driven transaction-manager="transactionManager"/>        

    <!-- Spring聲明式事務切面 -->
    <tx:advice id="userTxAdvice" transaction-manager="transactionManager">
        <tx:attributes>
            <tx:method name="delete*" propagation="REQUIRED" read-only="false"
                rollback-for="java.lang.Exception" no-rollback-for="java.lang.RuntimeException" />
            <tx:method name="insert*" propagation="REQUIRED" read-only="false"
                rollback-for="java.lang.Exception" />
            <tx:method name="update*" propagation="REQUIRED" read-only="false"
                rollback-for="java.lang.Exception" />
            <tx:method name="find*" propagation="SUPPORTS" />
            <tx:method name="get*" propagation="SUPPORTS" />
            <tx:method name="select*" propagation="SUPPORTS" />
        </tx:attributes>
    </tx:advice>

    <aop:config>                    
        <!-- Spring框架自身提供的切面 -->
        <aop:advisor advice-ref="userTxAdvice" pointcut="execution(public * com.zjrodger.*.service..*.*(..))" order="2"/>                                    
    
        <!-- 用戶自定義的切面，根據切入點，動態切換數據源。 -->        
        <aop:aspect id="dataSourceAspect" ref="dataSourceInterceptor" order="1">                                        
            <aop:before method="setdataSourceBakDb"  pointcut="execution(* com.zjrodger.bakdata.service..*.*(..))"/>                        
            <aop:before method="setdataSourceTestDb"  pointcut="execution(* com.zjrodger.datatobank.service..*.*(..))"/>
            <aop:before method="setdataSourceTestDb"  pointcut="execution(* com.zjrodger.zxtobank.service..*.*(..))"/>                        
        </aop:aspect>        
    </aop:config>
    
    <!-- 配置切換數據源Key的攔截器 -->
    <bean id="dataSourceInterceptor" class="com.zjrodger.pub.datasource.DataSourceInterceptor"></bean>    
    
    <!-- mybatis配置 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.zjrodger.pub.dao,com.zjrodger.zxtobank.dao,com.zjrodger.bakdata.dao" />
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
    </bean>        
</beans>

至此，MyBatis多數據源的配置完畢，之后在自己的環境下進行測試，結果測試通過。

要特別注意自定義AOP切面與Spring自帶的事務切面的執行順序，即注意<aop:config>中的配置部分，否則，很容易會出現動態切換數據源失敗的現象。

 

【同專題博客內連接】

1、Order屬性決定了不同切面類中通知執行的先后順序
http://www.cnblogs.com/zjrodger/p/5633922.html

2、不定義Order屬性，通過切面類的定義順序來決定通知執行的先后順序
http://www.cnblogs.com/zjrodger/p/5633951.html

 

【其他參考連接】

1、《Spring中事務與aop的先后順序問題》http://my.oschina.net/HuifengWang/blog/304188