spring学习：多数据源深入解析，包括使用场景【云图智联】

1 多数据源的典型使用场景

在实际开发中，经常可能遇到在一个应用中可能需要访问多个数据库的情况。以下是两种典型场景：

1 业务复杂

数据分布在不同的数据库中，笔者见过一个相对比较复杂的业务，一个业务中同时操作了9个库。

2 读写分离

一些规模较小的公司，没有专门的中间件团队搭建读写分离基础设施，因此需要业务开发人员自行实现读写分离。 

这里的架构与上图类似。不同的是，在读写分离中，主库和从库的数据库是一致的(不考虑主从延迟)。数据更新操作(insert、update、delete)都是在主库上进行，主库将数据变更信息同步给从库。在查询时，可以在从库上进行，从而分担主库的压力。

2 如何实现多数据源

对于大多数的java应用，都使用了spring框架，spring-jdbc模块提供了AbstractRoutingDataSource，其内部可以包含了多个DataSource，然后在运行时来动态的访问哪个数据库。这种方式访问数据库的架构图如下所示： 

应用直接操作的是AbstractRoutingDataSource的实现类，告诉AbstractRoutingDataSource访问哪个数据库，然后由AbstractRoutingDataSource从事先配置好的数据源(ds1、ds2)选择一个，来访问对应的数据库。

关于如何利用AbstractRoutingDataSource实现多数据源访问，各种博客已经很多，基本功能都能实现，但是易用性不够好，要修改大量代码，业务侵入性太强。

这也是笔者为什么写这篇文章的原因，这里提供了一种更加简单易用的多数据源实现，笔者称之为RoutingDataSource。在读者对sprign-aop不是很了解的情况下，也能非常容易上手。而且笔者将这个组件发布到了maven中央仓库，因此你可以直接pom.xml中进行引用。 

2.     io.github.tianshouzhi
3.     routing-datasource
4.     1.0.0

3 RoutingDataSource的配置

假设我们有2个库，db1(包含user表)，db2(包含user_account表)。我们需要配置2个数据源(类型任意:druid、c3p0、dbcp、tomcat-jdbc任何实现JDBC规范的数据源都可以)，将其交给RoutingDataSource进行管理，相关配置如下：

3.     
4.     
5.     
6.     
10.     
11.     
12.     
13.     
17.     
18.         
19.             
20.             
21.             
22.         
23.     
24.     
25.     

在实际开发中，我们通常不会直接操作数据源，而是与ORM框架进行整合，这里选用mybatis，因此需要添加mybatis相关配置

3.     
4.     
5.     
9.     
10.     
11.     

UserMapper和UserAccountMapper，分别用于访问db1.user表和db2.user_account表。之后我们就可以通过这两个接口上添加@Routing注解，来让其访问不同的库。

4 @Routing注解的基本使用

@Routing可以在方法上使用，也可以在类或者接口上使用，以下是Routing注解的使用说明 

1 方法上添加@Routing注解

