实战指南，SpringBoot + Mybatis 如何对接多数据源

本文分享自华为云社区 《实战指南，SpringBoot + Mybatis 如何对接多数据源》，作者：战斧。
在我们开发一些具有综合功能的项目时，往往会碰到一种情况，需要同时连接多个数据库，这个时候就需要用到多数据源的设计。而Spring与Myabtis其实做了多数据源的适配，只需少许改动即可对接多数据源。本期我们就贴近实战，以一个单数据源的Demo为例，讲述将其改为多数据源项目的过程，希望大家能有所体会。
一、数据源的定义

 
数据源（Data Source）是指数据存储的地方，大多数情况是指数据库，不过文件服务器、传感器、API等也能算数据源，主要是提供了对数据的访问和操作。数据源中存储了所有建立数据库连接的信息。就像通过指定文件名称可以在文件系统中找到文件一样，通过提供正确的数据源名称，你可以找到相应的数据库连接。
 
二、单数据源配置

因为SpringBoot对数据源有着高度的默认配置，只配置一个数据源时，该数据源会被作为默认，所以对接单数据源其实是非常简单的。如果你的工程采用的yaml格式配置文件，我们仅需做如下配置：

1. spring:
2.   #数据库连接配置
3.   datasource:
4.     driver-class-name: com.mysql.cj.jdbc.Driver
5.     url: jdbc:mysql://127.0.0.1:3306/springtest
6.     username: root
7.     password: root

复制代码

如果是采用properties配置文件的也是一样的：

1. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
2. spring.datasource.url=jdbc:mysql://127.0.0.1:3306/springtest
3. spring.datasource.username=root
4. spring.datasource.password=root

复制代码

三、如何配置多数据源

1. 工程层级调整

我们以曾经搭建的工程为原始模板，进行对接多数据源的操作。没看过的可以点此查看： 从零开始，手把手教你搭建Spring Boot后台工程并说明

因为仅变动数据源，所以我们不改动其他层级，仅仅将 mapper 拆为 mapper1 与 mapper2 两部分

2. Spring项目配置

然后我们需要在 application.properties 或者 application.yml 中定义多个数据源：

1. spring:
2.   #数据库连接配置
3.   datasource1:
4.     driver-class-name: com.mysql.cj.jdbc.Driver
5.     jdbc-url: jdbc:mysql://127.0.0.1:3306/springtest2
6.     username: root
7.     password: root
8.   datasource2:
9.     driver-class-name: com.mysql.cj.jdbc.Driver
10.     jdbc-url: jdbc:mysql://127.0.0.1:3306/springtest
11.     username: root
12.     password: root

复制代码

这里有两个细节需要注意：

• 因为我们决定使用双数据源，所以把数据源的连接配置改成了datasource1 和 datasource2。而不再保留datasource，这样SpringBoot就不再会为我们设定默认数据库
  
• 因为我们目前采用的 springBoot2.5.2，默认的连接池为Hikari，该连接池数据源的地址字段为jdbc-url 而非 url。在只有单个数据源时，SpringBoot走默认数据源逻辑为我们把 url 与 jdbc-url 进行映射，保证我们获得数据源。此时我们自己设置的数据源没有进行映射处理，就需要保证字段符合Hikari的要求。否则会出现 java.lang.IllegalArgumentException: jdbcUrl is required with driverClassName 异常
  

3. 会话配置

仅有配置文件可不行，接下来，我们需要在代码中读取到配置，并建立两个数据源。如下，每个数据源都有隔离的mapper接口、xml文件、会话工厂及会话模板
第一个数据源 如下（示例）：

