Java注解實(shí)現(xiàn)動(dòng)態(tài)數(shù)據(jù)源切換的實(shí)例代碼

更新時(shí)間：2017年06月30日 09:09:40 作者：aheizi

本篇文章主要介紹了Java注解實(shí)現(xiàn)動(dòng)態(tài)數(shù)據(jù)源切換的實(shí)例代碼，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

當(dāng)一個(gè)項(xiàng)目中有多個(gè)數(shù)據(jù)源（也可以是主從庫）的時(shí)候，我們可以利用注解在mapper接口上標(biāo)注數(shù)據(jù)源，從而來實(shí)現(xiàn)多個(gè)數(shù)據(jù)源在運(yùn)行時(shí)的動(dòng)態(tài)切換。

實(shí)現(xiàn)原理

在Spring 2.0.1中引入了AbstractRoutingDataSource, 該類充當(dāng)了DataSource的路由中介, 能有在運(yùn)行時(shí), 根據(jù)某種key值來動(dòng)態(tài)切換到真正的DataSource上。

看下AbstractRoutingDataSource：

復(fù)制代碼代碼如下:

public abstract class AbstractRoutingDataSource extends AbstractDataSource implements InitializingBean

AbstractRoutingDataSource繼承了AbstractDataSource，獲取數(shù)據(jù)源部分：

/** 
 * 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值，然后根據(jù)這個(gè)key從resolvedDataSources這個(gè)map里取出對(duì)應(yīng)的DataSource，如果找不到，則用默認(rèn)的resolvedDefaultDataSource。

我們要做的就是實(shí)現(xiàn)抽象方法 determineCurrentLookupKey() 返回?cái)?shù)據(jù)源的key值。

使用方法

定義注解：

/**
 * Created by huangyangquan on 2016/11/30.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface DataSource {

  DataSourceType value();

}

注解為數(shù)據(jù)源的名稱，可定義一個(gè)枚舉類表示：

/**
 * Created by huangyangquan on 2016/11/30.
 */
public enum DataSourceType {

  MASTER,
  SLAVE

}

注解定義好了，我們利用Spring的AOP根據(jù)注解內(nèi)容對(duì)數(shù)據(jù)源進(jìn)行選擇，這里需要利用上面提到的 AbstractRoutingDataSource 類，該類是能夠?qū)崿F(xiàn)數(shù)據(jù)源切換的關(guān)鍵所在。

定義類DynamicDataSource繼承AbstractRoutingDataSource，并實(shí)現(xiàn) determineCurrentLookupKey() ，返回?cái)?shù)據(jù)源的key值。

/**
 * Created by huangyangquan on 2016/11/30.
 */
public class DynamicDataSource extends AbstractRoutingDataSource {

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

}

DynamicDataSourceHolder 是我們管理DataSource的類，將一次數(shù)據(jù)庫操作的數(shù)據(jù)源名稱保存在DynamicDataSourceHolder中，以供后面的操作在此context中取數(shù)據(jù)源key，其中DataSourceType使用了線程本地變量來保證線程安全。

/**
 * Created by huangyangquan on 2016/11/30.
 */
public class DynamicDataSourceHolder {

  // 線程本地環(huán)境
  private static final ThreadLocal<DataSourceType> contextHolder = new ThreadLocal<DataSourceType>();

  // 設(shè)置數(shù)據(jù)源類型
  public static void setDataSourceType(DataSourceType dataSourceType) {
    Assert.notNull(dataSourceType, "DataSourceType cannot be null");
    contextHolder.set(dataSourceType);
  }

  // 獲取數(shù)據(jù)源類型
  public static DataSourceType getDataSourceType() {
    return (DataSourceType) contextHolder.get();
  }

  // 清除數(shù)據(jù)源類型
  public static void clearDataSourceType() {
    contextHolder.remove();
  }

}

我們?cè)赟pring的配置文件中配置數(shù)據(jù)源key值得對(duì)應(yīng)關(guān)系：

<bean id="spyGhotelDataSource" class="com.aheizi.config.DynamicDataSource">
  <property name="targetDataSources">
    <map key-type="java.lang.String">
      <entry key="MASTER" value-ref="TEST-MASTER-DB"></entry>
      <entry key="SLAVE" value-ref="TEST-SLAVE-DB"></entry>
    </map>
  </property>
  <property name="defaultTargetDataSource" ref="TEST-MASTER-DB">
  </property>
</bean>

設(shè)置targetDataSources和defaultTargetDataSource。 TEST-MASTER-DB 和 TEST-SLAVE-DB 表示主庫的從庫，是我們的兩個(gè)數(shù)據(jù)源。

接下來配置AOP切面：

<aop:aspectj-autoproxy proxy-target-class="false" />
<bean id="manyDataSourceAspect" class="com.aheizi.config.DataSourceAspect" />
<aop:config>
  <aop:aspect id="dataSourceCut" ref="manyDataSourceAspect">
    <aop:pointcut expression="execution(* com.aheizi.dao.*.*(..))"
      id="dataSourceCutPoint" /><!-- 配置切點(diǎn) -->
    <aop:before pointcut-ref="dataSourceCutPoint" method="before" />
  </aop:aspect>
</aop:config>

以下是切面中before執(zhí)行的DataSourceAspect的實(shí)現(xiàn)，主要實(shí)現(xiàn)的功能是獲取方法上的注解，根據(jù)注解名稱將值設(shè)置到DynamicDataSourceHolder中，這樣在執(zhí)行查詢的時(shí)候， determineCurrentLookupKey() 返回?cái)?shù)據(jù)源的key值就是我們希望的那個(gè)數(shù)據(jù)源了。

/**
 * Created by huangyangquan on 2016/11/30.
 */
public class DataSourceAspect {

  private static final Logger LOG = LoggerFactory.getLogger(DataSourceAspect.class);

  public void before(JoinPoint point){
    Object target = point.getTarget();
    String method = point.getSignature().getName();
    Class<?>[] classz = target.getClass().getInterfaces();
    Class<?>[] parameterTypes = ((MethodSignature) point.getSignature()).getMethod().getParameterTypes();
    try {
      Method m = classz[0].getMethod(method, parameterTypes);
      if (m != null && m.isAnnotationPresent(DataSource.class)) {
        // 訪問mapper中的注解
        DataSource data = m.getAnnotation(DataSource.class);
        switch (data.value()) {
          case MASTER:
            DynamicDataSourceHolder.setDataSourceType(DataSourceType.MASTER);
            LOG.info("using dataSource:{}", DataSourceType.MASTER);
            break;
          case SLAVE:
            DynamicDataSourceHolder.setDataSourceType(DataSourceType.SLAVE);
            LOG.info("using dataSource:{}", DataSourceType.SLAVE);
            break;
        }
      }
    } catch (Exception e) {
      LOG.error("dataSource annotation error:{}", e.getMessage());
      // 若出現(xiàn)異常，手動(dòng)設(shè)為主庫
      DynamicDataSourceHolder.setDataSourceType(DataSourceType.MASTER);
    }
  }

}

這樣我們就實(shí)現(xiàn)了一個(gè)動(dòng)態(tài)數(shù)據(jù)源切換的功能。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: