快捷導(dǎo)航

Spring AbstractRoutingDatasource 動(dòng)態(tài)數(shù)據(jù)源的實(shí)例講解

更新時(shí)間：2021年07月22日 09:29:47 作者：夢想畫家

本文介紹如何使用 Spring AbstractRoutingDatasource 基于上下文動(dòng)態(tài)切換數(shù)據(jù)源，因此我們會(huì)讓查找數(shù)據(jù)源邏輯獨(dú)立于數(shù)據(jù)訪問之外

Spring AbstractRoutingDatasource 動(dòng)態(tài)數(shù)據(jù)源

數(shù)據(jù)源上下文

AbstractRoutingDatasource 需要信息決定路由到那個(gè)數(shù)據(jù)源，該信息我們稱為上下文?？梢允腥魏螌ο?，下面示例我們使用枚舉 ClientDatabase 作為上下文：

public enum ClientDatabase {
    CLIENT_A, CLIENT_B
}

值得注意的是，實(shí)際中上下文可以是任何有意義的領(lǐng)域?qū)ο蟆Ｈ?Environment 定義上下文，在這種上下文中枚舉可以包括 PRODUCTION, DEVELOPMENT, and TESTING.

上下文持有者 ( ContextHolder )

上下文持有者實(shí)現(xiàn)是存儲(chǔ)當(dāng)前上下文的容器，如 ThreadLocal 對象。除了包括上下文引用外，還應(yīng)該包括set , get , clear 靜態(tài)方法，AbstractRoutingDatasource 將查詢 ContextHolder 獲得上下文，然后使用上下文查找實(shí)際的數(shù)據(jù)源。

這里最重要的是使用 ThreadLocal ，讓上下文綁定只當(dāng)前執(zhí)行線程。使用這種方法就是為了保障當(dāng)數(shù)據(jù)訪問邏輯跨多個(gè)數(shù)據(jù)源使用事務(wù)：

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();
    }
}

數(shù)據(jù)源路由器

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

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

配置

下面利用Map上下文存儲(chǔ)DataSource對象，用于配置 AbstractRoutingDataSource 。當(dāng)然也可以指定缺省數(shù)據(jù)源，當(dāng)沒有設(shè)定上下文時(shí)選擇缺省數(shù)據(jù)源。

@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;
    }
    // ...
}

我們可以使用不同方式的數(shù)據(jù)源，但典型場景時(shí)運(yùn)行時(shí)創(chuàng)建，或使用JNDI方式查找。下面定義示例的Dao類，它依賴動(dòng)態(tài)數(shù)據(jù)源進(jìn)行實(shí)例化：

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");
    };
}

使用動(dòng)態(tài)數(shù)據(jù)源

實(shí)際使用時(shí)，首先設(shè)置上下文，然后再執(zhí)行業(yè)務(wù)操作。我們定義業(yè)務(wù)層，其中業(yè)務(wù)方法包括上下文作為參數(shù)。在執(zhí)行業(yè)務(wù)之前設(shè)置上下文，調(diào)用之后清除上下文：

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;
    }
}