教你MyBatis整合Springboot实现多数据源

前言

数据源，实际就是数据库连接池，负责管理数据库连接，在Springboot中，数据源通常以一个bean的形式存在于IOC容器中，也就是我们可以通过依赖注入的方式拿到数据源，然后再从数据源中获取数据库连接。

那么什么是多数据源呢，其实就是IOC容器中有多个数据源的bean，这些数据源可以是不同的数据源类型，也可以连接不同的数据库。

本文将对多数据如何加载，如何结合MyBatis使用进行说明，知识点脑图如下所示。

正文

一. 数据源概念和常见数据源介绍

数据源，其实就是数据库连接池，负责数据库连接的管理和借出。目前使用较多也是性能较优的有如下几款数据源。

1. TomcatJdbc。TomcatJdbc是Apache提供的一种数据库连接池解决方案，各方面都还行，各方面也都不突出；
2. Druid。Druid是阿里开源的数据库连接池，是阿里监控系统Dragoon的副产品，提供了强大的可监控性和基于Filter-Chain的可扩展性；
3. HikariCP。HikariCP是基于BoneCP进行了大量改进和优化的数据库连接池，是Springboot 2.x版本默认的数据库连接池，也是速度最快的数据库连接池。

二. Springboot加载数据源原理分析

首先搭建一个极简的示例工程，POM文件引入依赖如下所示。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
复制代码

编写一个Springboot的启动类，如下所示。

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}
复制代码

再编写一个从数据源拿连接的DAO类，如下所示。

@Repository
public class MyDao implements InitializingBean {

    @Autowired
    private DataSource dataSource;

    @Override
    public void afterPropertiesSet() throws Exception {
        Connection connection = dataSource.getConnection();
        System.out.println("获取到数据库连接：" + connection);
    }

}
复制代码

在application.yml文件中加入数据源的参数配置。

spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      max-lifetime: 1600000
      keep-alive-time: 90000
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.101.8:3306/test?characterEncoding=utf-8&serverTimezone=UTC&useSSL=false
    username: root
    password: root
复制代码

其中url，username和password是必须配置的，其它的仅仅是为了演示。

整体的工程目录如下。

负责完成数据源加载的类叫做DataSourceAutoConfiguration，由spring-boot-autoconfigure包提供，DataSourceAutoConfiguration的加载是基于Springboot的自动装配机制，不过这里说明一下，由于本篇文章是基于Springboot的2.7.6版本，所以没有办法在spring-boot-autoconfigure包的spring.factories文件中找到DataSourceAutoConfiguration，在Springboot的2.7.x版本中，是通过加载META-INF/spring/xxx.xxx.xxx.imports文件来实现自动装配的，但这不是本文重点，故先在这里略做说明。

下面先看一下DataSourceAutoConfiguration的部分代码实现。

@AutoConfiguration(before = SqlInitializationAutoConfiguration.class)
@ConditionalOnClass({DataSource.class, EmbeddedDatabaseType.class})
@ConditionalOnMissingBean(type = "io.r2dbc.spi.ConnectionFactory")
@EnableConfigurationProperties(DataSourceProperties.class)
@Import(DataSourcePoolMetadataProvidersConfiguration.class)
public class DataSourceAutoConfiguration {

    ......

    @Configuration(proxyBeanMethods = false)
    @Conditional(PooledDataSourceCondition.class)
    @ConditionalOnMissingBean({DataSource.class, XADataSource.class})
    @Import({DataSourceConfiguration.Hikari.class, DataSourceConfiguration.Tomcat.class,
            DataSourceConfiguration.Dbcp2.class, DataSourceConfiguration.OracleUcp.class,
            DataSourceConfiguration.Generic.class, DataSourceJmxConfiguration.class})
    protected static class PooledDataSourceConfiguration {

    }

    ......

}
复制代码

上述展示出来的代码，做了两件和加载数据源有关的事情。

1. 将数据源的配置类DataSourceProperties注册到了容器中；
2. 将DataSourceConfiguration的静态内部类Hikari注册到了容器中。

先看一下DataSourceProperties的实现，如下所示。

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties implements BeanClassLoaderAware, InitializingBean {

	private ClassLoader classLoader;

	private boolean generateUniqueName = true;

	private String name;

	private Class<? extends DataSource> type;

	private String driverClassName;

	private String url;

	private String username;

	private String password;
	
	......
	
}
复制代码

DataSourceProperties中加载了配置在application.yml文件中的spring.datasource.xxx等配置，像我们配置的type，driver-class-name，url，username和password都会加载在DataSourceProperties中。

再看一下DataSourceConfiguration的静态内部类Hikari的实现，如下所示。

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(HikariDataSource.class)
@ConditionalOnMissingBean(DataSource.class)
@ConditionalOnProperty(name = "spring.datasource.type", havingValue = "com.zaxxer.hikari.HikariDataSource",
        matchIfMissing = true)
static class Hikari {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.hikari")
    HikariDataSource dataSource(DataSourceProperties properties) {
        HikariDataSource dataSource = createDataSource(properties, HikariDataSource.class);
        if (StringUtils.hasText(properties.getName())) {
            dataSource.setPoolName(properties.getName());
        }
        return dataSource;
    }

}
复制代码

可知Hikari会向容器注册一个HikariCP的数据源HikariDataSource，同时HikariDataSource也是一个配置类，其会加载application.yml文件中的spring.datasource.hikari.xxx等和HikariCP相关的数据源配置，像我们配置的max-lifetime和keep-alive-time都会加载在HikariDataSource中。

然后还能发现，创建HikariDataSource的createDataSource方法的第一个参数是容器中的DataSourceProperties的bean，所以在创建HikariDataSource时，肯定是需要使用到DataSourceProperties里面保存的相关配置的，下面看一下DataSourceConfiguration的createDataSource() 方法的实现。

protected static <T> T createDataSource(DataSourceProperties properties, Class<? extends DataSource> type) {
    return (T) properties.initializeDataSourceBuilder().type(type).build();
}
复制代码

DataSourceProperties的initializeDataSourceBuilder() 方法会返回一个DataSourceBuilder，具体实现如下。

public DataSourceBuilder<?> initializeDataSourceBuilder() {
    return DataSourceBuilder.create(getClas