0
0

SpringBoot通过自定义注解实现多数据源

公众号封面

✅作者简介：大家好，我是Leo，热爱Java后端开发者，一个想要与大家共同进步的男人😉😉
🍎个人主页：Leo的博客
💞当前专栏： Java从入门到精通
✨特色专栏： MySQL学习
🥭本文内容：SpringBoot通过自定义注解实现多数据源
📚个人知识库： Leo知识库，欢迎大家访问

1.前言☕

大家好，我是Leo哥🫣🫣🫣，今天继续带来一篇关于SpringBoot实现多数据源的实战案例。好了，话不多说让我们开始吧😎😎😎。

2.概述

在实际开发中，我们往往面临一个应用需要访问多个数据库的情况。例如下面两种场景。

  • 业务复杂： 数据分布在不同的数据库，数据库拆了，应用没拆，一个公司有多个子项目，各用各的数据库。
  • 读写分离： 为了解决数据库的读性能瓶颈（读比写性能更高，写锁会影响读阻塞，从而影响读的性能）很多数据库拥有主从架构，也就是说，一台 主数据库服务器，是对外提供增删改查业务的生产服务器；另一台从数据库服务器，主要进行读的操作。读写分离：解决高并发下读写受影响。数据更新在主库上进行，主库将数据变更信息同步给从库。在查询时，在从库上进行，从而分担主库的压力。

我们可以在代码层面解决这种动态数据源切换的问题，而不需要使用 mycat、shardingJDBC 等其他中间件。本文将主要以自定义注解 + 继承 

AbstractRoutingDataSource

实现读写分离。

3.如何实现多数据源

在 SpringBoot 项目中实现读写分离通常需要以下几步：

  1. 配置数据源：你需要为读操作和写操作分别配置一个数据源。
  2. 创建数据源路由逻辑：这通常通过扩展 Spring 的 AbstractRoutingDataSource 来实现。它允许你根据一定的逻辑来决定使用哪个数据源（读或写）。
  3. 配置事务管理器：这使得你能够在使用不同数据源时保持事务的一致性。
  4. 服务层或DAO层设计：确保在执行读操作时使用读数据源，在执行写操作时使用写数据源。
  5. 自定义切面，在切面中解析 @DataSource 注解。当一个方法或者类上面，有 @DataSource 注解的时候，将 @DataSource 注解所标记的数据源列出来存入到 ThreadLocal 中。

注意：这里使用ThreadLocal的原因是为了保证我们的线程安全。

4.案例实现

接下来我们就按照以上步骤进行编码实现。

4.1 创建新模块

首先我们创建一个新的模块命名为：springboot-dynamic-source

image-20240102183810902

1.导入依赖
<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId></dependency><dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId></dependency><dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-starter</artifactId></dependency><!--mybatis plus--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-jdbc</artifactId></dependency></dependencies>
2.创建yml配置文件
server:port:8007spring:application:name:  dynamic-source
  jackson:date-format: yyyy-MM-dd HH:mm:ss
    time-zone: GMT+8
  datasource:type: com.alibaba.druid.pool.DruidDataSource
    driverClassName: com.mysql.cj.jdbc.Driver
    ds:# 主库数据源master:url: jdbc:mysql://localhost:3307/test01?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8username: root
        password: root
      # 从库数据源slave:url: jdbc:mysql://localhost:3307/test02?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8username: root
        password: root
    # 初始连接数initialSize:5# 最小连接池数量minIdle:10# 最大连接池数量maxActive:20# 配置获取连接等待超时的时间maxWait:60000# 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒timeBetweenEvictionRunsMillis:60000# 配置一个连接在池中最小生存的时间，单位是毫秒minEvictableIdleTimeMillis:300000# 配置一个连接在池中最大生存的时间，单位是毫秒maxEvictableIdleTimeMillis:900000# 配置检测连接是否有效validationQuery: SELECT 1 FROM DUAL
    testWhileIdle:truetestOnBorrow:falsetestOnReturn:falsewebStatFilter:enabled:truestatViewServlet:enabled:true# 设置白名单，不填则允许所有访问allow:url-pattern: /druid/*
      # 控制台管理用户名和密码login-username: admin
      login-password:123456filter:stat:enabled:true# 慢SQL记录log-slow-sql:trueslow-sql-millis:1000merge-sql:truewall:config:multi-statement-allow:truelogging:level:org.javatop: debug
  pattern:dateformat: HH:mm:ss:SSS
  file:path:"logs/${spring.application.name}"

ds 中是我们的所有数据源。master 是默认的数据源，不可修改，其他的数据源可以修改并添加多个。

3.准备数据库

我这里需要提前准备两个数据库，一个是主数据库master，一个是从数据库slave。

我们会后面会通过一个自定义注解去实现动态切换数据库。

这里给出我们创建的一个user表的SQL语句。

CREATETABLE`user`(`id`intNOTNULLAUTO_INCREMENT,`username`varchar(50)DEFAULTNULL,`age`intDEFAULTNULL,PRIMARYKEY(`id`))ENGINE=InnoDBAUTO_INCREMENT=101DEFAULTCHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

4.2 加载数据源

我们可以通过@ConfigurationProperties 注解加载定义的配置文件。spring.datasource 对应的注解都会匹配到。

packageorg.javatop.dynamic.config;importcom.alibaba.druid.pool.DruidDataSource;importorg.springframework.boot.context.properties.ConfigurationProperties;importjavax.sql.DataSource;importjava.util.Map;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:10
 * @description :
 */@ConfigurationProperties(prefix ="spring.datasource")publicclassDruidProperties{privateString type;privateString driverClassName;privateMap<String,Map<String,String>> ds;privateInteger initialSize;privateInteger minIdle;privateInteger maxActive;privateInteger maxWait;/**
     *一会在外部构建好一个 DruidDataSource 对象，包含三个核心属性 url、username、password
     * 在这个方法中设置公共属性
     * @param druidDataSource
     * @return
     */publicDataSourcedataSource(DruidDataSource druidDataSource){
        druidDataSource.setInitialSize(initialSize);
        druidDataSource.setMinIdle(minIdle);
        druidDataSource.setMaxActive(maxActive);
        druidDataSource.setMaxWait(maxWait);return druidDataSource;}publicStringgetType(){return type;}publicvoidsetType(String type){this.type = type;}publicStringgetDriverClassName(){return driverClassName;}publicvoidsetDriverClassName(String driverClassName){this.driverClassName = driverClassName;}publicMap<String,Map<String,String>>getDs(){return ds;}publicvoidsetDs(Map<String,Map<String,String>> ds){this.ds = ds;}publicIntegergetInitialSize(){return initialSize;}publicvoidsetInitialSize(Integer initialSize){this.initialSize = initialSize;}publicIntegergetMinIdle(){return minIdle;}publicvoidsetMinIdle(Integer minIdle){this.minIdle = minIdle;}publicIntegergetMaxActive(){return maxActive;}publicvoidsetMaxActive(Integer maxActive){this.maxActive = maxActive;}publicIntegergetMaxWait(){return maxWait;}publicvoidsetMaxWait(Integer maxWait){this.maxWait = maxWait;}}

然后我们开始通过进行加载

DruidProperties

来加载数据源。

@EnableConfigurationProperties :这个注解的意思是使 ConfigurationProperties 注解生效。

packageorg.javatop.dynamic.config;importcom.alibaba.druid.pool.DruidDataSource;importcom.alibaba.druid.pool.DruidDataSourceFactory;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.boot.context.properties.EnableConfigurationProperties;importorg.springframework.stereotype.Component;importjavax.sql.DataSource;importjava.util.HashMap;importjava.util.Map;importjava.util.Set;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:12
 * @description : 加载数据源
 */@Component@EnableConfigurationProperties(DruidProperties.class)publicclassLoadDataSource{@AutowiredDruidProperties druidProperties;publicMap<String,DataSource>loadAllDataSource(){Map<String,DataSource> map =newHashMap<>();Map<String,Map<String,String>> ds = druidProperties.getDs();try{Set<String> keySet = ds.keySet();for(String key : keySet){
                map.put(key, druidProperties.dataSource((DruidDataSource)DruidDataSourceFactory.createDataSource(ds.get(key))));}}catch(Exception e){
            e.printStackTrace();}return map;}}

