使用Spring的AbstractRoutingDataSource實(shí)現(xiàn)多數(shù)據(jù)源切換示例

更新時(shí)間：2017年02月21日 10:17:27 作者：weknow619

這篇文章主要介紹了使用Spring的AbstractRoutingDataSource實(shí)現(xiàn)多數(shù)據(jù)源切換示例，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下。

最近因?yàn)轫?xiàng)目需要在做兩個(gè)項(xiàng)目間數(shù)據(jù)同步的需求，具體是項(xiàng)目1的數(shù)據(jù)通過(guò)消息隊(duì)列同步到項(xiàng)目2中，因?yàn)檫@個(gè)更新操作還涉及到更新多個(gè)庫(kù)的數(shù)據(jù)，所以就需要多數(shù)據(jù)源切換的操作。下面就講講在Spring中如何進(jìn)行數(shù)據(jù)源切換。這里是使用AbstractRoutingDataSource類來(lái)完成具體的操作，AbstractRoutingDataSource是Spring2.0后增加的。

實(shí)現(xiàn)數(shù)據(jù)源切換的功能就是自定義一個(gè)類擴(kuò)展AbstractRoutingDataSource抽象類，其實(shí)該相當(dāng)于數(shù)據(jù)源DataSourcer的路由中介，可以實(shí)現(xiàn)在項(xiàng)目運(yùn)行時(shí)根據(jù)相應(yīng)key值切換到對(duì)應(yīng)的數(shù)據(jù)源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并實(shí)現(xiàn)了InitializingBean，AbstractRoutingDataSource的getConnection()方法調(diào)用了determineTargetDataSource()的該方法，這里重點(diǎn)看determineTargetDataSource()方法代碼，方法里使用到了determineCurrentLookupKey()方法，它是AbstractRoutingDataSource類的抽象方法，也是實(shí)現(xiàn)數(shù)據(jù)源切換要擴(kuò)展的方法，該方法的返回值就是項(xiàng)目中所要用的DataSource的key值，拿到該key后就可以在resolvedDataSource中取出對(duì)應(yīng)的DataSource，如果key找不到對(duì)應(yīng)的DataSource就使用默認(rèn)的數(shù)據(jù)源。

自定義類擴(kuò)展AbstractRoutingDataSource類時(shí)就是要重寫determineCurrentLookupKey()方法來(lái)實(shí)現(xiàn)數(shù)據(jù)源切換功能。下面是自定義的擴(kuò)展AbstractRoutingDataSource類的實(shí)現(xiàn)：

/**
 * 獲得數(shù)據(jù)源
 */
public class MultipleDataSource extends AbstractRoutingDataSource{

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

DynamicDataSourceHolder類如下，實(shí)現(xiàn)對(duì)數(shù)據(jù)源的操作功能：

/**
 * 數(shù)據(jù)源操作類
 */
public class DynamicDataSourceHolder {
  private static ThreadLocal<String> routeKey = new ThreadLocal<String>();

  /**
   * 獲取當(dāng)前線程的數(shù)據(jù)源路由的key
   */
  public static String getRouteKey()
  {
    String key = routeKey.get();
    return key;
  }

  /**
   * 綁定當(dāng)前線程數(shù)據(jù)源路由的key
   * 使用完成后必須調(diào)用removeRouteKey()方法刪除
   */
  public static void setRouteKey(String key)
  {
    routeKey.set(key);
  }

  /**
   * 刪除與當(dāng)前線程綁定的數(shù)據(jù)源路由的key
   */
  public static void removeRouteKey()
  {
    routeKey.remove();
  }
}

下面在xml文件中配置多個(gè)數(shù)據(jù)源：

<!-- 數(shù)據(jù)源 -->
<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>

<!-- 配置多數(shù)據(jù)源映射 -->
<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>
   <!-- 默認(rèn)數(shù)據(jù)源 -->
   <property name="defaultTargetDataSource" ref="dataSource1" >
   </property>
</bean>

到這里基本的配置就完成了，下面只要在需要切換數(shù)據(jù)源的地方調(diào)用方法就行了，一般是在dao層操作數(shù)據(jù)庫(kù)前進(jìn)行切換的，只需在數(shù)據(jù)庫(kù)操作前加上如下代碼即可：

DynamicDataSourceHolder.setRouteKey("dataSource2");

上面介紹的是在dao層當(dāng)需要切換數(shù)據(jù)源時(shí)手動(dòng)加上切換數(shù)據(jù)源的代碼，也可以使用AOP的方式，把配置的數(shù)據(jù)源類型都設(shè)置成注解標(biāo)簽，在dao層中需要切換數(shù)據(jù)源操作的方法或類上寫上注解標(biāo)簽，這樣實(shí)現(xiàn)起來(lái)可操作性也更強(qiáng)。

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

注解配置完后就要寫一個(gè)實(shí)現(xiàn)數(shù)據(jù)源切換的類，如下：

public class MultipleDataSourceExchange {

  /** 
   * 攔截目標(biāo)方法，獲取由@DataSource指定的數(shù)據(jù)源標(biāo)識(shí)，設(shè)置到線程存儲(chǔ)中以便切換數(shù)據(jù)源 
   */ 
  public void beforeDaoMethod(JoinPoint point) throws Exception { 
    Class<?> target = point.getTarget().getClass(); 
    MethodSignature signature = (MethodSignature) point.getSignature(); 
    // 默認(rèn)使用目標(biāo)類型的注解，如果沒有則使用其實(shí)現(xiàn)接口的注解類 
    for (Class<?> cls : target.getInterfaces()) { 
      resetDataSource(cls, signature.getMethod()); 
    } 
    resetDataSource(target, signature.getMethod()); 
  } 


  /** 
   * 提取目標(biāo)對(duì)象方法注解和類注解中的數(shù)據(jù)源標(biāo)識(shí) 
   */ 
  private void resetDataSource(Class<?> cls, Method method) { 
    try { 
      Class<?>[] types = method.getParameterTypes(); 
      // 默認(rèn)使用類注解 
      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.*.*(..))"/>
  <!-- 注意切換數(shù)據(jù)源操作要比持久層代碼先執(zhí)行 -->
  <aop:advisor advice-ref="multipleDataSourceExchange" pointcut-ref="service" order="1"/>
  <aop:advisor advice-ref="txAdvice" pointcut-ref="service" order="2"/>
</aop:config>

到此就完成使用AOP的方式實(shí)現(xiàn)多數(shù)據(jù)源的動(dòng)態(tài)切換了。

您可能感興趣的文章: