淺談利用Spring的AbstractRoutingDataSource解決多數據源的問題

更新時間：2017年08月11日 08:51:16 作者：Hing Kwan

本篇文章主要介紹了淺談利用Spring的AbstractRoutingDataSource解決多數據源的問題，具有一定的參考價值，有需要的可以了解一下

在互聯(lián)網的服務端開發(fā)的時候，我們很經常要在一個項目中去調用不同的數據庫。在這種情況下，必然要涉及到多數據源問題。那么，我們該如何解決多數據源問題呢？有沒有一種方法來動態(tài)切換數據源呢？

答案是有的。萬能的Spring已經給了我們解決方案——利用AbstractRoutingDataSource。在 AbstractRoutingDataSource 類中，發(fā)現 getConnection() 方法，從名字上可以知道它是獲得connection連接的。跟蹤 getConnection() 方法， determineTargetDataSource() 就這么進入我們的視線，繼續(xù)下去，我們發(fā)現了重點—— determineCurrentLookupKey() 。 determineCurrentLookupKey 方法是一個抽象方法，它的返回值就是我們要用到的數據源dataSource的key，然后根據這個key從 resolvedDataSources 這個map中取出dataSource，如果找不到就使用默認的dataSource。

知道了這些，我們就來用代碼實現吧！以下的代碼是基于Spring Boot，所以需要建立一個Spring Boot項目，然后引入spring-boot-starter-jdbc。項目中又有用到AOP，肯定的，我們必須引入spring-boot-starter-aop。

接下來，我們需要建一個DynamicDataSource。

public class DynamicDataSourceextends AbstractRoutingDataSource{

  @Override
  protectedObjectdetermineCurrentLookupKey(){
    String dataSourceName = DynamicDataSourceContextHolder.getDataSourceName();
    return dataSourceName;
  }
}

DynamicDataSource 繼承了抽象類 AbstractRoutingDataSource ，實現了 determineCurrentLookupKey() 。在 DynamicDataSourceContextHolder 中，我們使用ThreadLocal維護 dataSouceName 這個變量。這樣，每一個線程都可以獨立改變自己的副本，而不會影響其他線程所對應的副本。

/**
 * 動態(tài)數據源上下文
 */
public class DynamicDataSourceContextHolder{

  private static final ThreadLocal<String> contextHolder = new ThreadLocal<>();
  public static List<String> dataSourceNames = new ArrayList<>();

  public static void setDataSourceName(String name){
    contextHolder.set(name);
  }

  public staticStringgetDataSourceName(){
    return contextHolder.get();
  }

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

  public static boolean containsDataSource(String dataSourceName){
    return dataSourceNames.contains(dataSourceName);
  }

}

OK，我們已經有了動態(tài)數據源DynamicDataSource，也有了DynamicDataSourceContextHolder，我們怎么使用呢？讓我們看下 DataSourceConfig 。

@Configuration
public class DataSourceConfig{

  @Bean(name = "primaryDataSource")
  @ConfigurationProperties(prefix = "spring.datasource.primary")
  @Primary
  publicDataSourceprimaryDataSource(){
    return DataSourceBuilder.create().build();
  }

  @Bean(name = "secondaryDataSource")
  @ConfigurationProperties(prefix = "spring.datasource.secondary")
  publicDataSourcesecondaryDataSource(){
    return DataSourceBuilder.create().build();
  }

  @Autowired
  @Qualifier("primaryDataSource")
  private DataSource primaryDataSource;

  @Autowired
  @Qualifier("secondaryDataSource")
  private DataSource secondaryDataSource;

  @Bean
  publicDynamicDataSourcedataSource(){

    Map<Object, Object> targetDataSources = new HashMap<>();
    targetDataSources.put("primaryDataSource", primaryDataSource);
    targetDataSources.put("secondaryDataSource", secondaryDataSource);

    DynamicDataSourceContextHolder.dataSourceNames.add("primaryDataSource");
    DynamicDataSourceContextHolder.dataSourceNames.add("secondaryDataSource");

    DynamicDataSource dataSource = new DynamicDataSource();
    //設置數據源映射
    dataSource.setTargetDataSources(targetDataSources);
    //設置默認數據源，當無法映射到數據源時會使用默認數據源
    dataSource.setDefaultTargetDataSource(primaryDataSource);
    dataSource.afterPropertiesSet();

    return dataSource;
  }

}

當然，上面的 DataSourceConfig 還得搭配 application.properties 配置文件。

#
spring.datasource.primary.jdbcUrl=jdbc:mysql://localhost/test1?useSSL=false
spring.datasource.primary.username=root
spring.datasource.primary.password=root
spring.datasource.primary.driver-class-name=com.mysql.jdbc.Driver
#
spring.datasource.secondary.jdbcUrl=jdbc:mysql://localhost/test2?useSSL=false
spring.datasource.secondary.username=root
spring.datasource.secondary.password=root
spring.datasource.secondary.driver-class-name=com.mysql.jdbc.Driver

到現在為止，我們已經配置了動態(tài)的數據源，將我們的多個數據源設置給了DynamicDataSource。這樣，我們就可以在Service或者是Dao中使用 DynamicDataSourceContextHolder.setDataSourceName("primaryDataSource") 方法來動態(tài)切換數據源了。但是，這樣的寫法會不會感到很不爽呢？其實，我們可以在方法上使用注解來切換數據源。

自定義一個注解TargetDataSource：

/**
 * 在方法上使用，用于指定使用哪個數據源
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface TargetDataSource {

  Stringvalue();

}

這樣，我們就可以在Service上如以下使用：

@TargetDataSource(value = "primaryDataSource")
publicList<Customer>findAll(){
  //TODO
  return null;
}

@TargetDataSource(value = "secondaryDataSource")
public void addCustomer(String name, String email){

}

很明顯的，到目前為止還不能完成我們的切換需求。我們還需要一段代碼，來實現動態(tài)調用 DynamicDataSourceContextHolder.setDataSourceName("xxx") ，比較好的實現就是AOP啦。

@Aspect
@Component
@Order(-1)// 保證該AOP在@Transactional之前執(zhí)行
public class DynamicDataSourceChangeAspect{

  private static final Logger logger = LoggerFactory.getLogger(DynamicDataSourceChangeAspect.class);

  @Before("@annotation(targetDataSource)")
  public void changeDataSource(JoinPoint joinPoint, TargetDataSource targetDataSource){
    String dsName = targetDataSource.value();
    if (!DynamicDataSourceContextHolder.containsDataSource(dsName)) {
      System.err.println("數據源[{}]不存在，使用默認數據源 > {}" + targetDataSource.value() + joinPoint.getSignature());
    } else {
      DynamicDataSourceContextHolder.setDataSourceName(targetDataSource.value()); //設置到動態(tài)數據源上下文中
    }
  }

  @After("@annotation(targetDataSource)")
  public void restoreDataSource(JoinPoint point, TargetDataSource targetDataSource){
    //方法執(zhí)行完畢之后，銷毀當前數據源信息，進行垃圾回收。
    DynamicDataSourceContextHolder.clearDataSourceName();
  }
}

到現在為止，我們就實現了動態(tài)切換數據源了。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: