MyBatis整合Springboot多数据源实现

╰+攻爆jí腚メ 2024-03-23 10:47 27阅读 0赞

### 前言 ###

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

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

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

![format_png][]

### 正文 ###

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

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

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**是必须配置的，其它的仅仅是为了演示。

整体的工程目录如下。

![format_png 1][]

负责完成数据源加载的类叫做**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() {

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/5712d92ebec0449db067bb1e5ace327d.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/d0ea624331864af093739b18761522d5.png