1. @Configuration
2. @MapperScan(basePackages = "com.zhanfu.springboot.demo.mapper1", sqlSessionFactoryRef = "sqlSessionFactory1")
3. public class DataSource1Config {
5.     @Bean
6.     @ConfigurationProperties(prefix = "spring.datasource1")
7.     public DataSource dataSource1() {
8.         return DataSourceBuilder.create().build();
9.     }
11.     @Bean
12.     public SqlSessionFactory sqlSessionFactory1() throws Exception {
13.         SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
14.         sessionFactoryBean.setDataSource(dataSource1());
15.         String locationPattern = "classpath*:/mapper1/*.xml";
16.         PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
17.         sessionFactoryBean.setMapperLocations(resolver.getResources(locationPattern));
18.         return sessionFactoryBean.getObject();
19.     }
21.     @Bean(name = "sqlSessionTemplate1")
22.     public SqlSessionTemplate sqlSessionTemplate1(@Qualifier("sqlSessionFactory1") SqlSessionFactory sqlSessionFactory) {
23.         return new SqlSessionTemplate(sqlSessionFactory);
24.     }
25. }

复制代码

配置第二个数据源 DataSource2Config

1. @Configuration
2. @MapperScan(basePackages = "com.zhanfu.springboot.demo.mapper2", sqlSessionFactoryRef = "sqlSessionFactory2")
3. public class DataSource2Config {
4.     @Bean
5.     @ConfigurationProperties(prefix = "spring.datasource2")
6.     public DataSource dataSource2() {
7.         return DataSourceBuilder.create().build();
8.     }
10.     @Bean
11.     public SqlSessionFactory sqlSessionFactory2() throws Exception {
12.         SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
13.         sessionFactoryBean.setDataSource(dataSource2());
14.         String locationPattern = "classpath*:/mapper2/*.xml";
15.         PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
16.         sessionFactoryBean.setMapperLocations(resolver.getResources(locationPattern));
17.         return sessionFactoryBean.getObject();
18.     }
20.     @Bean(name = "sqlSessionTemplate2")
21.     public SqlSessionTemplate sqlSessionTemplate2(@Qualifier("sqlSessionFactory2") SqlSessionFactory sqlSessionFactory) {
22.         return new SqlSessionTemplate(sqlSessionFactory);
23.     }
25.     @Bean(name = "productMapper")
26.     public ProductMapper mapper2(@Qualifier("sqlSessionTemplate2") SqlSessionTemplate sqlSessionTemplate) throws Exception {
27.         return sqlSessionTemplate.getMapper(ProductMapper.class);
28.     }
29. }

复制代码

4. 事务管理器

为两个数据源分别配置自己的事务管理器，如果你的项目里通篇没有方法级别的事务（一个SQL就是一个事务），那不设置这个也不影响，否则还是建议加上。

1. @Configuration
2. public class TransactionManagerConfig {
4.     @Autowired
5.     private DataSource dataSource1;
7.     @Autowired
8.     private DataSource dataSource2;
10.     @Bean
11.     public PlatformTransactionManager txManager1() {
12.         return new DataSourceTransactionManager(dataSource1);
13.     }
15.     @Bean
16.     public PlatformTransactionManager txManager2() {
17.         return new DataSourceTransactionManager(dataSource2);
18.     }
19. }

复制代码

四、验证

我们把两张表拆进两个库中，以两个库模拟两个数据源，使得程序可以同时连接两个库

浏览器输入 http://127.0.0.1:8080/user/findall 查询接口成功

再在浏览器输入 http://127.0.0.1:8080/product/findall 查询第二个库的数据亦成功返回

这样我们就完成了一个工程同时连接两个数据源。
 总结

经过上述的操作，我们已经成功把项目对接了多数据源。当然，方案肯定不止这一种，后续围绕该问题，我们还会讲解其他方式。但不论是什么方式，主旨都是加深大家对SpringBoot 和 Mybatis的理解，我们曾经梳理过全流程，但只是蜻蜓点水带大家看一遍大体轮廓，并不足以让你精通，后面本专栏将继续深入讲解。
点击关注，第一时间了解华为云新鲜技术~
 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！