springBoot学习笔记（2.5）—— 整合mybatis配置多数据源

一、配置步骤

1.引入jar包

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.6.2</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.example</groupId>
  12.     <artifactId>springboot-datasource</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>springboot-datasource</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>1.8</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-data-jdbc</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-jdbc</artifactId>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>org.springframework.boot</groupId>
  30.             <artifactId>spring-boot-starter-web</artifactId>
  31.         </dependency>
  33.         <dependency>
  34.             <groupId>mysql</groupId>
  35.             <artifactId>mysql-connector-java</artifactId>
  36.             <scope>runtime</scope>
  37.         </dependency>
  38.         <dependency>
  39.             <groupId>org.projectlombok</groupId>
  40.             <artifactId>lombok</artifactId>
  41.             <optional>true</optional>
  42.         </dependency>
  43.         <dependency>
  44.             <groupId>org.springframework.boot</groupId>
  45.             <artifactId>spring-boot-starter-test</artifactId>
  46.             <scope>test</scope>
  47.         </dependency>
  49.         <dependency>
  50.             <groupId>org.mybatis.spring.boot</groupId>
  51.             <artifactId>mybatis-spring-boot-starter</artifactId>
  52.             <version>1.3.1</version>
  53.         </dependency>
  55.         <!--分数据源-->
  56.         <!-- 阿里连接池-->
  57.         <!--分数据源-->
  58.         <dependency>
  59.             <groupId>com.alibaba</groupId>
  60.             <artifactId>druid-spring-boot-starter</artifactId>
  61.             <version>1.1.10 </version>
  62.         </dependency>
  65.         <dependency>
  66.             <groupId>com.alibaba</groupId>
  67.             <artifactId>druid</artifactId>
  68.             <version>1.1.0</version>
  69.         </dependency>
  72.         <dependency>
  73.             <groupId>org.springframework.boot</groupId>
  74.             <artifactId>spring-boot-starter-aop</artifactId>
  75.         </dependency>
  77.     </dependencies>
  79.     <build>
  80.         <plugins>
  81.             <plugin>
  82.                 <groupId>org.springframework.boot</groupId>
  83.                 <artifactId>spring-boot-maven-plugin</artifactId>
  84.                 <configuration>
  85.                     <excludes>
  86.                         <exclude>
  87.                             <groupId>org.projectlombok</groupId>
  88.                             <artifactId>lombok</artifactId>
  89.                         </exclude>
  90.                     </excludes>
  91.                 </configuration>
  92.             </plugin>
  93.         </plugins>
  94.     </build>
  96. </project>

