devbox
思考机器4
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

从0到1学SpringCloud——09 多数据源配置及动态切换_springcloud多数据源配置

作者：思考机器4 | 2024-01-31 23:08:00

赞

踩

springcloud多数据源配置

目录

一、前言

二、数据准备

三、配置文件

1、pom依赖

2、appication.properties配置

四、源码实现

1、数据源注解

2、数据源枚举值

3、配置多个数据源bean

4、切层注入

5、创建DynamicDataSource

6、ThreadLocal临时存储数据源

7、Controller访问

8、接口查询及数据获取

8、启动类

五、启动测试

1、访问master数据库

2、访问slave数据库

3、修改开关配置

一、前言

本篇主要介绍springboot如何进行多数据源配置，及一些设计思路。

主要包含以下内容：

1、多数据源通过注解动态切换

2、通过配置文件开关，只启用一个数据源

3、springboot中使用多数据源存在循环引用的问题

二、数据准备

为了方便演示，在两台服务器上创建两个数据库，分别为master和slave

在master数据库创建表z_f_user，表结构及数据如上图。

在slave数据库创建表z_f_msg，表结构及数据如上图。 

三、配置文件

1、pom依赖

  1.     <dependencies>
  2.         <dependency>
  3.             <groupId>mysql</groupId>
  4.             <artifactId>mysql-connector-java</artifactId>
  5.             <scope>runtime</scope>
  6.         </dependency>
  7.         <!--druid -->
  8.         <dependency>
  9.             <groupId>com.alibaba</groupId>
  10.             <artifactId>druid</artifactId>
  11.             <version>1.2.11</version>
  12.         </dependency>
  13.         <dependency>
  14.             <groupId>org.mybatis.spring.boot</groupId>
  15.             <artifactId>mybatis-spring-boot-starter</artifactId>
  16.             <version>2.2.2</version>
  17.         </dependency>
  18.         <dependency>
  19.             <groupId>org.aspectj</groupId>
  20.             <artifactId>aspectjweaver</artifactId>
  21.         </dependency>
  22.     </dependencies>

2、appication.properties配置

  1. #服务端口
  2. server.port=8080
  3. #服务名称
  4. spring.application.name=zhufeng-web-msg
  5.  
  6. #数据源公共配置
  7. spring.datasource.druid.type=com.alibaba.druid.pool.DruidDataSource
  8. spring.datasource.druid.driver-class-name=com.mysql.jdbc.Driver
  9. # master数据源配置
  10. spring.datasource.druid.dynamic.master.jdbc-url=jdbc:mysql://10.211.55.2:3306/master?serverTimezone=UTC&useUnicode=true@characterEncoding=utf-8
  11. spring.datasource.druid.dynamic.master.username=root
  12. spring.datasource.druid.dynamic.master.password=123
  13. # slave数据源配置
  14. spring.datasource.druid.dynamic.slave.jdbc-url=jdbc:mysql://10.211.55.14:3306/slave?serverTimezone=UTC&useUnicode=true@characterEncoding=utf-8
  15. spring.datasource.druid.dynamic.slave.username=root
  16. spring.datasource.druid.dynamic.slave.password=123
  17. #是否启动slave数据源开关，true：启用。默认为false
  18. spring.datasource.druid.dynamic.slave.enabled=true
  19.  
  20. mybatis.type-aliases-package=com.zhufeng.web.mapper
  21. mybatis.mapper-locations=classpath:mapper/*.xml

四、源码实现

1、数据源注解

  1. package com.zhufeng.base.db;
  2.  
  3. import java.lang.annotation.*;
  4.  
  5. /**
  6.  * @ClassName: DataSource
  7.  * @Description 数据源
  8.  * @author 月夜烛峰
  9.  * @date 2022/9/5 20:33
  10.  */
  11. @Target(ElementType.METHOD)
  12. @Retention(RetentionPolicy.RUNTIME)
  13. @Documented
  14. public @interface DataSource {
  15.     /**
  16.      *
  17.      * 切换数据源名称
  18.      */
  19.     DataSourceType value() default DataSourceType.MASTER;
  20. }

2、数据源枚举值

  1. package com.zhufeng.base.db;
  2.  
  3. /**
  4.  * @ClassName: DataSourceType
  5.  * @Description 数据源枚举值
  6.  * @author 月夜烛峰
  7.  * @date 2022/9/5 20:33
  8.  */
  9. public enum DataSourceType {
  10.     MASTER,
  11.     SLAVE
  12. }

3、配置多个数据源bean

  1. package com.zhufeng.base.db;
  2.  
  3. import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
  4. import org.springframework.boot.context.properties.ConfigurationProperties;
  5. import org.springframework.boot.jdbc.DataSourceBuilder;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.context.annotation.Primary;
  9.  
  10. import javax.sql.DataSource;
  11. import java.util.HashMap;
  12. import java.util.Map;
  13.  
  14. /**
  15.  * @ClassName: DataSourceConfig
  16.  * @Description 配置多数据源bean，默认使用master数据源
  17.  * @author 月夜烛峰
  18.  * @date 2022/9/5 20:33
  19.  */
  20. @Configuration
  21. public class DataSourceConfig {
  22.     @Bean
  23.     @ConfigurationProperties("spring.datasource.druid.dynamic.master")
  24.     public DataSource masterDataSource() {
  25.         return DataSourceBuilder.create().build();
  26.     }
  27.  
  28.     @Bean
  29.     @ConfigurationProperties("spring.datasource.druid.dynamic.slave")
  30.     @ConditionalOnProperty(prefix = "spring.datasource.druid.dynamic.slave", name = "enabled", havingValue = "true")
  31.     public DataSource slaveDataSource() {
  32.         return DataSourceBuilder.create().build();
  33.     }
  34.     
  35.     @Bean(name = "dynamicDataSource")
  36.     @Primary
  37.     public DynamicDataSource dataSource(DataSource masterDataSource,DataSource slaveDataSource) {
  38.         Map<Object, Object> targetDataSources = new HashMap<>(8);
  39.         targetDataSources.put(DataSourceType.MASTER.name(), masterDataSource);
  40.         targetDataSources.put(DataSourceType.SLAVE.name(), slaveDataSource);
  41.         return new DynamicDataSource(masterDataSource, targetDataSources);
  42.     }
  43. }

4、切层注入

  1. package com.zhufeng.base.db;
  2.  
  3. import org.aspectj.lang.ProceedingJoinPoint;
  4. import org.aspectj.lang.annotation.Around;
  5. import org.aspectj.lang.annotation.Aspect;
  6. import org.aspectj.lang.annotation.Pointcut;
  7. import org.aspectj.lang.reflect.MethodSignature;
  8. import org.springframework.core.annotation.Order;
  9. import org.springframework.stereotype.Component;
  10.  
  11. import java.lang.reflect.Method;
  12.  
  13. /**
  14.  * @ClassName: DataSourceAspect
  15.  * @Description spring切层注入
  16.  * @author 月夜烛峰
  17.  * @date 2022/9/5 20:33
  18.  */
  19. @Aspect
  20. @Order(1)
  21. @Component
  22. public class DataSourceAspect {
  23.  
  24.     @Pointcut("@annotation(com.zhufeng.base.db.DataSource)")
  25.     public void dsPointCut() {
  26.  
  27.     }
  28.  
  29.     @Around("dsPointCut()")
  30.     public Object around(ProceedingJoinPoint point) throws Throwable {
  31.         MethodSignature signature = (MethodSignature) point.getSignature();
  32.         Method method = signature.getMethod();
  33.         DataSource dataSource = method.getAnnotation(DataSource.class);
  34.         if (dataSource != null) {
  35.             DynamicDataSourceContextHolder.setDataSourceType(dataSource.value().name());
  36.         }
  37.         try {
  38.             return point.proceed();
  39.         } finally {
  40.             // 销毁数据源 在执行方法之后
  41.             DynamicDataSourceContextHolder.clearDataSourceType();
  42.         }
  43.     }
  44. }

5、创建DynamicDataSource

  1. package com.zhufeng.base.db;
  2.  
  3. import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
  4.  
  5. import javax.sql.DataSource;
  6. import java.util.Map;
  7.  
  8. /**
  9.  * @ClassName: DynamicDataSource
  10.  * @Description 动态数据源创建
  11.  * @author 月夜烛峰
  12.  * @date 2022/9/5 20:33
  13.  */
  14. public class DynamicDataSource extends AbstractRoutingDataSource {
  15.  
  16.     public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) {
  17.         super.setDefaultTargetDataSource(defaultTargetDataSource);
  18.         super.setTargetDataSources(targetDataSources);
  19.         super.afterPropertiesSet();
  20.     }
  21.  
  22.     /**
  23.      * 根据Key获取数据源的信息
  24.      *
  25.      * @return
  26.      */
  27.     @Override
  28.     protected Object determineCurrentLookupKey() {
  29.         return DynamicDataSourceContextHolder.getDataSourceType();
  30.     }
  31. }

6、ThreadLocal临时存储数据源

  1. package com.zhufeng.base.db;
  2. /**
  3.  * @ClassName: DynamicDataSourceContextHolder
  4.  * @Description 数据源临时处理
  5.  * @author 月夜烛峰
  6.  * @date 2022/9/5 20:33
  7.  */
  8. public class DynamicDataSourceContextHolder {
  9.  
  10.     /**
  11.      * 使用ThreadLocal临时存储
  12.      */
  13.     private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();
  14.  
  15.     /**
  16.      * 设置数据源变量
  17.      * @param dataSourceType
  18.      */
  19.     public static void setDataSourceType(String dataSourceType){
  20.         CONTEXT_HOLDER.set(dataSourceType);
  21.     }
  22.  
  23.     /**
  24.      * 获取数据源变量
  25.      * @return
  26.      */
  27.     public static String getDataSourceType(){
  28.         return CONTEXT_HOLDER.get();
  29.     }
  30.  
  31.     /**
  32.      * 清空数据源变量
  33.      */
  34.     public static void clearDataSourceType(){
  35.         CONTEXT_HOLDER.remove();
  36.     }
  37. }

7、Controller访问

  1. package com.zhufeng.web.controller;
  2.  
  3. import com.alibaba.fastjson.JSONObject;
  4. import com.zhufeng.base.db.DataSource;
  5. import com.zhufeng.base.db.DataSourceType;
  6. import com.zhufeng.web.service.MsgService;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  9.  
  10. import javax.annotation.Resource;
  11.  
  12. /**
  13.  * @ClassName: DataController
  14.  * @Description 多数据源切换演示
  15.  * @author 月夜烛峰
  16.  * @date 2022/9/5 20:40
  17.  */
  18. @RestController
  19. @RequestMapping("data")
  20. public class DataController {
  21.  
  22.     @Resource
  23.     MsgService msgService;
  24.  
  25.     @RequestMapping("master")
  26.     public JSONObject showUser(){
  27.         return msgService.showFirstUser();
  28.     }
  29.  
  30.     @RequestMapping("slave")
  31.     public JSONObject showMsg(){
  32.         return msgService.showFirstMsg();
  33.     }
  34. }

8、接口查询及数据获取

service接口：

  1. /**
  2.  * @ClassName: MsgService
  3.  * @Description TODO
  4.  * @author 月夜烛峰
  5.  * @date 2022/9/5 20:06
  6.  */
  7. public interface MsgService {
  8.     /**
  9.      * 获取第一条消息信息
  10.      * @return
  11.      */
  12.     JSONObject showFirstMsg();
  13.  
  14.     /**
  15.      * 获取第一个用户信息
  16.      * @return
  17.      */
  18.     JSONObject showFirstUser();
  19. }

