使用AbstractRoutingDataSource實現(xiàn)數據源動態(tài)切換的實例

更新時間：2024年03月10日 09:21:58 作者：一只愛擼貓的程序猿

AbstractRoutingDataSource 是 Spring 框架提供的一個抽象類,用于實現(xiàn)動態(tài)數據源路由,這個類主要用于多數據源場景,其中可以根據不同的條件動態(tài)地切換到不同的數據源,本文給大家介紹了如何使用AbstractRoutingDataSource實現(xiàn)數據源動態(tài)切換,需要的朋友可以參考下

實現(xiàn)原理

AbstractRoutingDataSource 繼承自 Spring 的 AbstractDataSource 類，并實現(xiàn)了 DataSource 接口。它內部維護了一個映射（Map），用于存儲數據源標識和對應的數據源實例。當需要獲取連接時，AbstractRoutingDataSource 會調用一個抽象方法 determineCurrentLookupKey() 來確定當前的數據源標識，然后根據這個標識從映射中獲取對應的數據源，并從該數據源中獲取連接。

關鍵方法解析

determineCurrentLookupKey(): 這是一個抽象方法，需要用戶自己實現(xiàn)。這個方法用于確定當前的數據源標識，其返回值將用作查找映射中對應數據源的關鍵字。通常，可以在這個方法中獲取當前線程的一些狀態(tài)或上下文信息，來動態(tài)決定使用哪個數據源。
afterPropertiesSet(): 這個方法是在設置完所有屬性后被調用的。在這個方法中，AbstractRoutingDataSource 會驗證數據源映射是否已經被正確設置，并且如果設置了默認數據源，也會進行檢查。
getConnection() 和 getConnection(String username, String password): 這兩個方法是 DataSource 接口要求實現(xiàn)的方法。在 AbstractRoutingDataSource 中，這兩個方法的實現(xiàn)邏輯是先調用 determineCurrentLookupKey() 方法獲取當前數據源標識，然后根據這個標識從映射中找到對應的數據源，并調用該數據源的 getConnection() 方法獲取連接。

場景實例

我們設計一個這樣的場景，比如一個多租戶（multi-tenant）應用，其中每個租戶都有自己的數據庫。在這個場景中，系統(tǒng)根據當前用戶的租戶ID動態(tài)切換數據源。我們將使用 Spring Boot、Spring Data JPA 和 AbstractRoutingDataSource 來實現(xiàn)這個場景。

步驟 1: 定義租戶識別邏輯

首先，我們需要一個機制來識別當前請求屬于哪個租戶。假設每個請求的HTTP頭部都包含一個X-TenantID字段來標識租戶ID：

@Component
public class TenantInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        String tenantId = request.getHeader("X-TenantID");
        if (tenantId != null) {
            TenantContext.setCurrentTenant(tenantId);
        }
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        TenantContext.clear();
    }
}

在這里，TenantContext是一個存儲當前線程租戶ID的類：

public class TenantContext {
    private static final ThreadLocal<String> currentTenant = new ThreadLocal<>();

    public static void setCurrentTenant(String tenantId) {
        currentTenant.set(tenantId);
    }

    public static String getCurrentTenant() {
        return currentTenant.get();
    }

    public static void clear() {
        currentTenant.remove();
    }
}

步驟 2: 配置動態(tài)數據源

接下來，我們需要配置動態(tài)數據源來根據租戶ID選擇正確的數據庫：

public class MultiTenantDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return TenantContext.getCurrentTenant();
    }
}

@Configuration
public class DataSourceConfig {

    @Bean
    public DataSource dataSource() {
        MultiTenantDataSource dataSource = new MultiTenantDataSource();

        Map<Object, Object> targetDataSources = new HashMap<>();
        // 假設已經有一個方法來獲取所有租戶的數據源配置
        Map<String, DataSource> tenantDataSources = tenantDataSources();
        targetDataSources.putAll(tenantDataSources);

        dataSource.setTargetDataSources(targetDataSources);
        dataSource.setDefaultTargetDataSource(defaultDataSource()); // 默認數據源
        dataSource.afterPropertiesSet();
        return dataSource;
    }

    private Map<String, DataSource> tenantDataSources() {
        // 這里應該從配置文件或數據庫中加載所有租戶的數據源配置
        // 舉例，假設有兩個租戶tenantA和tenantB
        Map<String, DataSource> result = new HashMap<>();
        result.put("tenantA", createDataSource("jdbc:mysql://localhost:3306/tenantA"));
        result.put("tenantB", createDataSource("jdbc:mysql://localhost:3306/tenantB"));
        return result;
    }

    private DataSource createDataSource(String url) {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl(url);
        dataSource.setUsername("username");
        dataSource.setPassword("password");
        return dataSource;
    }

    private DataSource defaultDataSource() {
        // 定義默認數據源
        return createDataSource("jdbc:mysql://localhost:3306/defaultDb");
    }
}

步驟 3: 集成到Spring MVC

最后，我們需要確保每個請求都會通過我們的TenantInterceptor，以便正確設置租戶上下文：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private TenantInterceptor tenantInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(tenantInterceptor);
    }
}