SpringBoot 中 MyBatis-Plus 集成动态多数据源过程（亲测可用）

最新推荐文章于 2024-03-22 17:34:54 发布

@胡海龙

最新推荐文章于 2024-03-22 17:34:54 发布

阅读量3.9k

点赞数 4

分类专栏：随笔文章标签： springboot mybatis-plus 多数据源

本文链接：https://blog.csdn.net/hhl18730252820/article/details/124136885

版权

随笔专栏收录该内容

51 篇文章 5 订阅

订阅专栏

使用场景

当你的项目中使用到多个数据源或者需要在程序运行过程中动态的添加数据源时可以参考本文中的实现。这里使用的是dynamic-datasource-spring-boot-starter ，它是一个基于springboot的快速集成多数据源的启动器。具体文档：dynamic-datasource-spring-boot-starter官方文档。

Demo环境与版本

JDK1.8
SpringBoot 2.6.6
MyBatis-Plus 3.4.1
dynamic-datasource-spring-boot-starter 3.4.1

pom.xml

下面是完成的pom.xml文件内容

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.6.6</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>vip.huhailong</groupId>
	<artifactId>dynamic-datasource-demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>dynamic-datasource-demo</name>
	<description>About dynamic datasource demo</description>
	<properties>
		<java.version>1.8</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.4.1</version>
		</dependency>
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
			<version>3.4.1</version>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<excludes>
						<exclude>
							<groupId>org.projectlombok</groupId>
							<artifactId>lombok</artifactId>
						</exclude>
					</excludes>
				</configuration>
			</plugin>
		</plugins>
	</build>

</project>

情景1: 固定多数据源情景

这种情景是多个数据源的IP地址、端口、用户名、密码等信息已知，可以写到application.yml的配置中，不会涉及到动态添加到场景，这种场景集成很简单。下面是application.yml配置文件内容：

spring:
  datasource:
    dynamic:
      primary: master #设置默认的数据源，默认值为master
      strict: false   #是否弃用严格模式，如果启用在味匹配到指定数据源时抛出异常
      datasource:
        master:
          url: jdbc:mysql://192.168.1.110:3306/dynamic1
          username: root
          password: hhl@MySQL_1121
          driverClassName: com.mysql.cj.jdbc.Driver
        test:
          url: jdbc:mysql://192.168.1.110:3306/dynamic2
          username: root
          password: hhl@MySQL_1121
          driverClassName: com.mysql.cj.jdbc.Driver
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
server:
  port: 8080
  servlet:
    context-path: /demo

上面的配置中从dynamic开始是有关多数据源的配置，primary用来配置主数据源也叫默认数据源，它的默认值是master，因此，如果不指定primary的话一定要有名为master的数据源。strict 是用来配置是否启用严格模式，如果为true表示启用，此时如果没有匹配的数据源会抛出异常，如果为false则会使用默认数据源。datasource下面就是配置多数据源的信息了。
后面的mybatis-plus配置我主要是用来说明集成这个不会对mybatis-plus对配置产生影响，该怎么用mybatis-plus就继续怎么用。

测试验证

正如配置文件中的那样，我使用了两个不同的数据库来模拟多数据源，每个数据库中添加了一张表——test，如下：
在这里插入图片描述
然后在项目中建立一个实体类——Test.java，再像平时那样搞定对应的mapper文件、service文件以及对应的实现类，然后创建一个测试的接口类用来做测试，下面是响应的文件

Test.java

test表对应的实体类

package vip.huhailong.demo.entity;

import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName
public class Test {
    private Integer id;
    private String name;
}

TestMapper.java

TestMapper 接口类

package vip.huhailong.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import vip.huhailong.demo.entity.Test;

public interface TestMapper extends BaseMapper<Test> {
}

ITestService.java

对应的接口类

package vip.huhailong.demo.service;

import com.baomidou.mybatisplus.extension.service.IService;
import vip.huhailong.demo.entity.Test;

public interface ITestService extends IService<Test> {
}

TestServiceImpl.java

对应接口的实现类

package vip.huhailong.demo.service.impl;

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import vip.huhailong.demo.entity.Test;
import vip.huhailong.demo.mapper.TestMapper;
import vip.huhailong.demo.service.ITestService;

@Service
public class TestServiceImpl extends ServiceImpl<TestMapper, Test> implements ITestService {
}

TestController.java

接口类

package vip.huhailong.demo.controller;

import com.baomidou.dynamic.datasource.DynamicRoutingDataSource;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.dynamic.datasource.creator.DefaultDataSourceCreator;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DataSourceProperty;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import vip.huhailong.demo.entity.DataSourceDTO;
import vip.huhailong.demo.entity.Test;
import vip.huhailong.demo.service.ITestService;

import javax.sql.DataSource;
import java.util.List;
import java.util.Set;

@RestController
@RequestMapping("/test")
public class TestController {
    @Autowired
    ITestService testService;

    @GetMapping("/get1")
    public List<Test> test1(){
        return testService.list();
    }

    @DS("test")
    @GetMapping("/get2")
    public List<Test> test2(){
        return testService.list();
    }

    @GetMapping("/now")
    public Set<String> now(){
        DynamicRoutingDataSource source = (DynamicRoutingDataSource) dataSource;
        return source.getDataSources().keySet();
    }
}

上面代码中除了TestController.java外都大同小异，mybatis-plus都常规写法，也可以用代码生成器生成。这里主要看一下TestController.java这个类，这里面有三个接口：

