SpringBoot采用Dynamic-Datasource方式实现多JDBC数据源

更新时间：2023年10月09日 15:27:29 作者：Bulut0907

在某些情况下,如果我们需要配置多个数据源,本文主要介绍了SpringBoot采用Dynamic-Datasource方式实现多JDBC数据源,具有一定的参考价值,感兴趣的可以了解一下

1.1 特性

提供本地多数据源事务方案。由AOP实现
支持数据源分组，适用于多种场景，如多库读写分离、一主多从(实现了数据库负载均衡算法)、混合模式
提供自定义数据源来源方案(如全从数据库加载)
提供项目启动后动态增加移除数据源方案
支持数据库敏感配置信息加密(可自定义)ENC()
支持每个数据库独立初始化表结构schema和数据库database
支持无数据源启动，支持懒加载数据源(需要的时候再创建连接)
支持自定义注解，需继承DS(3.2.0+)
提供并简化对Druid、HikariCp、BeeCp、Dbcp2的快速集成
提供对Mybatis-Plus、Quartz、ShardingJdbc、P6sy、Jndi等组件的集成方案
提供Mybatis环境下的纯读写分离方案
提供使用spel动态参数解析数据源方案。内置spel、session、header，支持自定义
支持多层数据源嵌套切换。(ServiceA >>> ServiceB >>> ServiceC)
支持Seata分布式事务

1.2 Mysql数据准备

分别创建read_db.user和write_db.user，并向read_db.user写入数据

mysql> create database read_db;
Query OK, 1 row affected (0.14 sec)
mysql> create database write_db;
Query OK, 1 row affected (0.01 sec)
mysql> create table read_db.user (
    -> id bigint(20) auto_increment not null comment '主键ID',
    -> name varchar(30) null default null comment '姓名',
    -> primary key (id)
    -> );
Query OK, 0 rows affected, 1 warning (0.29 sec)
mysql> 
mysql> insert into read_db.user (id, name) values
    -> (1, 'read_name1'),
    -> (2, 'read_name2'),
    -> (3, 'read_name3'),
    -> (4, 'read_name4'),
    -> (5, 'read_name5');
Query OK, 5 rows affected (0.16 sec)
Records: 5  Duplicates: 0  Warnings: 0
mysql> 
mysql> create table write_db.user (
    -> id bigint(20) auto_increment not null comment '主键ID',
    -> name varchar(30) null default null comment '姓名',
    -> primary key (id)
    -> );
Query OK, 0 rows affected, 1 warning (0.04 sec)
mysql>

2.2 通过Dynamic-Datasource实现多JDBC数据源

2.2.1 pom.xml依赖

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.31</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.15</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>3.5.2</version>
        </dependency>

可以看到自动添加了spring-boot-starter-jdbc、spring-boot-starter-aop依赖

dynamic-datasource-spring-boot-starter

2.2.2 application.properties配置

通过dynamic方式，指定了datasource1和datasource2两个DataSource

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
# 设置默认的数据源。默认是master
spring.datasource.dynamic.primary=datasource1
# 严格匹配数据源, 默认false。true表示未匹配到指定数据源时抛异常, false表示使用默认数据源
spring.datasource.dynamic.strict=true
# 用于读的数据库
spring.datasource.dynamic.datasource.datasource1.url=jdbc:mysql://192.168.28.12:3306/read_db
spring.datasource.dynamic.datasource.datasource1.username=root
spring.datasource.dynamic.datasource.datasource1.password=Root_123
spring.datasource.dynamic.datasource.datasource1.driver-class-name=com.mysql.cj.jdbc.Driver
# 用于写的数据库
spring.datasource.dynamic.datasource.datasource2.url=jdbc:mysql://192.168.28.12:3306/write_db
spring.datasource.dynamic.datasource.datasource2.username=root
spring.datasource.dynamic.datasource.datasource2.password=Root_123
spring.datasource.dynamic.datasource.datasource2.driver-class-name=com.mysql.cj.jdbc.Driver

2.2.3 使用@DS注解选择DataSource

可以在Service的类或方法上(优先级更高)使用@DS注解选择DataSource

2.2.4 使用@Transactional + @DSTransactional实现事务

可以在Service的类或方法上(优先级更高)使用@Transactional实现事务。对异常的捕获后，通过 TransactionAspectSupport.currentTransactionStatus().setRollbackOnly() 进行手动回滚

@Transactional注解会让@DS的多数据源切换失效，虽然可以通过 @Transactional(propagation = Propagation.REQUIRES_NEW) 开启一个内部子事务来使@DS切换数据源，但是大部分场景不适用

@DSTransactional能和@DS多数据源切换配合使用，@DSTransactional注解最好使用在方法上(类似好像不生效)，@DSTransactional注解不能对异常进行捕获手动回滚，只能自动回滚然后抛出异常

2.3 动态数据源测试

2.3.1 创建User类

package com.hh.springboottest.myController;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
@NoArgsConstructor
@AllArgsConstructor
@Data
@ToString
public class User {
    private Long id;
    private String name;
}

2.3.2 Mapper接口实现

package com.hh.springboottest.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.hh.springboottest.myController.User;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface UserMapper extends BaseMapper<User> {
}

2.3.3 Service实现

Service接口实现

package com.hh.springboottest.service;
import com.hh.springboottest.myController.User;
public interface UserService {
    public User getUser(Long id);
    public void saveMultiUser();
}

ServiceImpl实现类。说明如下：

