多数据源切换(一)

已于 2023-03-13 10:17:54 修改
阅读量1k 收藏 3
点赞数
分类专栏： # Spring编程实践 文章标签： spring boot java
于 2023-03-12 23:30:55 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_49604576/article/details/129447401
版权

多数据源切换(一)

业务背景

​ 当前SpringBoot应用(SpringBoot + Mybatis)需要连接使用两个数据库源，其中一个是master数据源，另一个是external数据源，在应用中需要实现两个数据源的切换。

功能实现方案

​ 一种方案是在指定文件夹下使用指定数据源:使用Mybatis的 SqlSessionFactory 注入指定数据源，这样在使用指定文件夹下面的Mapper.xml时会切换为指定数据源，就完成了多数据源的切换。

​ 另一种方案是自定义注解:根据自定义注解上的value使用对应的数据源，使用AOP动态的切换当前使用的数据源。

​ 本文介绍实现的就是第二种方案：AOP + 自定义注解实现数据源动态切换

功能实现思路

​ 首先了解Spring对于数据库动态切换提供了哪些支持，通过搜索很容易了解到Spring提供AbstractRoutingDataSource类来实现数据源的动态切换。下面是官方对于AbstractRoutingDataSource的说明：

​ 根据各种数据源的lookup key调用指定数据源，look key通常(但不是必须)通过一些线程绑定的事务上下文来确定。在这里插入图片描述

​ 这样就可以根据实现AbstractRoutingDataSource这个虚拟类：设置当前线程中的look key来实现切换数据源。

功能实现

创建数据库及表结构

​ 创建两个数据库 master_db 和 external_db ，分别在两个数据库中创建表t_master_user和t_external_user，建表语句如下：

