需求背景
SpringBoot用法：MybatisPlus框架动态数据源用法（支持多个DB，动态切换数据源）
简介
dynamic-datasource-spring-boot-starter 是一个基于springboot的快速集成多数据源的启动器
优势
网上关于动态数据源的切换的文档有很多，核心只有两种：
- 构建多套环境，优势是方便控制也容易集成一些简单的分布式事务，缺点是非动态同时代码量较多，配置难度大。
- 基于spring提供原生的
AbstractRoutingDataSource，参考一些文档自己实现切换。
如果你的数据源较少，场景不复杂，选择以上任意一种都可以
如果你需要更多特性，请尝试本动态数据源：
- 数据源分组，适用于多种场景 纯粹多库 读写分离 一主多从 混合模式。
- 简单集成Druid数据源监控多数据源，简单集成Mybatis-Plus简化单表，简单集成P6sy格式化sql，简单集成Jndi数据源。
- 简化Druid和HikariCp配置，提供全局参数配置。
- 提供自定义数据源来源(默认使用yml或properties配置)。
- 项目启动后能动态增减数据源。
- 使用spel动态参数解析数据源，如从session，header和参数中获取数据源。（多租户架构神器）
- 多层数据源嵌套切换。（一个业务ServiceA调用ServiceB，ServiceB调用ServiceC，每个Service都是不同的数据源）
- 使用正则匹配或spel表达式来切换数据源（实验性功能）。
劣势
- 不能使用多数据源事务（同一个数据源下能使用事务），网上其他方案也都不能提供。
- 如果你需要使用到分布式事务，那么你的架构应该到了微服务化的时候了。
- 如果你只是几个数据库，但是有强烈的需求分布式事务，建议还是使用传统方式自己构建多套环境集成atomic这类，网上百度很多。
约定
- 本框架只做 切换数据源 这件核心的事情，并不限制你的具体操作，切换了数据源可以做任何CRUD。
- 配置文件所有以下划线
_分割的数据源 首部 即为组的名称，相同组名称的数据源会放在一个组下。 - 切换数据源即可是组名，也可是具体数据源名称，切换时默认采用负载均衡机制切换。
- 默认的数据源名称为 master ，你可以通过spring.datasource.dynamic.primary修改。
- 方法上的注解优先于类上注解。
建议
强烈建议在 主从模式 下遵循普遍的规则，以便他人能更轻易理解你的代码：
1. 主数据库 建议 只执行
INSERTUPDATEDELETE操作2. 从数据库 建议 只执行
SELECT操作
准备内容
1. 准备两个Mysql实例
2. 数据库初始化init.sql脚本内容（或Docker安装MySQL数据库）
db1-init.sql
-- for db1
drop table users;
CREATE TABLE `users` (
`username` varchar(50) NOT NULL COMMENT '用户名',
`password` varchar(500) NOT NULL COMMENT '密码',
`enabled` tinyint(1) NOT NULL COMMENT '是否启用',
PRIMARY KEY (`username`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
INSERT INTO `users` (`username`, `password`, `enabled`)
VALUES
('master', '123456', 1);db2-init.sql
-- for db2
drop table users;
CREATE TABLE `users` (
`username` varchar(50) NOT NULL COMMENT '用户名',
`password` varchar(500) NOT NULL COMMENT '密码',
`enabled` tinyint(1) NOT NULL COMMENT '是否启用',
PRIMARY KEY (`username`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
INSERT INTO `users` (`username`, `password`, `enabled`)
VALUES
('slave', '654321', 1);代码演示
1. 项目目录结构
2. 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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.md</groupId>
<artifactId>spring-boot2-parent</artifactId>
<version>0.0.1-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>spring-boot2-mybatis-plus-multi-datasource</artifactId>
<packaging>jar</packaging>
<name>spring-boot2-mybatis-plus-multi-datasource</name>
<description>Spring Boot, MVC, Rest API for App</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
<swagger.version>2.9.2</swagger.version>
<mybatisplus.version>3.2.0</mybatisplus.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- 构建成可运行的Web项目 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>net.sf.json-lib</groupId>
<artifactId>json-lib-ext-spring</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
</dependency>
<!-- swagger集成 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<!-- 默认swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
<!-- 更易用第三方swagger-ui组件 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
</dependency>
<!-- mybatis-plus集成 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatisplus.version}</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatisplus.version}</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<!-- 集成动态数据源 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>2.5.4</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>3. application.yml配置文件
spring:
datasource:
dynamic:
primary: master #设置默认的数据源或者数据源组，默认值即为master
#如果你只是单数据源，则只需要注释掉slave相关配置就好了，这里为了方便演示master与slave保持相同
datasource:
master:
driverClassName: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:33061/testdb?useUnicode=true&autoReconnect=true&characterEncoding=UTF-8&allowMultiQueries=true&useSSL=false
username: root
password: 123456
slave_1:
driverClassName: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:33062/testdb?useUnicode=true&autoReconnect=true&characterEncoding=UTF-8&allowMultiQueries=true&useSSL=false
username: root
password: 123456
server:
port: 90904. 自动代码生成器类
CodeGenerator.java（如不熟悉mybatis-plus框架，可以先阅读文章：入门Mybatis-Plus快速开发框架用法）
通过此类，生成users表相应的dao，service，controller类，mapper文件等
5. UsersMapper类
定义一个方法，使用@DS注解
- 使用 @DS 切换数据源
- @DS 可以注解在方法上和类上，同时存在方法注解优先于类上注解。
- 注解在service实现或mapper接口方法上，但强烈不建议同时在service和mapper注解。
package com.md.demo.dao;
import com.md.demo.entity.vo.Users;
import java.util.List;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* Mapper 接口
* </p>
*
* @author Minbo
* @since 2020-03-27
*/
//@DS("slave_1")
public interface UsersMapper extends BaseMapper<Users> {
// 使用@DS注解，可以切换数据源。如果没有配置@DS，则使用默认数据源（使用配置文件中的primary源）
// @DS 可以注解在方法上和类上，同时存在方法注解优先于类上注解
// 注解在service实现或mapper接口方法上，但强烈不建议同时在service和mapper注解
// @DS("slave_1")
// @DS("master")
public List<Users> listDbInfo();
}UsersMapper.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.md.demo.dao.UsersMapper">
<select id="listDbInfo" resultType="com.md.demo.entity.vo.Users">
select * from users
</select>
</mapper>6. 服务类
IUsersService：
package com.md.demo.service;
import com.md.demo.entity.vo.Users;
import java.util.List;
import com.baomidou.mybatisplus.extension.service.IService;
/**
* <p>
* 服务类
* </p>
*
* @author Minbo
* @since 2020-03-27
*/
public interface IUsersService extends IService<Users> {
public List<Users> listDbInfo();
}服务实现类
package com.md.demo.service.impl;
import java.util.List;
import org.springframework.stereotype.Service;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.md.demo.dao.UsersMapper;
import com.md.demo.entity.vo.Users;
import com.md.demo.service.IUsersService;
/**
* <p>
* 服务实现类
* </p>
*
* @author Minbo
* @since 2020-03-27
*/
@Service
//@DS("slave_1")
public class UsersServiceImpl extends ServiceImpl<UsersMapper, Users> implements IUsersService {
@Override
// @DS("master")
public List<Users> listDbInfo() {
return this.baseMapper.listDbInfo();
}
}7. 前端控制器
UsersController
package com.md.demo.controller;
import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.md.demo.entity.vo.Users;
import com.md.demo.service.IUsersService;
import com.md.demo.util.JsonResult;
import com.md.demo.util.ResultCode;
import io.swagger.annotations.ApiOperation;
/**
* <p>
* 前端控制器
* </p>
*
* @author Minbo
* @since 2020-03-27
*/
@RestController
@RequestMapping("/demo/users")
public class UsersController {
@Autowired
private IUsersService usersService;
@ApiOperation(value = "获得用户列表信息", httpMethod = "POST")
@PostMapping("/listDbInfo")
public JsonResult listDbInfo() {
List<Users> dataList = this.usersService.listDbInfo();
if (dataList == null || dataList.size() == 0) {
return new JsonResult(ResultCode.SUCCESS_FAIL);
}
return new JsonResult(ResultCode.SUCCESS, dataList);
}
}8. 启动类
Application：
package com.md.demo;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
/**
* 程序主入口
*
* @author Minbo
*
*/
@SpringBootApplication
@EnableSwaggerBootstrapUI
@MapperScan("com.md.demo.dao")
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
/**
* 开启过滤器功能
*
* @return
*/
private CorsConfiguration buildConfig() {
CorsConfiguration corsConfiguration = new CorsConfiguration();
corsConfiguration.addAllowedOrigin("*");
corsConfiguration.addAllowedHeader("*");
corsConfiguration.addAllowedMethod("*");
return corsConfiguration;
}
/**
* 跨域过滤器
*
* @return
*/
@Bean
public CorsFilter corsFilter() {
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration("/**", buildConfig());
return new CorsFilter(source);
}
}启动成功输出日志：
就表示集成成功了
接口测试
1. 启动项目，访问地址：http://localhost:9090/doc.html
如果，service和mapper文件中，@DS都不启用，则默认使用主库
以mapper文件举例（service同理）：
package com.md.demo.dao;
import com.md.demo.entity.vo.Users;
import java.util.List;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* Mapper 接口
* </p>
*
* @author Minbo
* @since 2020-03-27
*/
//@DS("slave_1")
public interface UsersMapper extends BaseMapper<Users> {
// 使用@DS注解，可以切换数据源。如果没有配置@DS，则使用默认数据源（使用配置文件中的primary源）
// @DS 可以注解在方法上和类上，同时存在方法注解优先于类上注解
// 注解在service实现或mapper接口方法上，但强烈不建议同时在service和mapper注解
// @DS("slave_1")
// @DS("master")
public List<Users> listDbInfo();
}
2. 如果启用@DS("slave_1")，再次测试结果如下
package com.md.demo.dao;
import com.md.demo.entity.vo.Users;
import java.util.List;
import com.baomidou.dynamic.datasource.annotation.DS;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* <p>
* Mapper 接口
* </p>
*
* @author Minbo
* @since 2020-03-27
*/
//@DS("slave_1")
public interface UsersMapper extends BaseMapper<Users> {
// 使用@DS注解，可以切换数据源。如果没有配置@DS，则使用默认数据源（使用配置文件中的primary源）
// @DS 可以注解在方法上和类上，同时存在方法注解优先于类上注解
// 注解在service实现或mapper接口方法上，但强烈不建议同时在service和mapper注解
@DS("slave_1")
// @DS("master")
public List<Users> listDbInfo();
}
完整源码下载
官方资料
同类资料
该系列教程
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