loadAllDataSource() 方法可以通过读取application.yml配置文件中所有数据源对象。(我们这里有一个master主数据库，和一个slave从数据库)

druidProperties.dataSource（DruidDataSource druidDataSource） 这个方法为每个数据源配置其他额外的属性（最大连接池等信息）。

**DruidDataSourceFactory.createDataSource(ds.get(key)**：创建一个数据源，赋予三个核心的属性。（username、url、password）

最终，所有的数据源都会存入map中。

4.3 自定义ThreadLocal工具类

我们这里定义一个简单的ThreadLocal工具类

packageorg.javatop.dynamic.utils;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:13
 * @description : ThreadLocal工具类
 */publicclassDynamicDataSourceUtil{privatestaticfinalThreadLocal<String>CONTEXT_HOLDER=newThreadLocal<>();publicstaticvoidsetDataSourceType(String dsType){CONTEXT_HOLDER.set(dsType);}publicstaticStringgetDataSourceType(){returnCONTEXT_HOLDER.get();}publicstaticvoidclear(){CONTEXT_HOLDER.remove();}}

4.4 自定义注解

首先需要通过一个枚举类来设定一下我们的默认数据源，也是是master主数据库。

packageorg.javatop.dynamic.constant;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:13
 * @description :
 */publicinterfaceDataSourceType{String default_ds_name ="master";}

然后自定义一个注解，后面也就是通过这个注解来动态的配置切换我们的数据源，这里就也叫Datasource吧。

packageorg.javatop.dynamic.annotation;importorg.javatop.dynamic.constant.DataSourceType;importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:14
 * @description :  这个注解将来可以加在某一个 service 类上或者方法上，通过 value 属性来指定类或者方法应该使用哪个数据源
 */@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD})public@interfaceDataSource{/**
     * 如果一个方法上加了 @DataSource 注解，但是却没有指定数据源的名称，那么默认使用 Master 数据源
     * @return
     */Stringvalue()defaultDataSourceType.default_ds_name;}

4.5 AOP解析自定义注解

packageorg.javatop.dynamic.annotation;importorg.aspectj.lang.ProceedingJoinPoint;importorg.aspectj.lang.annotation.Around;importorg.aspectj.lang.annotation.Aspect;importorg.aspectj.lang.annotation.Pointcut;importorg.aspectj.lang.reflect.MethodSignature;importorg.javatop.dynamic.utils.DynamicDataSourceUtil;importorg.springframework.core.annotation.AnnotationUtils;importorg.springframework.stereotype.Component;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:15
 * @description : AOP解析自定义注解
 */@Component@AspectpublicclassDataSourceAspect{/**
     * @annotation(org.javatop.dynamic.annotation.DataSource) 表示方法上有 @DataSource 注解 就将方法拦截下来。
     * @within :如果类上面有 @DataSource 注解，就将类中的方法拦截下来。
     */@Pointcut("@annotation(org.javatop.dynamic.annotation.DataSource) || "+"@within(org.javatop.dynamic.annotation.DataSource)")publicvoidpc(){}@Around("pc()")publicObjectaround(ProceedingJoinPoint point){//获取方法上面的注解DataSource dataSource =getDataSource(point);if(dataSource!=null){// 注解中数据源的名称String value = dataSource.value();DynamicDataSourceUtil.setDataSourceType(value);}try{return point.proceed();}catch(Throwable throwable){
            throwable.printStackTrace();}finally{DynamicDataSourceUtil.clear();}returnnull;}privateDataSourcegetDataSource(ProceedingJoinPoint point){/**
         * 先去查找方法上的注解，如果没有，再去类中找。
         */MethodSignature signature =(MethodSignature)point.getSignature();DataSource annotation =AnnotationUtils.findAnnotation(signature.getMethod(),DataSource.class);if(annotation!=null){return annotation;}returnAnnotationUtils.findAnnotation(signature.getDeclaringType(),DataSource.class);}}