1. public interface UserMapper {
2.    @Routing("ds1”)
3.    //通过@Routing注解，指定此方法走ds1数据源
4.    public User selectById(@Param("id") int id);
5.    //未添加注解，将走默认的数据源，因为在配置RoutingDataSource时，已经指定了默认的数据源是ds1，所以可以成功访问user表；
6.    //注意：如果默认的数据源是ds2，此方法将会报错，因为user表位于db1中，而不是db2中
7.    public int insert(User user);
8. }

2 接口或者类上使用@Routing注解，内部定义的方法将都会继承此注解

例如我们在UserAccountMapper接口上定义了@Routing注解，接口中定义的2个方法都会走ds2数据源访问db2，而user_account位于db2中 ：

1. @Routing("ds2")
2. public interface UserAccountMapper {
3.    UserAccount selectById(@Param("id") int id);
4.    int insert(UserAccount userAccount);
5. }

提示：通常我们一个Mapper接口操作的都是某个库中的表，因此建议直接在接口上添加@Routing注解，而不是每个方法单独添加

3 接口/方法上同时添加@Routing注解，方法上的@Routing注解优先于接口上的Routing注解

1. @Routing("ds2")
2. public interface UserAccountMapper {
3.    //使用接口上@Routing注解指定的ds2数据源
4.    UserAccount selectById(@Param("id") int id);
5.    
6.    //使用方法上@Routing注解指定的ds1数据源
7.    //注意：这是一个错误的示例，因为user_account表位于db2中
8.    @Routing("ds1")
9.    int insert(UserAccount userAccount);
10. }

4 使用包级别的@Routing注解

如果项目的目录结构划分的比较好，操作不同的库的Mapper接口，位于不同的包下。如：

• com.tianshouzhi.mapper.db1包下都是操作db1的Mapper接口

• com.tianshouzhi.mapper.db2包下都是操作db2的Mapper接口

此时你可以使用包级别的@Routing注解，在包下面创建一个package-info.java，从而无需在每个接口上都定义@Routing注解。例如： 

注：对于@Routing注解而言，优先级满足以下条件：方法>接口>包

5 在业务层方法调用

     Mapper映射器接口属于dao层，通常dao层的代码都是在service层进行调用的，业务层的接口也可以添加@Routing注解，如果没有添加。则由调用的Mapper映射器方法、接口上的@Routing注解决定使用哪个ds，如果都没有没有定义，则使用默认的数据源 

1.  public void business(int userId,int userAccountId) {
2.       userAccountMapper.selectById(userAccountId);
3.       userMapper.selectById(userId);
4.  }

6 业务层方法添加@Routing注解

业务层方法添加@Routing注解后，将忽略内部调用的Mapper映射器方法、接口上的Routing注解，如： 

1.  //指定方法内部调用的映射器接口，都必须使用ds2
2.  @Routing("ds2")
3.  public void business(int userId,int userAccountId) {
4.      //user_account表位于db2中，因此访问可以成功
5.      System.out.println(userAccountMapper.selectById(userAccountId));
6.      //注意：user表位于db1中，这里强制使用ds2，因此将执行失败
7.      System.out.println(userMapper.selectById(userId));
8. }

之所以一个方法使用了@Routing注解后，将会忽略内部调用的其他方法的@Routing注解，主要是为了与事务的语义兼容。

5 事务的支持

@Routing注解可以与spring的事务联合使用，以下是声明式事务@Transactional注解的案例，注意要保证事务中的方法必须都访问的是同一个库中的表。

以下是事务管理器的配置

3.     

1 只使用@Transactional注解，不使用@Routing注解

        这将使用我们配置的默认数据源，如果访问了其他库中的表，将会报错，也就是说，使用了@Transactional注解后，也会忽略内部调用的其他方法的@Routing注解。 

1. @Transactional
2. public void testDefaultTransaction(User user，UserAccount userAcccount) {
3.    //默认数据源是ds1，可以访问db1中user表，因此插入成功
4.    userMapper.insert(user);
5.    //注意：这个方法将执行失败，事务将回滚，因为user_account位于db2中
6.    userAccountMapper.insert(userAcccount)
7. }

2 同时使用@Transactional/@Routing注解

spring事务管理器将会使用@Routing注解中指定的数据源来开启事务 

1. @Transactional
2. @Routing("ds2”) //使用ds2开启事务
3. public void testRoutingTransaction(User user，UserAccount userAcccount) {
4.    userAccountMapper.insert(userAccount);
5.    //注意：这个方法将执行失败，事务将回滚，因为user位于db1中
6.    userMapper.insert(user);
7. }

6 RoutingDataSource的完整使用案例

完整使用案例，可从项目的开源github地址获取：https://github.com/tianshouzhi/routing-datasource，也可以通过git 克隆项目源码： 

1. git clone https://github.com/tianshouzhi/routing-datasource.git

相关代码位于test目下：

以下是相关建表语句：

1. CREATE DATABASE `db1`;
2. CREATE TABLE `user` (
3.   `id` int(11) NOT NULL AUTO_INCREMENT,
4.   `name` varchar(255) NOT NULL
5.   PRIMARY KEY (`id`)
6. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
7. CREATE DATABASE `db2`;
8. CREATE TABLE `user_account` (
9.   `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
10.   `account` varchar(255) DEFAULT NULL,
11.   PRIMARY KEY (`id`)
12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

免费学习视频欢迎关注云图智联：https://e.yuntuzhilian.com/