CREATE TABLE `t_master_user` (
  `id` bigint NOT NULL COMMENT '主键',
  `name` varchar(50) DEFAULT NULL COMMENT '姓名',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB;

CREATE TABLE `t_external_user` (
  `id` bigint NOT NULL COMMENT '主键',
  `name` varchar(50) DEFAULT NULL COMMENT '姓名',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB;

切换数据源代码

  1. 设置当前线程的数据源上下文，动态切换数据源

    package com.zhjw.config.db;

import lombok.extern.slf4j.Slf4j;

import java.util.Stack;

/**
 * Created by zhjw on 2023/3/6
 * <p>
 * 设置当前线程的数据源上下文，动态切换数据源
 * <p>
 * {@link DynamicRoutingDataSource} 实现Spring的AbstractRoutingDataSource接口，设置当前线程使用的数据源
 *
 * @author zhjw
 * @date 2023/3/6
 */
@Slf4j
public class DataSourceContextHolderWrapper {

    /**
     * 默认数据源
     */
    public static final String DEFAULT_DS = "master";

    private static final ThreadLocal<Stack<String>> contextHolder = new ThreadLocal<>();

    /**
     * 设置数据源名
     *
     * @param dbType DB名
     */
    public static void setDB(String dbType) {
        if (contextHolder.get() == null) {
            contextHolder.set(new Stack<>());
        }
        contextHolder.get().push(dbType);
        log.debug("Set db to {}", dbType);
    }

    /**
     * 获取数据源名
     *
     * @return DB名
     */
    public static String getDB() {
        if (contextHolder.get() != null && !contextHolder.get().empty()) {
            log.debug("Get db as {}", contextHolder.get().peek());
            return contextHolder.get().peek();
        }
        return DEFAULT_DS;
    }

    /**
     * 清除数据源名
     */
    public static void clearDB() {
        if (contextHolder.get() != null && !contextHolder.get().empty()) {
            log.debug("Pop db {}", contextHolder.get().pop());
        }
        if (contextHolder.get() != null && contextHolder.get().empty()) {
            contextHolder.remove();
        }
    }

}
    1. 实现Spring的AbstractRoutingDataSource接口，设置当前线程使用的数据源
    package com.zhjw.config.db;

import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;

/**
 * Created by zhjw on 2023/3/6
 * <p>
 * 实现Spring的AbstractRoutingDataSource接口，设置当前线程使用的数据源
 * </p>
 *
 * @author zhjw
 * @date 2023/3/6
 */
public class DynamicRoutingDataSource extends AbstractRoutingDataSource {

    @Override
    protected Object determineCurrentLookupKey() {
        return DataSourceContextHolderWrapper.getDB();
    }
}

  2. 读取多数据源配置并封装为Bean

    package com.zhjw.config.db;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.pool.DruidDataSourceFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.context.annotation.PropertySource;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.util.CollectionUtils;

import javax.annotation.Resource;
import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

/**
 * Created by zhjw on 2023/3/6
 * <p>
 * 多数据源配置类
 * </p>
 *
 * @author zhjw
 * @date 2023/3/6
 */
@Slf4j
@Configuration
@PropertySource(value = "classpath:application.properties")
public class MultipleDataSourceConfig {

    /**
     * 读取properties配的数据源信息
     *
     * @return
     */
    @Bean("dataSourcePropertiesMap")
    @ConfigurationProperties(prefix = "spring.datasource")
    public Map<String, Properties> dataSourcePropertiesMap() {
        return new HashMap(8);
    }

    /**
     * 读取properties配的数据源信息，装配为Bean
     *
     * @param dataSourcePropertiesMap 读取properties配的数据源信息
     */
    @Bean("dataSourceBeanMap")
    public Map dataSourceBeanMap(@Qualifier("dataSourcePropertiesMap") Map<String, Properties> dataSourcePropertiesMap) throws Exception {
        Map dataSourceBeanMap = new HashMap(8);
        if (CollectionUtils.isEmpty(dataSourcePropertiesMap)) {
            return dataSourceBeanMap;
        }

        //Properties装配Bean
        for (String key : dataSourcePropertiesMap.keySet()) {
            Properties properties = dataSourcePropertiesMap.get(key);
            DruidDataSource druidDataSource = new DruidDataSource();
            DruidDataSourceFactory.config(druidDataSource,properties);
            dataSourceBeanMap.put(key, druidDataSource);
        }

        return dataSourceBeanMap;
    }


    @Resource
    private Map dataSourceBeanMap;

    /**
     * 动态数据源: 通过AOP在不同数据源之间动态切换
     *
     * @return 数据源
     */
    @Primary
    @Bean(name = "dynamicRoutingDataSource")
    public DataSource dynamicRoutingDataSource() {
        //实现Spring的AbstractRoutingDataSource接口，设置当前线程使用的数据源
        DynamicRoutingDataSource dynamicRoutingDataSource = new DynamicRoutingDataSource();

        // 默认数据源:不指定使用数据源，则使用默认数据源
        if (dataSourceBeanMap.get(DataSourceContextHolderWrapper.DEFAULT_DS) == null) {
            throw new IllegalArgumentException("Multiple datasource must define default master datasource!");
        }
        dynamicRoutingDataSource.setDefaultTargetDataSource(dataSourceBeanMap.get(DataSourceContextHolderWrapper.DEFAULT_DS));

        // 配置多数据源
        dynamicRoutingDataSource.setTargetDataSources(dataSourceBeanMap);
        return dynamicRoutingDataSource;
    }


    /**
     * 配置@Transactional注解事务
     *
     * @return 平台事务管理器
     */
    @Bean
    public PlatformTransactionManager transactionManager() {
        return new DataSourceTransactionManager(dynamicRoutingDataSource());
    }


}

  3. 自定义切换数据库注解@DS

    package com.zhjw.annotation;


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by zhjw on 2023/3/6
 * <p>
 * 切换数据库注解
 * </p>
 *
 * @author zhjw
 * @date 2023/3/6
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface DS {

    /**
     * 数据库名称
     */
    String value() default "master";
}

  4. 实现@DS注解切面(这里添加**@Order**注解为下一节内容)

    package com.zhjw.aspect;

import com.zhjw.annotation.DS;
import com.zhjw.config.db.DataSourceContextHolderWrapper;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.annotation.Order;
import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

/**
 * Created by zhjw on 2023/3/6
 *
 * 实现@DS注解切面
 *
 * <p>
 * 提升该切面实例化的优先级是为了不影响@Transactional注解生效：
 * 不指定优先级的话{@link AbstractRoutingDataSource#determineTargetDataSource()}方法执行在本切面之前
 * 在{@link AbstractRoutingDataSource#determineTargetDataSource()}方法的194行
 * 会导致该事务一直使用默认的datasource，而不会切换
 * </p>
 *
 * @author zhjw
 * @date 2023/3/6
 */
@Component
@Aspect
@Slf4j
//@Order(100)
public class DynamicDataSourceAspect {

    /**
     * 加载数据源的切入点
     */
    @Pointcut("@annotation(com.zhjw.annotation.DS) || @within(com.zhjw.annotation.DS)")
    public void pointCut() {
    }

    /**
     * 加载当前线程使用数据源
     *
     * @param point
     */
    @Before("pointCut()")
    public void beforeSwitchDS(JoinPoint point) {
        //获得当前访问的class
        Class<?> clazz = point.getTarget().getClass();
        //获得访问的方法名
        String methodName = point.getSignature().getName();
        //得到方法的参数的类型
        Class[] argClass = ((MethodSignature) point.getSignature()).getParameterTypes();


        String dataSource = DataSourceContextHolderWrapper.DEFAULT_DS;
        try {
            // 得到访问的方法对象
            Method method = clazz.getMethod(methodName, argClass);

            // 就近原则:方法上注解大于类上注解
            /** 判断类上是否存在@DS注解 **/
            if (clazz.isAnnotationPresent(DS.class)) {
                DS annotation = clazz.getAnnotation(DS.class);
                // 取出注解中的数据源名
                dataSource = annotation.value();
            }
            /**判断方法上是否存在@DS注解 **/
            if (method.isAnnotationPresent(DS.class)) {
                DS annotation = method.getAnnotation(DS.class);
                // 取出注解中的数据源名
                dataSource = annotation.value();
            }
        } catch (Exception e) {
            log.error("@DS AOP failed to dynamic data source ,cause by :{}", e);
        }

        // 切换数据源
        DataSourceContextHolderWrapper.setDB(dataSource);
    }

    /**
     * 清除当前线程使用数据源
     *
     * @param point
     */
    @After("pointCut()")
    public void afterSwitchDS(JoinPoint point) {
        DataSourceContextHolderWrapper.clearDB();
    }

}

业务数据测试代码

  1. application.properties配置内容如下：

    #端口号
server.port=8080

spring.datasource.master.url=jdbc:mysql://127.0.0.1:3306/master_db?autoReconnect=true&useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=Asia/Shanghai
spring.datasource.master.username=root
spring.datasource.master.password=123456

spring.datasource.external.url=jdbc:mysql://127.0.0.1:3306/external_db?autoReconnect=true&useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=Asia/Shanghai
spring.datasource.external.username=root
spring.datasource.external.password=123456

#mybatis 配置
mybatis.mapper-locations=classpath:mybatis/*/*.xml
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

  2. SpringBoot启动类添加==(exclude = DataSourceAutoConfiguration.class)==，去除自动配置信息
    在这里插入图片描述

  3. 在需要切换数据源的ServiceImpl类 或者 方法上加上@DS自定义注解，以及对应的数据库信息
    在这里插入图片描述

详细的业务测试代码已上传到我的Gitee上，如对您有帮助还请给项目一个Star，十分感谢！

调取localhost:8080//insert/union 接口

在这里插入图片描述

查看结果
在这里插入图片描述

切换数据源代码封装为boot-start的jar包

​ 为了代码的复用性，将切换数据源代码封装为boot-start的jar包，其他项目使用时，直接引入jar包

 <dependency>
      <groupId>com.zhjw</groupId>
      <artifactId>multiple-datasource-spring-boot-starter</artifactId>
      <version>1.0.0</version>
</dependency>

思考题？

​ 假如在externalServiceImpl#insert方法上加上@Transactional 事务注解，则无法切换数据源，只会使用主数据源，如下图所示：
在这里插入图片描述

探究原因及解决方案在：
多数据源切换(二)

weixin_49604576
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring动态切换多数据源Demo
02-03
请自行修改com/resources/datasource.properties中数据库配置，Demo中配置的两个数据源，一个是Mysql，一个是Oracle。 运行之前请自行建立数据库的表。
SpringBoot多数据源切换.zip
11-24
SpringBoot多数据源切换.zip
springboot动态多数据源切换，解决多数据源事务问题
qq1010830256的博客
06-11 4083
文章目录1.业务场景2.主要思路3.核心抽象类AbstractRoutingDataSource分析4.开始编码5.踩坑A类坑B类坑B类解决方案 1.业务场景 通过分库实现不同租户的业务数据隔离，在笔者的公司是一个集团数据库作为一个master库，集团拥有众多的分公司，每一个分公司都有一个slave库，从而做到集团的数据和各个分公司的数据库的数据隔离 2.主要思路 项目默认使用加载集团master库（库中包含子公司信息表,存储了每一个分公司数据库的连接信息）来启动项目 监听项目的启动，当项目启动时，读取m
spring boot多数据源动态切换, 多数据源事务管理
bigNoseCat的博客
06-09 5886
1 . 项目目标 实现 不同数据源的切换 (使用AbstractRoutingDataSource) 不同数据源之间,事物管理,多个数据源之间同时commit或者同时rollback 兼容不同的连接池(dbpc,druid) 兼容mybatis,JPA 等不同的方式 (spring- boot -starter) 以上就是该项目实现的所有功能,因代码量和篇幅...
Java实战：Spring Boot 实现动态数据源切换
最新发布
oandy0的博客
02-28 894
本文将介绍如何在 Spring Boot 应用中实现动态数据源切换，包括具体实现步骤和示例代码。通过本文的学习，你将能够轻松应对多种数据源切换的场景，提高应用程序的灵活性和可扩展性。
【Mysql】动态数据源切换和分布式事务
qq_31665011的博客
07-17 1030
一、动态数据源切换 再谈到动态数据源切换之前，我们先看一下常规的单数据库连接池（数据源）的配置过程，我们以Hikari连接池（Hikari官网-高效连接池）和Mybatis框架为例说明。 ①Spring Mybatis Hikari datasource 配置 @Bean(name = "userReadHikariConfig") public HikariCo...
SpringBoot——动态数据源（多数据源自动切换）
quanzhan_King的博客
06-13 1万+
日常的业务开发项目中只会配置一套数据源，如果需要获取其他系统的数据往往是通过调用接口， 或者是通过第三方工具比如kettle将数据同步到自己的数据库中进行访问。但是也会有需要在项目中引用多数据源的场景。自研数据迁移系统，至少需要新、老两套数据源，从老库读取数据写入新库自研读写分离中间件，系统流量增加，单库响应效率降低，引入读写分离方案，写入数据是一个数据源，读取数据是另一个数据源。
spring整合mybatis动态切换数据源+事务管理
qq_42160456的博客
11-09 1451
*公司因为业务需要，需要把同一份服务的数据根据不同标识分别存放到两个数据库中（数据结构一样），刚开始为了尽快满足需求，使用了个简版（代码切换数据源），闲下来以后实在觉得太low，查看了一些demo以后，整理出来了适合自己项目的配置。话不多说，上步骤。* ...
【数据库与事务系列】多数据源切换
qq_35789269的博客
12-03 3177
多数据源
springboot整合多数据源的配置以及动态切换数据源，注解切换数据源
热门推荐
todoitbo的博客
05-22 9万+
springboot整合多数据源的配置以及动态切换数据源，注解切换数据源
动态切换数据源
qq_47142993的博客
05-23 2630
思路 自定义一个注解 @DataSource，将来可以将该注解加在 service 层方法或者类上面，表示方法或者类中的所有方法都使用某一个数据源。 对于第一步，如果某个方法上面有 @DataSource 注解，那么就将该方法需要使用的数据源名称存入到 ThreadLocal。 自定义切面，在切面中解析 @DataSource 注解，当一个方法或者类上面有 @DataSource 注解的时候，将 @DataSource 注解所标记的数据源存入到 ThreadLocal 中。 最后，当 Mapper 执行的
springboot，多数据源切换
zifengye520的专栏
07-23 1207
需求介绍：要求做一个平台，有其他第三方系统接入；每个系统有自己的数据源配置，通过调用平台接口，实现将数据保存到第三方自己的数据库中；实现过程：1.在平台项目运行时，通过接口获取每个第三方系统的数据源；以key-value的形式保存到全局变量中；2.在调用接口的时候，会通过拦截器获取到每个请求中的第三方系统标识；3.根据标识来切换对应的数据源。
多数据源切换
weixin_43189971的博客
07-15 967
多写几遍吧
SpringBoot配置多数据源实现动态切换数据源
06-29
通过简单的demo实现SpingBoot多数据源配置并动态切换多数据源
Spring配置多数据源切换
08-26
今天小编就为大家分享一篇关于Spring配置多数据源切换，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
动态切换多数据源
10-28
javaWeb 多数据源demo
spring配置多数据源及使用AOP加注解实现数据源动态切换和事务管理
wkNote
07-19 4759
spring配置多数据源及使用AOP加注解实现数据源动态切换 这里使用的是springboot，使用上和spring没区别 多数据源配置 首先在配置文件中定义多数据源的url、uername等信息。 #db1数据源 #使用p6spy打印sql db1.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver db1....
Spring Boot 如何动态切换多数据源？
程序猿DD
06-09 3420
大约在19年的这个时候，老同事公司在做医疗系统，需要和HIS系统对接一些信息，比如患者、医护、医嘱、科室等信息。但是起初并不知道如何与HIS无缝对接，于是向我取经。最终经过讨论采用了视图对接的方式，大致就是HIS系统提供视图，他们进行对接。写这篇文章的目的这篇文章将会涉及到Spring Boot 与Mybatis、数据库整合什么是多数据源？最常见的单一应用中最多涉及到一个...
Spring Boot 动态数据源（Spring 注解数据源）
weixin_34216196的博客
03-17 398
本文实现案例场景：某系统除了需要从自己的主要数据库上读取和管理数据外，还有一部分业务涉及到其他多个数据库，要求可以在任何方法上可以灵活指定具体要操作的数据库。 为了在开发中以最简单的方法使用，本文基于注解和AOP的方法实现，在spring boot框架的项目中，添加本文实现的代码类后，只需要配置好数据源就可以直接通过注解使用，简单方便。 一配置二使用1....
druid多数据源切换
07-28
在使用Druid进行多数据源切换时，你可以按照以下步骤进行操作： 1. 配置多个数据源：在Druid的配置文件中，可以添加多个数据源的配置信息，每个数据源需要指定其唯一的名称、连接URL、用户名、密码等信息。 2. ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值