@Pointcut 定义
@Pointcut("@annotation(org.javatop.dynamic.annotation.DataSource) || "+"@within(org.javatop.dynamic.annotation.DataSource)")publicvoidpc(){}
  • @Pointcut 是一个定义在方法上的注解，用来指定一个切点（即在何处进行拦截）。
  • "@annotation(org.javatop.dynamic.annotation.DataSource)" 表示拦截所有被 @DataSource 注解标记的方法。
  • "@within(org.javatop.dynamic.annotation.DataSource)" 表示拦截所有在类级别被 @DataSource 注解标记的类中的方法。
  • pc() 方法本身是空的，因为所有的逻辑都将在与这个切点相关的通知（advice）中定义。
@Around 通知
e@Around("pc()")publicObjectaround(ProceedingJoinPoint point){DataSource dataSource =getDataSource(point);if(dataSource !=null){String value = dataSource.value();DynamicDataSourceUtil.setDataSourceType(value);}try{return point.proceed();}catch(Throwable throwable){
        throwable.printStackTrace();}finally{DynamicDataSourceUtil.clear();}returnnull;}
  • @Around("pc()") 表示这是一个环绕通知，它会在 pc() 方法所定义的切点前后执行。
  • ProceedingJoinPoint point 是连接点的信息，它包含了方法的所有相关信息，如方法名、参数等。
  • getDataSource(point) 用来获取方法或类上的 @DataSource 注解。
  • 如果存在 @DataSource 注解，它会从注解中获取数据源的名称，并通过 DynamicDataSourceUtil.setDataSourceType(value) 设置当前线程的数据源。
  • point.proceed() 是调用原始方法的地方。
  • finally 块中的 DynamicDataSourceUtil.clear() 用于在方法执行完毕后清理数据源设置，确保不会影响其他的数据库操作。

最后获取@DataSource注解

4.6 自定义动态数据源

