Spring boot数据源切换实现读写分离

读写分离算是一个常规需求，也有很多解决方案。
这里记录一种使用Spring中提供的AbstractRoutingDataSource进行决策选择不同的数据源，来实现读写分离的方案。

数据源选择原则的确定

不同的业务需求需要不同的数据源切换规则，如果项目接口时遵循restful的原则，我么可以通过请求类型来确定使用读取连接还是写入连接。即
POST，PUT，DELETE请求对应write数据连接，其它请求类型对应read数据连接。
当然实际的决策过程可能会稍微复杂点。这里只是提供一种简单的策略，不用再此过多的纠结。

AbstractRoutingDataSource简介

AbstractRoutingDataSource提供了一个DataSource的代理包装，它自身也实现了DataSource接口，但它将getConnection交给了determineTargetDataSource去处理。
以下片段来自AbstractRoutingDataSource源码

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

    @Override
    public Connection getConnection(String username, String password) throws SQLException {
        return determineTargetDataSource().getConnection(username, password);
    }

AbstractRoutingDataSource 需要一个 包含连接信息的Map对象来存储多个连接信息，还需要一个默认的数据连接来处理当不能通过指定方式在map中获取到数据连接时，用于返回一个默认连接
以下代码来自AbstractRoutingDataSource源码

    protected DataSource determineTargetDataSource() {
        Assert.notNull(this.resolvedDataSources, "DataSource router not initialized");
        // 获取到如何获取当前连接的key.
        Object lookupKey = determineCurrentLookupKey();
        // 从连接map中获取到对应的DataSource
        DataSource dataSource = this.resolvedDataSources.get(lookupKey);
        // 当从map中获取到的对象为空时，返回默认的连接
        if (dataSource == null && (this.lenientFallback || lookupKey == null)) {
            dataSource = this.resolvedDefaultDataSource;
        }
        if (dataSource == null) {
            throw new IllegalStateException("Cannot determine target DataSource for lookup key [" + lookupKey + "]");
        }
        return dataSource;
    }

其中determineCurrentLookupKey()是一个抽象方法，需要我们自己来实现，这也是我们需要处理的关键逻辑。

实现我们的选择逻辑

我们需要实现我么自己的RoutingDataSource以便实现真正的逻辑选择。
以下是一个通过httpmethod来切换数据源的实现

import ...
public class RequestRoutingDataSource extends AbstractRoutingDataSource {

    private static final Logger log = LoggerFactory.getLogger(RequestRoutingDataSource.class);

    /**
     * 自动注入 HttpServletRequest，需要获取 request.method
     */
    @Autowired
    private HttpServletRequest request;

    @Override
    protected String determineCurrentLookupKey() {
        // 可能系统中某些对dataSource的请求不是通过http请求 而产生的，比如 后台定时任务等，启动启动时的数据初始化等
        // 而 HttpServletRequest 是跟请求相关的，这时尝试获取request就会报错
        // 这里用 try {...} catch {...}捕捉错误，不会导致程序启动中断
        try {
            HttpMethod method = HttpMethod.resolve(this.request.getMethod());
            // 当请求时POST,PUT,DELETE时，返回key为write.否词返回key为read
            switch (method) {
            case POST:
            case PUT:
            case DELETE:
                return "write";
            default:
                return "read";
            }
        } catch (Exception e) {
            log.error("尝试解析 request时出错，或许不是从HttpServletRequest中发起的调用", e);
            return null;
        }
    }
}

在代码中注入了一个HttpServletRequest对象。
这里要注意的是我们把解析HttpServletRequest.getMethod()的方法用try {...}catch{...}处理，这是因为HttpServletRequest是和请求相关的。但在系统中，我们需要数据连接的地方并不一定是有请求被发起。比如定时任务，或者系统数据的初始化等。这时如果尝试解析HttpServleltRequest对象，会导致程序异常。我们需要捕捉该异常，以免程序崩溃。并且返回一个null.这样AbstractRoutingDataSource会使用我们设置默认的DataSource。

将DataSource配置在系统中

接下来，我们需要重新配置一个DataSource bean,用来替换系统默认的DataSource bean.

@Configuration
public class DataSourceConfiguration {
    @Bean
    public DataSource dataSource() {
        DataSource readSource = readSource();
        DataSource writeSource = writeSource();
        RequestRoutingDataSource source = new RequestRoutingDataSource();
        Map sourceMap = new HashMap<>();
        // 分别将两个连接以指定的关键字为key放入map中
        sourceMap.put("read", readSource);
        sourceMap.put("write", writeSource);        
        source.setTargetDataSources(sourceMap);
        // 设置当系统不能正确的获取关键字时，需要使用的连接，
        // 这通常是由于不是通过发起请求获取连接，而是系统初始化，或者定时任务的连接请求
        // 需要根据项目实际情况设计
        source.setDefaultTargetDataSource(writeSource);
        return source;
    }

    private DataSource readSource() {
        ...读连接的配置，此处省略
    }

    private DataSource writeSource() {
        ...写连接的配置，此处省略
    }
}

通过以上的配置，就可以简单的在项目中实现POST、PUT、DELETE请求操作写数据库，而其它请求操作读数据库。
完整的项目地址 https://github.com/ldwqh0/spring-routing-datasource.git