实现类：

  1. package com.zhufeng.web.service.impl;
  2.  
  3. import com.alibaba.fastjson.JSONObject;
  4. import com.zhufeng.base.db.DataSource;
  5. import com.zhufeng.base.db.DataSourceType;
  6. import com.zhufeng.web.mapper.MsgMapper;
  7. import com.zhufeng.web.service.MsgService;
  8. import org.springframework.stereotype.Service;
  9.  
  10. import javax.annotation.Resource;
  11.  
  12. /**
  13.  * @ClassName: MsgServiceImpl
  14.  * @Description TODO
  15.  * @author 月夜烛峰
  16.  * @date 2022/9/5 15:06
  17.  */
  18. @Service
  19. public class MsgServiceImpl implements MsgService {
  20.  
  21.     @Resource
  22.     MsgMapper msgMapper;
  23.  
  24.     /**
  25.      * 获取第一条消息信息
  26.      * @return
  27.      */
  28.     @DataSource(value = DataSourceType.SLAVE)
  29.     @Override
  30.     public JSONObject showFirstMsg() {
  31.         return msgMapper.showFirstMsg();
  32.     }
  33.  
  34.     /**
  35.      * 获取第一个用户信息
  36.      * @return
  37.      */
  38.     @Override
  39.     public JSONObject showFirstUser() {
  40.         return msgMapper.showFirstUser();
  41.     }
  42. }

dao层代码：

  1. /**
  2.  * @ClassName: MsgMapper
  3.  * @Description TODO
  4.  * @author 月夜烛峰
  5.  * @date 2022/9/5 14:55
  6.  */
  7. @Mapper
  8. public interface MsgMapper {
  9.  
  10.     /**
  11.      * 获取第一条消息信息
  12.      * @return
  13.      */
  14.     JSONObject showFirstMsg();
  15.  
  16.     /**
  17.      * 获取第一个用户信息
  18.      * @return
  19.      */
  20.     JSONObject showFirstUser();
  21. }

查询语句：

  1. 	<!--获取第一个用户信息-->
  2. 	<select id="showFirstUser" resultType="com.alibaba.fastjson.JSONObject">
  3. 		SELECT
  4. 			*
  5. 		FROM
  6. 			z_f_user
  7. 		LIMIT 0,1
  8. 	</select>
  9.  
  10. 	<!--获取第一个消息信息-->
  11. 	<select id="showFirstMsg" resultType="com.alibaba.fastjson.JSONObject">
  12. 		SELECT
  13. 			*
  14. 		FROM
  15. 			z_f_msg
  16. 		LIMIT 0,1
  17. 	</select>

8、启动类

  1. /**
  2.  * @ClassName: MsgApplication
  3.  * @Description msg启动类
  4.  * @author 月夜烛峰
  5.  * @date 2022/7/22 08:53
  6.  */
  7.  
  8. @EnableDiscoveryClient
  9. @SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
  10. public class MsgApplication {
  11.     public static void main(String[] args) {
  12.         SpringApplication.run(MsgApplication.class, args);
  13.     }
  14. }

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})这里是启动时把DataSourceAutoConfiguration排除，避免在启动过程中出现循环引用问题

五、启动测试

1、访问master数据库

2、访问slave数据库

3、修改开关配置

在application.properties中将以下配置删除或者改为false，重新启动项目

#是否启动slave数据源开关，true：启用。默认为false
spring.datasource.druid.dynamic.slave.enabled=false

再次访问slave，报错如下：

 控制台报错信息：

### The error may involve defaultParameterMap
### The error occurred while setting parameters
### SQL: SELECT    *   FROM    z_f_msg   LIMIT 0,1
### Cause: java.sql.SQLSyntaxErrorException: Table 'master.z_f_msg' doesn't exist
; bad SQL grammar []; nested exception is java.sql.SQLSyntaxErrorException: Table 'master.z_f_msg' doesn't exist] with root cause

错误日志显示，去master数据源中查询z_f_msg，也就是没有切换到slave数据源，在servce中添加的slave数据源的动态切换注解没有生效，使用默认的master数据源。

    @DataSource(value = DataSourceType.SLAVE)
    @Override
    public JSONObject showFirstMsg() {
        return msgMapper.showFirstMsg();
    }

master作为默认数据源配置，在初始化数据源时已经指定

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/blog/article/detail/52408
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号