动态数据源切换--AbstractRoutingDataSource

转载自http://blog.csdn.net/x2145637/article/details/52461198

在Spring 2.0.1中引入了AbstractRoutingDataSource, 该类充当了DataSource的路由中介, 能有在运行时, 根据某种key值来动态切换到真正的DataSource上。

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

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

 

一、原理

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

Java代码  

1. public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean

 

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

Java代码  

1. public Connection getConnection() throws SQLException {  
2.         return determineTargetDataSource().getConnection();  
3.     }  
4.   
5.     public Connection getConnection(String username, String password) throws SQLException {  
6.         return determineTargetDataSource().getConnection(username, password);  
7.     }  

 

 原来关键就在determineTargetDataSource()里：

Java代码  

1. /** 
2.      * Retrieve the current target DataSource. Determines the 
3.      * {@link #determineCurrentLookupKey() current lookup key}, performs 
4.      * a lookup in the {@link #setTargetDataSources targetDataSources} map, 
5.      * falls back to the specified 
6.      * {@link #setDefaultTargetDataSource default target DataSource} if necessary. 
7.      * @see #determineCurrentLookupKey() 
8.      */  
9.     protected DataSource determineTargetDataSource() {  
10.         Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");  
11.         Object lookupKey = determineCurrentLookupKey();  
12.         DataSource dataSource = this.resolvedDataSources.get(lookupKey);  
13.         if (dataSource == null && (this.lenientFallback || lookupKey == null)) {  
14.             dataSource = this.resolvedDefaultDataSource;  
15.         }  
16.         if (dataSource == null) {  
17.             throw new IllegalStateException("Cannot determine target DataSource for lookup key [" + lookupKey + "]");  
18.         }  
19.         return dataSource;  
20.     } 

 这里用到了我们需要进行实现的抽象方法determineCurrentLookupKey()，该方法返回需要使用的DataSource的key值，然后根据这个key从resolvedDataSources这个map里取出对应的DataSource，如果找不到，则用默认的resolvedDefaultDataSource。

Java代码  

1.         public void afterPropertiesSet() {  
2.         if (this.targetDataSources == null) {  
3.             throw new IllegalArgumentException("Property 'targetDataSources' is required");  
4.         }  
5.         this.resolvedDataSources = new HashMap<Object, DataSource>(this.targetDataSources.size());  
6.         for (Map.Entry entry : this.targetDataSources.entrySet()) {  
7.             Object lookupKey = resolveSpecifiedLookupKey(entry.getKey());  
8.             DataSource dataSource = resolveSpecifiedDataSource(entry.getValue());  
9.             this.resolvedDataSources.put(lookupKey, dataSource);  
10.         }  
11.         if (this.defaultTargetDataSource != null) {  
12.             this.resolvedDefaultDataSource = resolveSpecifiedDataSource(this.defaultTargetDataSource);  
13.         }  
14.     } 

 

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

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

Java代码  