2.配置项目文件

  1. spring:
  2.   datasource:
  3.     driver-class-name: com.mysql.cj.jdbc.Driver
  4.     druid:
  5.       #数据源1
  6.       first:
  7.         #   数据源基本配置
  8.         url: jdbc:mysql://101.34.49.127:3306/springBootAll?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false
  9.         username: root
  10.         password: 123456
  11.       # 数据源2
  12.       second:
  13.         url: jdbc:mysql://localhost:3306/springBootAll?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false
  14.         username: root
  15.         password: 123456
  20. mybatis:
  21.   mapper-locations: classpath:mybatis/mapper/*.xml
  24. server:
  25.   port: 8082 # 配置项目启动端口

3.数据源切换配置

3.1 项目文件截图

springBoot学习笔记（2.5）—— 整合mybatis配置多数据源 - 图1

3.2 CurDataSouce类切换数据源的注释

  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. public @interface CurDataSource {
  6.     String name() default "";
  8. }

3.3 DataSourceAspect类多数据源切面处理

  1. @Slf4j
  2. @Aspect
  3. @Component
  4. public class DataSourceAspect implements Ordered {
  6.     @Pointcut("@annotation(com.example.springbootdatasource.datasource.CurDataSource)")
  7.     public void dataSourcePointCut() {
  9.     }
  11.     @Around("dataSourcePointCut()")
  12.     public Object around(ProceedingJoinPoint point) throws Throwable {
  13.         MethodSignature signature = (MethodSignature) point.getSignature();
  14.         Method method = signature.getMethod();
  16.         CurDataSource ds = method.getAnnotation(CurDataSource.class);
  17.         if (ds == null) {
  18.             DynamicDataSource.setDataSource(DataSourceNames.FIRST);
  19.             log.debug("set datasource is " + DataSourceNames.FIRST);
  20.         } else {
  21.             DynamicDataSource.setDataSource(ds.name());
  22.             log.debug("set datasource is " + ds.name());
  23.         }
  25.         try {
  26.             return point.proceed();
  27.         } finally {
  28.             DynamicDataSource.clearDataSource();
  29.             log.debug("clean datasource");
  30.         }
  31.     }
  33.     @Override
  34.     public int getOrder() {
  35.         return 1;
  36.     }
  37. }

3.4 DataSourceNames类枚举数据源

  1. public interface DataSourceNames {
  3.     String FIRST = "first";
  5.     String SECOND = "second";
  7. }

3.5 DynamicDataSource类

  2. /**
  3.  * 扩展 Spring 的 AbstractRoutingDataSource 抽象类，重写 determineCurrentLookupKey 方法
  4.  * 动态数据源
  5.  * determineCurrentLookupKey() 方法决定使用哪个数据源
  6.  *
  7.  * @author xiaohe
  8.  * @version V1.0.0
  9.  */
  10. public class DynamicDataSource extends AbstractRoutingDataSource {
  12.     /**
  13.      * ThreadLocal 用于提供线程局部变量，在多线程环境可以保证各个线程里的变量独立于其它线程里的变量。
  14.      * 也就是说 ThreadLocal 可以为每个线程创建一个【单独的变量副本】，相当于线程的 private static 类型变量。
  15.      */
  16.     private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();
  18.     /**
  19.      * 决定使用哪个数据源之前需要把多个数据源的信息以及默认数据源信息配置好
  20.      *
  21.      * @param defaultTargetDataSource 默认数据源
  22.      * @param targetDataSources       目标数据源
  23.      */
  24.     public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources) {
  25.         super.setDefaultTargetDataSource(defaultTargetDataSource);
  26.         super.setTargetDataSources(targetDataSources);
  27.         super.afterPropertiesSet();
  28.     }
  30.     @Override
  31.     protected Object determineCurrentLookupKey() {
  32.         return getDataSource();
  33.     }
  35.     public static void setDataSource(String dataSource) {
  36.         CONTEXT_HOLDER.set(dataSource);
  37.     }
  39.     public static String getDataSource() {
  40.         return CONTEXT_HOLDER.get();
  41.     }
  43.     public static void clearDataSource() {
  44.         CONTEXT_HOLDER.remove();
  45.     }
  47. }

3.6 DynamicDataSourceConfig类

  1. /**
  2.  * 配置多数据源
  3.  * @author xiaohe
  4.  * @version V1.0.0
  5.  */
  6. @Configuration
  7. public class DynamicDataSourceConfig {
  9.     @Bean
  10.     @ConfigurationProperties("spring.datasource.druid.first")
  11.     public DataSource firstDataSource(){
  13.         return DruidDataSourceBuilder.create().build();
  14.     }
  16.     @Bean
  17.     @ConfigurationProperties("spring.datasource.druid.second")
  18.     public DataSource secondDataSource(){
  20.         return DruidDataSourceBuilder.create().build();
  21.     }
  23.     @Bean
  24.     @Primary
  25.     public DynamicDataSource dataSource(DataSource firstDataSource, DataSource secondDataSource) {
  26.         Map<Object, Object> targetDataSources = new HashMap<>(5);
  27.         targetDataSources.put(DataSourceNames.FIRST, firstDataSource);
  28.         targetDataSources.put(DataSourceNames.SECOND, secondDataSource);
  29.         return new DynamicDataSource(firstDataSource, targetDataSources);
  30.     }
  32. }