“/get1”：使用默认数据库，也就是dynamic1。
“/get2”：使用test数据库，也就是dynamic2。
“/now”：查询当前的所有数据源。
在第二个接口上面使用类注解@DS("test"),该注解就是用来切换数据源的，里面的值就是数据源的名称。下面看一下接口的调用情况。

可以看到和我们预想的一样。

情景2：动态数据源情景

改情景下的数据源可能是在运行过程中添加进去的，使用时我们在上面的固定多数据源的代码中进行修改实验。
首先将application.yml文件中的test数据源注释掉：

spring:
  datasource:
    dynamic:
      primary: master #设置默认的数据源，默认值为master
      strict: false   #是否弃用严格模式，如果启用在味匹配到指定数据源时抛出异常
      datasource:
        master:
          url: jdbc:mysql://192.168.1.110:3306/dynamic1
          username: root
          password: hhl@MySQL_1121
          driverClassName: com.mysql.cj.jdbc.Driver
#        test:
#          url: jdbc:mysql://192.168.1.110:3306/dynamic2
#          username: root
#          password: hhl@MySQL_1121
#          driverClassName: com.mysql.cj.jdbc.Driver
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
server:
  port: 8080
  servlet:
    context-path: /demo

然后需要改变的文件是TestController.java这个文件，如下：

package vip.huhailong.demo.controller;

import com.baomidou.dynamic.datasource.DynamicRoutingDataSource;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.dynamic.datasource.creator.DefaultDataSourceCreator;
import com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DataSourceProperty;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import vip.huhailong.demo.entity.DataSourceDTO;
import vip.huhailong.demo.entity.Test;
import vip.huhailong.demo.service.ITestService;

import javax.sql.DataSource;
import java.util.List;
import java.util.Set;

@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private DataSource dataSource;
    @Autowired
    private DefaultDataSourceCreator defaultDataSourceCreator;

    @Autowired
    ITestService testService;

    @GetMapping("/get1")
    public List<Test> test1(){
        return testService.list();
    }

    @DS("test")
    @GetMapping("/get2")
    public List<Test> test2(){
        return testService.list();
    }

    @GetMapping("/now")
    public Set<String> now(){
        DynamicRoutingDataSource source = (DynamicRoutingDataSource) dataSource;
        return source.getDataSources().keySet();
    }

    @PostMapping("/addSource")
    public Set<String> addSource(@RequestBody DataSourceDTO dto){
        DataSourceProperty dataSourceProperty = new DataSourceProperty();
        BeanUtils.copyProperties(dto,dataSourceProperty);
        DynamicRoutingDataSource source = (DynamicRoutingDataSource) dataSource;
        DataSource dataSource = defaultDataSourceCreator.createDataSource(dataSourceProperty);
        source.addDataSource(dto.getPoolName(),dataSource);
        return source.getDataSources().keySet();
    }

    @DeleteMapping("/remove")
    public String removeDataSource(String name){
        DynamicRoutingDataSource source = (DynamicRoutingDataSource) dataSource;
        source.removeDataSource(name);
        return "删除成功";
    }
}

DataSourceDTO.java

package vip.huhailong.demo.entity;

import lombok.Data;

@Data
public class DataSourceDTO {
    private String poolName;
    private String driverClassName;
    private String url;
    private String username;
    private String password;
}

上面的DataSourceDTO.java类是用来接收数据源参数的。里面的poolName就理解为数据源名称就行
可以看到上面的代码中我们注入了DataSource和DefaultDataSourceCreator，这里DefaultDataSourceCreator 是一个通用的创建器，其根据环境自动选择连接池。除了它我们也可以选择其他：

BasicDataSourceCreator
JndiDataSourceCreator
DruidDataSourceCreator
HikariDataSourceCreator
BeeCpDataSourceCreator
Dbcp2DataSourceCreator
可以根据自己的不同需求选择上面的类型。
除此之外代码中还添加了俩个方法：
addSource：添加数据源
removeDataSource：移除数据源
重启项目，经过测试：当没有执行添加数据源接口时，请求"/get1"和"/get2"均返回的是数据源1的结果，执行"/now"时显示只有一个数据源，当执行了添加数据源接口后，执行结果和上面的固定多数据源执行结果相同。执行添加数据源的接口json参数如下：

    "poolName": "test",
    "url": "jdbc:mysql://192.168.1.110:3306/dynamic2",
    "username": "root",
    "password": "your_mysql_password",
    "driverClassName": "com.mysql.cj.jdbc.Driver"
}

以上就是一个springboot 中 MyBatis-Plus 集成动态多数据源的一个简单的Demo。需要注意的是，Demo中为了方便测试将@DS注解注解用到了Controller类中，这个推荐使用到接口的实现类中，虽然可以在Controller中使用，但是放到接口实现类中更合理和规范。

项目地址：dynamic-datasource-demo

❤️ ❤️ ❤️ ❤️ ❤️ 如果本文对你有一点点的帮助请点个大大赞👍 ❤️ ❤️ ❤️ ❤️ ❤️

@胡海龙

关注

4
点赞
踩
21

收藏

觉得还不错? 一键收藏
打赏
3
评论
SpringBoot 中 MyBatis-Plus 集成动态多数据源过程（亲测可用）

使用场景当你的项目中使用到多个数据源或者需要在程序运行过程中动态的添加数据源时可以参考本文中的实现。这里使用的是dynamic-datasource-spring-boot-starter ，它是一个基于springboot的快速集成多数据源的启动器。具体文档：dynamic-datasource-spring-boot-starter官方文档。Demo环境与版本JDK1.8SpringBoot 2.6.6MyBatis-Plus 3.4.1dynamic-datasource-spring-
复制链接

扫一扫