1. public class DynamicDataSourceHolder {
   
2. // 线程局部变量（多线程并发设计，为了线程安全）
3. private static final ThreadLocal<String> contextHolder = new ThreadLocal();  
4.   
5. // 设置数据源类型  
6. public static void setDataSourceType(String dataSourceType) {  
7.     Assert.notNull(dataSourceType, "DataSourceType cannot be null");  
8.     contextHolder.set(dataSourceType);  
9. }  
10.   
11. // 获取数据源类型  
12. public static String getDataSourceType() {  
13.     return (String) contextHolder.get();  
14. }  
15.   
16. // 清除数据源类型  
17. public static void clearDataSourceType() {  
18.     contextHolder.remove();  
19. }  

 

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

Java代码  

1.  public class DynamicDataSource extends AbstractRoutingDataSource {    
2.     @Override  
3.     protected Object determineCurrentLookupKey() {  
4.         return DynamicDataSourceHolder.getDataSourceType();  
5.     }  
6.   
7. }  

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

  

[html]  view plain  copy

1.     <!-- 管理库数据源 -->  
2.     <bean id="defaultDataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">  
3.         <property name="driverClassName" value="${jdbc.driverClassName}" />  
4.         <property name="url" value="${jdbc.url}" />  
5.         <property name="username" value="${jdbc.username}" />  
6.         <property name="password" value="${jdbc.password}" />  
7.   
8.         <property name="initialSize" value="20" />  
9.         <property name="maxActive" value="500" />  
10.         <property name="maxIdle" value="500" />  
11.         <property name="maxWait" value="500" />  
12.         <property name="removeAbandoned" value="true"/>  
13.         <property name="testWhileIdle" value="false" />  
14.         <property name="testOnBorrow" value="true" />  
15.         <property name="testOnReturn" value="false" />  
16.         <property name="validationQuery" value="${jdbc.validationQuery}" />  
17.         <property name="defaultAutoCommit" value="false" />  
18.     </bean>  
19.   
20.     <!-- 数据仓库数据源 -->  
21.     <bean id="DWDataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">  
22.         <property name="driverClassName" value="com.ibm.db2.jcc.DB2Driver" />  
23.         <property name="url" value="${jdbc.DW.url}" />  
24.         <property name="username" value="${jdbc.DW.username}" />  
25.         <property name="password" value="${jdbc.DW.password}" />  
26.   
27.         <property name="initialSize" value="20" />  
28.         <property name="maxActive" value="500" />  
29.         <property name="maxIdle" value="500" />  
30.         <property name="maxWait" value="500" />  
31.         <property name="removeAbandoned" value="true"/>  
32.         <property name="testWhileIdle" value="false" />  
33.         <property name="testOnBorrow" value="true" />  
34.         <property name="testOnReturn" value="false" />  
35.         <property name="validationQuery" value="${jdbc.validationQuery}" />  
36.         <property name="defaultAutoCommit" value="false" />  
37.     </bean>  
38.       
39.     <!-- ODS数据库数据源 -->  
40.     <bean id="ODSDataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">  
41.         <property name="driverClassName" value="com.ibm.db2.jcc.DB2Driver" />  
42.         <property name="url" value="${jdbc.ODS.url}" />  
43.         <property name="username" value="${jdbc.ODS.username}" />  
44.         <property name="password" value="${jdbc.ODS.password}" />  
45.   
46.         <property name="initialSize" value="5" />  
47.         <property name="maxActive" value="10" />  
48.         <property name="maxIdle" value="20" />  
49.         <property name="maxWait" value="3000" />  
50.         <property name="removeAbandoned" value="true"/>  
51.         <property name="testWhileIdle" value="false" />  
52.         <property name="testOnBorrow" value="true" />  
53.         <property name="testOnReturn" value="false" />  
54.         <property name="validationQuery" value="${jdbc.validationQuery}" />  
55.         <property name="defaultAutoCommit" value="false" />  
56.     </bean>  
57.   
58.     <bean id="dataSource" class="com.eryansky.common.datasource.DynamicDataSource">  
59.         <property name="defaultTargetDataSource" ref="defaultDataSource"/>  
60.         <property name="targetDataSources">  
61.             <map>  
62.                 <!-- 注意这里的value是和上面的DataSource的id对应，key要和下面的DataSourceContextHolder中的常量对应 -->  
63.                 <entry value-ref="defaultDataSource" key="defaultDataSource"/>  
64.                 <entry value-ref="DWDataSource" key="DWDataSource"/>  
65.                 <entry value-ref="ODSDataSource" key="ODSDataSource"/>  
66.             </map>  
67.         </property>  
68.     </bean>  
69.   
70.    <!-- Hibernate切面拦截器 -->  
71.     <bean id="hibernateAspectInterceptor" class="com.jfit.core.HibernateAspectInterceptor" />  
72.   
73.     <!-- Hibernate配置 -->  
74.     <bean id="defaultSessionFactory"  
75.           class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">  
76.         <property name="dataSource" ref="dataSource" />  
77.         <property name="entityInterceptor" ref="hibernateAspectInterceptor"/>  
78.         <property name="namingStrategy">  
79.             <bean class="org.hibernate.cfg.ImprovedNamingStrategy" />  
80.         </property>  
81.         <property name="hibernateProperties">  
82.             <props>  
83.                 <prop key="hibernate.dialect">${hibernate.dialect}</prop>  
84.                 <prop key="hibernate.show_sql">${hibernate.show_sql}</prop>  
85.                 <prop key="hibernate.format_sql">${hibernate.format_sql}</prop>  
86.                 <prop key="hibernate.hbm2ddl.auto">${hibernate.hbm2ddl.auto}</prop>  
87.                 <prop key="hibernate.generate_statistics">${hibernate.generate_statistics}</prop>  
88.   
89.   
90.                 <prop key="hibernate.cache.use_second_level_cache">${hibernate.cache.use_second_level_cache}</prop>  
91.                 <prop key="hibernate.cache.use_query_cache">${hibernate.cache.use_query_cache}</prop>  
92.                 <prop key="hibernate.cache.region.factory_class">${hibernate.cache.region.factory_class}</prop>  
93.                 <prop key="net.sf.ehcache.configurationResourceName">${net.sf.ehcache.configurationResourceName}</prop>  
94.                 <prop key="hibernate.jdbc.batch_size">0</prop>  
95.                 <!--<prop key="hibernate.use_nationalized_character_data">false</prop>-->  
96.                 <prop key="hibernate.search.default.indexBase">${hibernate.search.default.indexBase}</prop>  
97.             </props>  
98.         </property>  
99.         <property name="packagesToScan">  
100.             <list>  
101.                 <value>com.xxxx.modules.*.entity</value>  
102.             </list>  
103.         </property>  
104.     </bean>  

4.数据源注解定义

[java]  view plain  copy

1. @Target({ElementType.TYPE, ElementType.METHOD})  
2. @Retention(RetentionPolicy.RUNTIME)  
3. public @interface DataSource {  
4.   
5.     String value();  
6. }  

5、配置注解切换数据源

[html]  view plain  copy

1. <!--Spring的事务管理是与数据源绑定的，一旦程序执行到事务管理的那一层（如service）的话，由于在进入该层之前事务已经通过拦截器开启，  
2.      所以请在Controller层设置注解（数据源/SessionFactory）切换、或编码方式-->  
3.  <!--动态数据源切换AOP拦截器-->  
4.  <bean name="dataSourceMethodInterceptor" class="com.eryansky.common.datasource.DataSourceMethodInterceptor"></bean>  
5.  <!-- 参与动态切换数据源的切入点对象 (切入点对象，确定何时何地调用拦截器) -->  
6.  <bean id="methodDataSourcePointCut" class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">  
7.      <!-- 配置缓存aop切面 -->  
8.      <property name="advice" ref="dataSourceMethodInterceptor" />  
9.      <!-- 配置哪些方法参与缓存策略 -->  
10.      <!--  
11.          .表示符合任何单一字元  
12.          ###  +表示符合前一个字元一次或多次  
13.          ###  *表示符合前一个字元零次或多次  
14.          ###  \Escape任何Regular expression使用到的符号  
15.      -->  
16.      <!-- .*表示前面的前缀(包括包名) 表示print方法-->  
17.      <property name="patterns">  
18.          <list>  
19.              <value>com.xxx.modules.cms.web.*Controller.*(..)</value>  
20.              <value>com.xxx.modules.md.web.*Controller.*(..)</value>  
21.          </list>  
22.      </property>  
23.  </bean>  

6.注解的方法拦截器代码

[java]  view plain  copy

1. /** 
2.  * 多数据源动态配置拦截器 
3.  * 
4.  */  
5. public class DataSourceMethodInterceptor implements MethodInterceptor, InitializingBean {  
6.   
7.     private Logger logger = LoggerFactory.getLogger(DataSourceMethodInterceptor.class);  
8.   
9.     @Override  
10.     public Object invoke(MethodInvocation invocation) throws Throwable {  
11.         Class<?> clazz = invocation.getThis().getClass();  
12.         String className = clazz.getName();  
13.         if (ClassUtils.isAssignable(clazz, Proxy.class)) {  
14.             className = invocation.getMethod().getDeclaringClass().getName();  
15.         }  
16.         String methodName = invocation.getMethod().getName();  
17.         Object[] arguments = invocation.getArguments();  
18.         logger.trace("execute {}.{}({})", className, methodName, arguments);  
19.   
20.         invocation.getMethod();  
21.         DataSource classDataSource = ReflectionUtils.getAnnotation(invocation.getThis(), DataSource.class);  
22.         DataSource methodDataSource = ReflectionUtils.getAnnotation(invocation.getMethod(), DataSource.class);  
23.         if(methodDataSource != null){  
24.             DataSourceContextHolder.setDataSourceType(methodDataSource.value());  
25.         }else if(classDataSource != null){  
26.             DataSourceContextHolder.setDataSourceType(classDataSource.value());  
27.         }else {  
28.             DataSourceContextHolder.clearDataSourceType();  
29.         }  
30.   
31.         Object result = invocation.proceed();  
32.         return result;  
33.     }  
34.   
35.     @Override  
36.     public void afterPropertiesSet() throws Exception {  
37.     }  
38. }  

7.使用

[java]  view plain  copy

1. @RequestMapping(value = {"datagrid"})  
2. @ResponseBody  
3. @DataSource("DWDataSource")//切换到DATASOURCE_DW数据源  
4. public Datagrid<Map> datagrid(@RequestParam(value="p_organId",required=false) String organId){  
5.  //省略  
6. }
7.