Spring AbstractRoutingDatasource 動態數據源的實例講解

Posted on 2021-07-22 by WalkonNet

Spring AbstractRoutingDatasource 動態數據源

數據源上下文

AbstractRoutingDatasource 需要信息決定路由到那個數據源，該信息我們稱為上下文。可以市任何對象，下面示例我們使用枚舉 ClientDatabase 作為上下文：

public enum ClientDatabase {
    CLIENT_A, CLIENT_B
}

值得註意的是，實際中上下文可以是任何有意義的領域對象。如 Environment 定義上下文，在這種上下文中枚舉可以包括 PRODUCTION, DEVELOPMENT, and TESTING.

上下文持有者 ( ContextHolder )

上下文持有者實現是存儲當前上下文的容器，如 ThreadLocal 對象。除瞭包括上下文引用外，還應該包括set , get , clear 靜態方法，AbstractRoutingDatasource 將查詢 ContextHolder 獲得上下文，然後使用上下文查找實際的數據源。

這裡最重要的是使用 ThreadLocal ，讓上下文綁定隻當前執行線程。使用這種方法就是為瞭保障當數據訪問邏輯跨多個數據源使用事務：

public class ClientDatabaseContextHolder {
    private static ThreadLocal<ClientDatabase> CONTEXT  = new ThreadLocal<>();
    public static void set(ClientDatabase clientDatabase) {
        Assert.notNull(clientDatabase, "clientDatabase cannot be null");
        CONTEXT.set(clientDatabase);
    }
    public static ClientDatabase getClientDatabase() {
        return CONTEXT.get();
    }
    public static void clear() {
        CONTEXT.remove();
    }
}

數據源路由器

下面定義 ClientDataSourceRouter 繼承 AbstractRoutingDataSource. 重寫方法 determineCurrentLookupKey ，查詢 ClientDatabaseContextHolder 獲得當前上下文。AbstractRoutingDataSource 幫我們處理瞭其他邏輯，僅瞭解它透明地返回瞭合適的數據源：

public class ClientDataSourceRouter extends AbstractRoutingDataSource {
    @Override
    protected Object determineCurrentLookupKey() {
        return ClientDatabaseContextHolder.getClientDatabase();
    }
}

配置

下面利用Map上下文存儲DataSource對象，用於配置 AbstractRoutingDataSource 。當然也可以指定缺省數據源，當沒有設定上下文時選擇缺省數據源。

@Configuration
public class RoutingTestConfiguration {
    @Bean
    public ClientService clientService() {
        return new ClientService(new ClientDao(clientDatasource()));
    }
 
    @Bean
    public DataSource clientDatasource() {
        Map<Object, Object> targetDataSources = new HashMap<>();
        DataSource clientADatasource = clientADatasource();
        DataSource clientBDatasource = clientBDatasource();
        targetDataSources.put(ClientDatabase.CLIENT_A, clientADatasource);
        targetDataSources.put(ClientDatabase.CLIENT_B, clientBDatasource);
        ClientDataSourceRouter clientRoutingDatasource  = new ClientDataSourceRouter();
        clientRoutingDatasource.setTargetDataSources(targetDataSources);
        clientRoutingDatasource.setDefaultTargetDataSource(clientADatasource);        
        return clientRoutingDatasource;
    }
    // ...
}

我們可以使用不同方式的數據源，但典型場景時運行時創建，或使用JNDI方式查找。下面定義示例的Dao類，它依賴動態數據源進行實例化：

public class ClientDao {
    private static final String SQL_GET_CLIENT_NAME = "select name from client";
    private final JdbcTemplate jdbcTemplate;
    public ClientDao(DataSource datasource) {
        this.jdbcTemplate = new JdbcTemplate(datasource);
    }
    public String getClientName() {
        return this.jdbcTemplate.query(SQL_GET_CLIENT_NAME, rowMapper).get(0);
    }
    private static RowMapper<String> rowMapper = (rs, rowNum) -> {
        return rs.getString("name");
    };
}

使用動態數據源

實際使用時，首先設置上下文，然後再執行業務操作。我們定義業務層，其中業務方法包括上下文作為參數。在執行業務之前設置上下文，調用之後清除上下文：

public class ClientService {
    private final ClientDao clientDao;
    public ClientService(ClientDao clientDao) {
        this.clientDao = clientDao;
    }
    public String getClientName(ClientDatabase clientDb) {
        ClientDatabaseContextHolder.set(clientDb);
        String clientName = this.clientDao.getClientName();
        ClientDatabaseContextHolder.clear();
        return clientName;
    }
}

總結

本文通過示例解釋如何使用 Spring AbstractRoutingDataSource 實現動態數據源切換。

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

Spring AbstractRoutingDatasource 動態數據源的實例講解