mybatis-plus @DS實現動態切換數據源原理

Posted on by

1、mybatis-plus @DS實現動態切換數據源原理

首先mybatis-plus使用com.baomidou.dynamic.datasource.AbstractRoutingDataSource繼承 AbstractDataSource接管數據源；具體實現類為com.baomidou.dynamic.datasource.DynamicRoutingDataSource。項目初始化調用public synchronized void addDataSource(String ds, DataSource dataSource)加載數據源，數據源存進dataSourceMap中。
private Map<String, DataSource> dataSourceMap = new LinkedHashMap<>();

private Map<String, DynamicGroupDataSource> groupDataSources = new ConcurrentHashMap<>();

public synchronized void addDataSource(String ds, DataSource dataSource) {
    if (p6spy) {
      dataSource = new P6DataSource(dataSource);
    }
    dataSourceMap.put(ds, dataSource);
    if (ds.contains(UNDERLINE)) {
      String group = ds.split(UNDERLINE)[0];
      if (groupDataSources.containsKey(group)) {
        groupDataSources.get(group).addDatasource(dataSource);
      } else {
        try {
          DynamicGroupDataSource groupDatasource = new DynamicGroupDataSource(group,
              strategy.newInstance());
          groupDatasource.addDatasource(dataSource);
          groupDataSources.put(group, groupDatasource);
        } catch (Exception e) {
          log.error("dynamic-datasource - add the datasource named [{}] error", ds, e);
          dataSourceMap.remove(ds);
        }
      }
    }
    log.info("dynamic-datasource - load a datasource named [{}] success", ds);
  }

進行數據操作時，方法會被com.baomidou.dynamic.datasource.aop.DynamicDataSourceAnnotationInterceptor攔截，

public class DynamicDataSourceAnnotationInterceptor implements MethodInterceptor {

  /**
   * The identification of SPEL.
   */
  private static final String DYNAMIC_PREFIX = "#";
  private static final DynamicDataSourceClassResolver RESOLVER = new DynamicDataSourceClassResolver();
  @Setter
  private DsProcessor dsProcessor;

  @Override
  public Object invoke(MethodInvocation invocation) throws Throwable {
    try {
      DynamicDataSourceContextHolder.push(determineDatasource(invocation));
      return invocation.proceed();
    } finally {
      DynamicDataSourceContextHolder.poll();
    }
  }

  private String determineDatasource(MethodInvocation invocation) throws Throwable {
    Method method = invocation.getMethod();
    DS ds = method.isAnnotationPresent(DS.class)
        ? method.getAnnotation(DS.class)
        : AnnotationUtils.findAnnotation(RESOLVER.targetClass(invocation), DS.class);
    String key = ds.value();
    return (!key.isEmpty() && key.startsWith(DYNAMIC_PREFIX)) ? dsProcessor
        .determineDatasource(invocation, key) : key;
  }
}

攔截器首先從被攔截的方法或者類（一般@DS註解用於Service，也可用於Mapper和Controller）上尋找@DS註解，獲取到@DS註解的值後將其存入com.baomidou.dynamic.datasource.toolkit.DynamicDataSourceContextHolder；DynamicDataSourceContextHolder使用ThreadLocal存儲當前線程的數據源名。

public final class DynamicDataSourceContextHolder {

  /**
   * 為什麼要用鏈表存儲(準確的是棧)
   * 為瞭支持嵌套切換，如ABC三個service都是不同的數據源
   * 其中A的某個業務要調B的方法，B的方法需要調用C的方法。一級一級調用切換，形成瞭鏈。
   * 傳統的隻設置當前線程的方式不能滿足此業務需求，必須模擬棧，後進先出。
   */
  @SuppressWarnings("unchecked")
  private static final ThreadLocal<Deque<String>> LOOKUP_KEY_HOLDER = new ThreadLocal() {
    @Override
    protected Object initialValue() {
      return new ArrayDeque();
    }
  };

  private DynamicDataSourceContextHolder() {
  }

  /**
   * 獲得當前線程數據源
   * @return 數據源名稱
   */
  public static String peek() {
    return LOOKUP_KEY_HOLDER.get().peek();
  }