@DS(“datasource1”)注解，让userMapper.selectById使用了datasource1数据源
@DS(“datasource2”)注解，让userMapper.insert使用了datasource2数据源
@Transactional注解，当userMapper.insert(user1)执行成功，userMapper.insert(user2)执行失败，会回滚userMapper.insert(user1)的操作

package com.hh.springboottest.service.impl;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.hh.springboottest.mapper.UserMapper;
import com.hh.springboottest.myController.User;
import com.hh.springboottest.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Service
public class UserServiceImpl implements UserService {
    @Autowired
    UserMapper userMapper;
    @DS("datasource1")
    @Override
    public User getUser(Long id) {
        return userMapper.selectById(id);
    }
    @Transactional
    @DS("datasource2")
    @Override
    public void saveMultiUser() {
        User user2 = new User(2L, "write_name2");
        userMapper.insert(user2);
        User user3 = new User(3L, "write_name3");
        userMapper.insert(user3);
    }
}

2.3.4 测试

package com.hh.springboottest;
import com.hh.springboottest.myController.User;
import com.hh.springboottest.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@Slf4j
@SpringBootTest
public class MyApplicationTest {
    @Autowired
    UserService userService;
    @Test
    public void dynamicDataSourceTest() {
        User user = userService.getUser(1L);
        log.info("获取到的用户为：{}", user);
        userService.saveMultiUser();
    }
}

运行程序，结果如下：

2022-11-24 09:16:15.733 INFO 33760 --- [ main] com.hh.springboottest.MyApplicationTest : 获取到的用户为：User(id=1, name=read_name1)
2022-11-24 09:16:15.857 INFO 33760 --- [ionShutdownHook] c.b.d.d.DynamicRoutingDataSource : dynamic-datasource start closing ....
2022-11-24 09:16:15.861 INFO 33760 --- [ionShutdownHook] com.alibaba.druid.pool.DruidDataSource : {dataSource-1} closing ...
2022-11-24 09:16:15.866 INFO 33760 --- [ionShutdownHook] com.alibaba.druid.pool.DruidDataSource : {dataSource-1} closed
2022-11-24 09:16:15.866 INFO 33760 --- [ionShutdownHook] com.alibaba.druid.pool.DruidDataSource : {dataSource-2} closing ...
2022-11-24 09:16:15.867 INFO 33760 --- [ionShutdownHook] com.alibaba.druid.pool.DruidDataSource : {dataSource-2} closed
2022-11-24 09:16:15.867 INFO 33760 --- [ionShutdownHook] c.b.d.d.DynamicRoutingDataSource : dynamic-datasource all closed success,bye

同时查看write_db.user表，数据如下：

mysql> select * from write_db.user;
+----+--------------+
| id | name         |
+----+--------------+
|  1 | write_name1  |
|  2 | write_name2  |
|  3 | write_name3  |
+----+--------------+
3 rows in set (0.11 sec)
mysql>

2.4 removeDataSource删除DataSource

通过DynamicRoutingDataSource的removeDataSource方法删除DataSource

package com.hh.springboottest.service.impl;
import com.baomidou.dynamic.datasource.DynamicRoutingDataSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import javax.sql.DataSource;
@Service
public class DataSourceServiceImpl implements DataSourceService {
    @Autowired
    DataSource dataSource;
    public void removeDataSource(String dataSourceName) {
        DynamicRoutingDataSource dynamicRoutingDataSource =
                (DynamicRoutingDataSource) dataSource;
        dynamicRoutingDataSource.removeDataSource(dataSourceName);
    }
}

到此这篇关于SpringBoot采用Dynamic-Datasource方式实现多JDBC数据源的文章就介绍到这了,更多相关SpringBoot Dynamic-Datasource JDBC数据源内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java如何判断一个空对象的常见方法
在Java中判断对象是否为空是一项重要的编程技巧,可以有效防止空指针异常的发生,下面这篇文章主要给大家介绍了关于利用Java如何判断一个空对象的相关资料,需要的朋友可以参考下
2024-01-01
idea中springboot项目连接数据库报错的原因解析
这篇文章主要介绍了idea中springboot项目连接数据库报错的原因解析,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12
Spring Cloud Gateway 如何修改HTTP响应信息
这篇文章主要介绍了Spring Cloud Gateway 修改HTTP响应信息的方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
Java多线程编程中使用Condition类操作锁的方法详解
Condition是java.util.concurrent.locks包下的类,提供了对线程锁的更精细的控制方法,下面我们就来看一下Java多线程编程中使用Condition类操作锁的方法详解
2016-07-07
Java SpringBoot自动配置原理详情
这篇文章主要介绍了Java SpringBoot自动配置原理详情，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的朋友可以参考一下
2022-07-07
springboot中EasyPoi实现自动新增序号的方法
本文主要介绍了EasyPoi实现自动新增序号，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-09-09
在Java8中构建Stream流的多种方式详解
当我们处理集合数据时,往往需要对其进行各种操作,如过滤、映射、排序、归约等,在 Java 8 中引入的 Stream 流为我们提供了一种更加简洁和灵活的方式来处理数据,本文将介绍如何基于 Stream 构建流,为你展示创建和操作流的多种方法
2023-08-08
Java中的StringJoiner类使用示例深入详解
这篇文章主要为大家介绍了Java中的StringJoiner类使用示例深入详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-09-09
Spring Boot 定义系统启动任务的多种方式
这篇文章主要介绍了Spring Boot 定义系统启动任务的多种方式，看看你都会哪几种 ,感兴趣的朋友跟随小编一起看看吧
2019-04-04
MyBatis实现动态SQL的实现方法
这篇文章主要介绍了MyBatis实现动态SQL的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-12-12