packageorg.javatop.dynamic.config;importorg.javatop.dynamic.constant.DataSourceType;importorg.javatop.dynamic.utils.DynamicDataSourceUtil;importorg.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;importorg.springframework.stereotype.Component;importjavax.sql.DataSource;importjava.util.HashMap;importjava.util.Map;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:18
 * @description : 定义动态数据源
 */@ComponentpublicclassDynamicDataSourceextendsAbstractRoutingDataSource{publicDynamicDataSource(LoadDataSource loadDataSource){// 1、设置所有的数据源Map<String,DataSource> stringDataSourceMap = loadDataSource.loadAllDataSource();super.setTargetDataSources(newHashMap<>(stringDataSourceMap));// 2、设置默认的数据源super.setDefaultTargetDataSource(stringDataSourceMap.get(DataSourceType.default_ds_name));super.afterPropertiesSet();}/**
     * 这个方法用来返回数据源名称，当系统需要获取数据源的时候，会自动调用该方法获取数据源的名称
     * @return
     */@OverrideprotectedObjectdetermineCurrentLookupKey(){returnDynamicDataSourceUtil.getDataSourceType();}}
  1. DynamicDataSource 类扩展自 AbstractRoutingDataSource 类，这是Spring框架提供的一个抽象类，用于实现数据源的动态路由。
  2. 构造函数 public DynamicDataSource(LoadDataSource loadDataSource) 接收一个 LoadDataSource 类型的参数。这个参数被用于加载所有的数据源配置。 - Map<String, DataSource> stringDataSourceMap = loadDataSource.loadAllDataSource(); 这行代码调用了 loadDataSource 的 loadAllDataSource 方法来加载所有数据源配置，并将其存储在一个名为 stringDataSourceMap 的Map中，其中键是数据源的名称，值是对应的 DataSource 对象。- super.setTargetDataSources(new HashMap<>(stringDataSourceMap)); 这行代码设置了目标数据源。它将前面加载的所有数据源 stringDataSourceMap 设置为目标数据源。- super.setDefaultTargetDataSource(stringDataSourceMap.get(DataSourceType.default_ds_name)); 这行代码设置了默认的数据源。它通过 DataSourceType.default_ds_name 从 stringDataSourceMap 中获取默认的数据源，并设置为默认数据源。- super.afterPropertiesSet(); 是一个初始化方法，确保所有属性都被正确设置。
  3. determineCurrentLookupKey() 方法是 AbstractRoutingDataSource 的一个抽象方法，必须要实现。这个方法用于决定使用哪个数据源，通常情况下是根据某种条件动态返回数据源名称。 - return DynamicDataSourceUtil.getDataSourceType(); 这行代码返回当前线程所使用的数据源的名称。DynamicDataSourceUtil 是一个工具类，可能提供了线程局部变量（ThreadLocal）来存储每个线程所选择的数据源名称。

这样，当应用程序需要与数据库进行交互时，就会通过 

DynamicDataSource

获取到当前线程所指定的数据源，并进行相应的数据库操作。这种方式能够在不同业务场景中灵活切换数据源，非常适合多租户、读写分离等复杂的数据库应用场景。

4.7 编写业务层

我们编写一个service层

packageorg.javatop.dynamic.service;importorg.javatop.dynamic.annotation.DataSource;importorg.javatop.dynamic.domain.User;importorg.javatop.dynamic.mapper.UserMapper;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.stereotype.Service;importjava.util.List;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:26
 * @description :
 */@ServicepublicclassUserService{@AutowiredprivateUserMapper userMapper;@DataSource("slave")//    @DataSourcepublicList<User>getAll(){List<User> all = userMapper.getAll();return all;}}

我们在getAll()方法上加上@DataSource(“slave”)，并指定slave从数据库。

然后再编写一个mapper，去操作数据库。

packageorg.javatop.dynamic.mapper;importorg.apache.ibatis.annotations.Mapper;importorg.apache.ibatis.annotations.Select;importorg.javatop.dynamic.domain.User;importjava.util.List;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:26
 * @description :
 */@MapperpublicinterfaceUserMapper{@Select("select * from user")List<User>getAll();}

4.8 测试

packageorg.javatop.dynamic;importorg.javatop.dynamic.domain.User;importorg.javatop.dynamic.service.UserService;importorg.junit.jupiter.api.Test;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.boot.test.context.SpringBootTest;importjava.util.List;/**
 * @author : Leo
 * @version 1.0
 * @date 2024-01-02 15:32
 * @description :
 */@SpringBootTestpublicclassDynamicTest{@AutowiredprivateUserService userService;/**
     *  用于测试:
     */@Testpublicvoidtest(){List<User> all = userService.getAll();if(all !=null){for(User user : all){System.out.println(user);}}}}

我们查看控制台。

image-20240102193458748

image-20240102193553638

可以看出来我们去查询的是test02库中的user数据。

大功告成!!!

5.总结🍭

以上便是本文的全部内容，本人才疏学浅，文章有什么错误的地方，欢迎大佬们批评指正！我是Leo，一个在互联网行业的小白，立志成为更好的自己。

如果你想了解更多关于Leo，可以关注公众号-程序员Leo，后面文章会首先同步至公众号。

公众号封面

标签： spring boot 后端 java
本文转载自: https://blog.csdn.net/qq_58608526/article/details/135348243
版权归原作者 LeoToJavaer 所有， 如有侵权，请联系我们删除。
登录后发布评论

“SpringBoot通过自定义注解实现多数据源”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

机器人技术在安全领域的重要作用

安全学习记录——网络篇（一）

图腾柱PFC：HP1010为您的电动两轮车之旅提供绿色，高效，安全的动力

单元测试数据库回滚问题

这才是单元测试，之前我们都错了

【C语言基础】：字符函数和字符串函数

ChatGPT-Next-Web SSRF漏洞+XSS漏洞复现(CVE-2023-49785)

文章导航