  /**
   * 設置當前線程數據源
   * 如非必要不要手動調用，調用後確保最終清除
   * @param ds 數據源名稱
   */
  public static void push(String ds) {
    LOOKUP_KEY_HOLDER.get().push(StringUtils.isEmpty(ds) ? "" : ds);
  }

  /**
   * 清空當前線程數據源
   * 如果當前線程是連續切換數據源 隻會移除掉當前線程的數據源名稱
   */
  public static void poll() {
    Deque<String> deque = LOOKUP_KEY_HOLDER.get();
    deque.poll();
    if (deque.isEmpty()) {
      LOOKUP_KEY_HOLDER.remove();
    }
  }

  /**
   * 強制清空本地線程
   * 防止內存泄漏，如手動調用瞭push可調用此方法確保清除
   */
  public static void clear() {
    LOOKUP_KEY_HOLDER.remove();
  }
}

進行數據操作時，會調用org.springframework.jdbc.datasource.getConnection()方法；getConnection()方法最終調用瞭com.baomidou.dynamic.datasource.AbstractRoutingDataSource的getConnection()方法；

  @Override
  public Connection getConnection() throws SQLException {
    return determineDataSource().getConnection();
  }

determineDataSource()由子類com.baomidou.dynamic.datasource.DynamicRoutingDataSource實現，可以看到DynamicRoutingDataSource從DynamicDataSourceContextHolder獲取數據源名稱，這個在之前攔截器處理存進ThreadLocal中，如果有數據源名稱則從dataSourceMap中獲取，沒有則獲取默認的primary數據源。

public DataSource determineDataSource() {
    return getDataSource(DynamicDataSourceContextHolder.peek());
}

public DataSource getDataSource(String ds) {
    if (StringUtils.isEmpty(ds)) {
        return determinePrimaryDataSource();
    } else if (!groupDataSources.isEmpty() && groupDataSources.containsKey(ds)) {
        log.debug("dynamic-datasource switch to the datasource named [{}]", ds);
        return groupDataSources.get(ds).determineDataSource();
    } else if (dataSourceMap.containsKey(ds)) {
        log.debug("dynamic-datasource switch to the datasource named [{}]", ds);
        return dataSourceMap.get(ds);
    }
    if (strict) {
        throw new RuntimeException("dynamic-datasource could not find a datasource named" + ds);
    }
    return determinePrimaryDataSource();
}

private DataSource determinePrimaryDataSource() {
    log.debug("dynamic-datasource switch to the primary datasource");
    return groupDataSources.containsKey(primary) ? groupDataSources.get(primary)
        .determineDataSource() : dataSourceMap.get(primary);
}

此時的數據源已經切換成瞭我們需要的數據源。

數據操作完成後，方法返回第二步中的攔截器，執行DynamicDataSourceContextHolder.poll();清除掉此次的數據源，避免影響後續數據操作。

附上動態數據源相關配置

spring:
  application:
    name: 
  datasource:
    dynamic:
      primary: dataSource1
      datasource:
        dataSource1:
          type: com.alibaba.druid.pool.DruidDataSource
          driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver
          url: jdbc:sqlserver://localhost:1433;database=dataSource1
          username: 
          password: 
        dataSource2:
          type: com.alibaba.druid.pool.DruidDataSource
          driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver
          url: jdbc:sqlserver://localhost:1433;instanceName=sqlserver2017;DatabaseName=dataSource2
          username: 
          password:

pom.xml

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>2.5.6</version>
</dependency>

相應類

@Service
//@DS("dataSource2") 放在類上就是類下所有方法都使用這個數據源。
public class XXXServiceImpl extends BaseServiceImpl<XXXMapper, XXXBean> implements XXXService {

    @DS("dataSource1")
    public void selectDataFromSource1() {
       // do somethinng;
    }
    
    @DS("dataSource2")
    public void selectDataFromSource1() {
       // do somethinng;
    }
}

**註意：**不可在事務中切換數據庫，保證事務需要方法使用同一連接，使用@DS(dataSource1)方法調用@DS(dataSource2)無法切換連接，會導致方法報錯。

到此這篇關於mybatis-plus @DS實現動態切換數據源原理的文章就介紹到這瞭,更多相關mybatis-plus @DS動態切換數據源內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：