SpringBoot中Druid連接池與多數(shù)據(jù)源切換的方法

更新時間：2024年11月15日 09:37:54 作者：碼到三十五

微服務架構中多數(shù)據(jù)源切換是個常見的需求,Spring Boot 提供了強大的支持來簡化這一過程.本文給大家介紹了SpringBoot中Druid連接池與多數(shù)據(jù)源切換的方法,需要的朋友可以參考下

多數(shù)據(jù)源切換原理

多數(shù)據(jù)源切換的原理主要基于 Spring 的 AbstractRoutingDataSource 類。AbstractRoutingDataSource 類允許根據(jù)運行時上下文動態(tài)選擇數(shù)據(jù)源。其核心在于實現(xiàn) determineCurrentLookupKey 方法，該方法決定當前操作使用哪個數(shù)據(jù)源。 AbstractRoutingDataSource 實現(xiàn)多數(shù)據(jù)源切換的原理：

1. 數(shù)據(jù)源映射

AbstractRoutingDataSource 內(nèi)部維護了一個映射（Map），用于存儲數(shù)據(jù)源標識（key）和對應的數(shù)據(jù)源實例（value）。這個映射允許根據(jù)數(shù)據(jù)源標識快速查找和獲取對應的數(shù)據(jù)源。

2. 數(shù)據(jù)源標識的確定

AbstractRoutingDataSource 提供了一個抽象方法 determineCurrentLookupKey()，該方法用于確定當前需要使用的數(shù)據(jù)源標識。這個方法需要由子類實現(xiàn)，以返回當前線程或請求應該使用的數(shù)據(jù)源標識。

3. 數(shù)據(jù)源的選擇與連接獲取

當應用程序需要獲取數(shù)據(jù)庫連接時，AbstractRoutingDataSource 的 getConnection() 方法會被調(diào)用。這個方法首先調(diào)用 determineCurrentLookupKey() 方法來獲取當前的數(shù)據(jù)源標識，然后根據(jù)這個標識從內(nèi)部映射中查找對應的數(shù)據(jù)源。
一旦找到了對應的數(shù)據(jù)源，AbstractRoutingDataSource 就會調(diào)用該數(shù)據(jù)源的 getConnection() 方法來獲取實際的數(shù)據(jù)庫連接，并將這個連接返回給應用程序。

4. 數(shù)據(jù)源切換的實現(xiàn)

為了實現(xiàn)數(shù)據(jù)源的動態(tài)切換，通常會在子類中重寫 determineCurrentLookupKey() 方法，并根據(jù)當前的上下文（如線程變量）來確定返回的數(shù)據(jù)源標識。
此外，通常會使用 ThreadLocal 來存儲每個線程的數(shù)據(jù)源標識，這樣每個線程都可以獨立地切換數(shù)據(jù)源而不會互相干擾。

實現(xiàn)步驟

1. 依賴

引入 MySQL 和 Druid 的依賴

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.2.6</version>
</dependency>

2. 配置數(shù)據(jù)源

在 application.yml 文件中配置多個數(shù)據(jù)源。

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    druid:
      datasource1:
        url: jdbc:mysql://localhost:3306/master_db
        username: root
        password: password
        initial-size: 5
        min-idle: 5
        max-active: 20
        max-wait: 60000
      datasource2:
        url: jdbc:mysql://localhost:3306/slave_db
        username: root
        password: password
        initial-size: 5
        min-idle: 5
        max-active: 20
        max-wait: 60000

3. 創(chuàng)建數(shù)據(jù)源配置類

創(chuàng)建一個配置類來定義數(shù)據(jù)源 Bean。

@Configuration
public class DataSourceConfig {

    @Bean
    @ConditionalOnProperty(prefix = "spring.datasource.druid", name = "datasource1")
    @ConfigurationProperties(prefix = "spring.datasource.druid.datasource1")
    public DataSource dataSource1() {
        return DruidDataSourceBuilder.create().build();
    }

    @Bean
    @ConditionalOnProperty(prefix = "spring.datasource.druid", name = "datasource2")
    @ConfigurationProperties(prefix = "spring.datasource.druid.datasource2")
    public DataSource dataSource2() {
        return DruidDataSourceBuilder.create().build();
    }

    @Bean
    @Primary
    public DataSource dynamicDataSource() {
        DynamicDataSource dynamicDataSource = new DynamicDataSource();
        dynamicDataSource.setDefaultTargetDataSource(dataSource1());
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put("dataSource1", dataSource1());
        targetDataSources.put("dataSource2", dataSource2());
        dynamicDataSource.setTargetDataSources(targetDataSources);
        return dynamicDataSource;
    }
}

4. 實現(xiàn) AbstractRoutingDataSource

創(chuàng)建一個繼承自 AbstractRoutingDataSource 的類，并實現(xiàn) determineCurrentLookupKey 方法。

public class DynamicDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolder.getDataSource();
    }
}

5. 創(chuàng)建 DataSourceContextHolder

創(chuàng)建一個工具類來保存當前線程的數(shù)據(jù)源信息。

public class DataSourceContextHolder {

    private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();

    public static void setDataSource(String dataSource) {
        CONTEXT_HOLDER.set(dataSource);
    }

    public static String getDataSource() {
        return CONTEXT_HOLDER.get();
    }

    public static void clearDataSource() {
        CONTEXT_HOLDER.remove();
    }
}

6. AOP動態(tài)切換數(shù)據(jù)源

使用 AOP 在方法執(zhí)行前后切換數(shù)據(jù)源。

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class DataSourceAspect {
	// 方法或者類上的橫切點
    @Pointcut("@annotation(dataSource) || @within(dataSource)")
    public void dataSourcePointcut(DataSource dataSource) {}

    @Before("dataSourcePointcut(dataSource)")
    public void switchDataSource(JoinPoint joinPoint, DataSource dataSource) {
        // 從注解中獲取數(shù)據(jù)源標識
        String dataSourceKey = dataSource.value();
        // 切換到指定的數(shù)據(jù)源
        DataSourceContextHolder.setDataSourceType(dataSourceKey);
    }

    @AfterReturning(pointcut = "dataSourcePointcut(dataSource)", returning = "result")
    public void restoreDataSource(JoinPoint joinPoint, DataSource dataSource, Object result) {
        // 恢復默認數(shù)據(jù)源（可選）
        DataSourceContextHolder.clearDataSourceType();
    }
}

/**
* 自定義注解
*/
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface DataSource {

    String value() default "dataSource1";
}