4.springboot主方法

  1. //启动时不引入数据库配置
  2. @SpringBootApplication(exclude={DataSourceAutoConfiguration.class})
  3. @MapperScan(basePackages = "com.example.springbootdatasource")
  4. @EnableScheduling
  5. @EnableAspectJAutoProxy(exposeProxy = true)
  6. @Import({DynamicDataSourceConfig.class})
  7. public class SpringbootDatasourceApplication {
  8.     public static void main(String[] args) {
  9.         SpringApplication.run(SpringbootDatasourceApplication.class, args);
  10.     }
  12. }

5.controller层接口

  1. @Controller
  2. @RequestMapping("userController")
  3. public class UserController {
  5.     @Resource
  6.     UserService userService;
  8.     /****
  9.      * description: findUser
  10.      * version: 1.0 ->
  11.      * date: 2022/1/28 15:11
  12.      * author: xiaYZ
  13.      * iteration: 迭代说明
  14.      * @param id
  15.      * @return java.lang.String
  16.      */
  17.     @ResponseBody
  18.     @GetMapping("findUserFromFirst")
  19.     @Description("申明使用数据源一进行操作")
  20.     public String findUserFromFirst(Integer id){
  21.         User user = new User();
  22.         try{
  23.             user = userService.selectDataFromFirst(id);
  24.         }catch (Exception e){
  25.             e.printStackTrace();
  26.         }
  27.         return user.toString();
  28.     }
  30.     /***
  31.      * description: findUserSecond
  32.      * version: 1.0 ->
  33.      * date: 2022/2/1 18:14
  34.      * author: xiaYZ
  35.      * iteration: 迭代说明
  36.      * @param id
  37.      * @return java.lang.String
  38.      */
  39.     @ResponseBody
  40.     @GetMapping("findUserFromSecond")
  41.     @Description("查询用户数据从数据源二")
  42.     public String findUserFromSecond(Integer id){
  43.         User user = new User();
  44.         try{
  45.             user = userService.selectDataSecond(id);
  46.         }catch (Exception e){
  47.             e.printStackTrace();
  48.         }
  49.         return user.toString();
  50.     }
  52. }

6.service层方法

  1. @Service
  2. public class UserService{
  4.     @Resource
  5.     private UserMapper userMapper;
  7.     /**
  8.      * description: 申明使用数据源一进行操作
  9.      * version: 1.0
  10.      * date: 2022/2/1 18:10
  11.      * author: xiaYZ
  12.      * iteration: 迭代说明
  13.      * @param id
  14.      * @return
  15.      */
  16.     @CurDataSource(name = DataSourceNames.FIRST)
  17.     public User selectDataFromFirst(Integer id) {
  18.         return userMapper.selectByPrimaryKey(id);
  19.     }
  21.     /**
  22.      * description: 申明使用数据源二进行操作
  23.      * version: 1.0
  24.      * date: 2022/2/1 19:27
  25.      * author: xiaYZ
  26.      * iteration: 迭代说明
  27.      * @param id
  28.      * @return 
  29.      */
  30.     @CurDataSource(name = DataSourceNames.SECOND)
  31.     public User selectDataSecond(Integer id){
  32.         return  userMapper.selectByPrimaryKey(id);
  33.     }
  34. }

使用@CurDataSource注解声明使用那个数据源

二、项目运行截图

1. 数据库截图

1.1本地数据截图

springBoot学习笔记（2.5）—— 整合mybatis配置多数据源 - 图2

1.2 服务器上数据库截图

springBoot学习笔记（2.5）—— 整合mybatis配置多数据源 - 图3

2.接口调用截图

2.1 服务器数据源接口截图

springBoot学习笔记（2.5）—— 整合mybatis配置多数据源 - 图4

2.2 本地接口数据源截图

springBoot学习笔记（2.5）—— 整合mybatis配置多数据源 - 图5

总结

  1. 引入对应jar包
  2. 构建数据源切换配置
  3. service层使用@CurDataSource注解切换配置，如果没有使用此注解默认使用上一个接口的数据源

项目源码