「这是我参与2022首次更文挑战的第13天,活动详情查看:2022首次更文挑战」
前言
在我们开发项目当中,一个大的项目,可能有多个数据源,可能是多主多从、多数据库、混合配置等各种情况,那么本次就基于dynamic-datasource-spring-boot-starter进行多数据源配置。
开发环境
开发工具IDEA JDK1.8 Spring Boot 2.3.0 mybatis-plus 3.3.0
介绍
dynamic-datasource-spring-boot-starter是 mybatis-plus成员中小锅盖个人发起的项目,是一个基于springboot的快速集成多数据源的启动器。
特点
- 支持 数据源分组 ,适用于多种场景 纯粹多库 读写分离 一主多从 混合模式。
- 支持数据库敏感配置信息 加密 ENC()。
- 支持每个数据库独立初始化表结构schema和数据库database。
- 支持无数据源启动,支持懒加载数据源(需要的时候再创建连接)。
- 支持 自定义注解 ,需继承DS(3.2.0+)。
- 提供并简化对Druid,HikariCp,BeeCp,Dbcp2的快速集成。
- 提供对Mybatis-Plus,Quartz,ShardingJdbc,P6sy,Jndi等组件的集成方案。
- 提供 自定义数据源来源 方案(如全从数据库加载)。
- 提供项目启动后 动态增加移除数据源 方案。
- 提供Mybatis环境下的 纯读写分离 方案。
- 提供使用 spel动态参数 解析数据源方案。内置spel,session,header,支持自定义。
- 支持 多层数据源嵌套切换 。(ServiceA >>> ServiceB >>> ServiceC)。
- 提供 **基于seata的分布式事务方案。
- 提供 本地多数据源事务方案。
约定
- 本框架只做 切换数据源 这件核心的事情,并不限制你的具体操作,切换了数据源可以做任何CRUD。
- 配置文件所有以下划线 _ 分割的数据源 首部 即为组的名称,相同组名称的数据源会放在一个组下。
- 切换数据源可以是组名,也可以是具体数据源名称。组名则切换时采用负载均衡算法切换。
- 默认的数据源名称为 master ,你可以通过 spring.datasource.dynamic.primary 修改。
- 方法上的注解优先于类上注解。
- DS支持继承抽象类上的DS,暂不支持继承接口上的DS。
快速开始
引入依赖
本次Spring Boot 多数据源配置示例是基于mybatis-plus和dynamic-datasource-spring-boot-starter共同实现的,主要还是dynamic-datasource-spring-boot-starter。提供了多数据源配置启动器
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>3.3.0</version>
</dependency>
复制代码
示例介绍
本次将基于主从两个数据源进行配置,只做为简单的示例演示。通过不同的接口,查询两个数据库相同表的信息。创建演示表的SQL如下:
CREATE TABLE `s_user` (
`userid` int(11) NOT NULL AUTO_INCREMENT,
`user_name` varchar(255) DEFAULT NULL,
`name` varchar(255) DEFAULT NULL,
`pass_word` varchar(255) DEFAULT NULL,
`salt` varchar(255) DEFAULT NULL,
`state` varchar(255) DEFAULT NULL,
`create_time` datetime DEFAULT NULL,
PRIMARY KEY (`userid`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
复制代码
数据源配置
引入两个数据源master和slave_1。在项目中查询不同的数据源,数据库中信息不同。
server.port=8888
swagger.enable=true
spring.datasource.dynamic.primary=master
spring.datasource.dynamic.strict=false
spring.datasource.dynamic.datasource.master.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull
spring.datasource.dynamic.datasource.master.username=test
spring.datasource.dynamic.datasource.master.password=123456789
spring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.dynamic.datasource.slave_1.url=jdbc:mysql://127.0.0.1:3306/test_save?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull
spring.datasource.dynamic.datasource.slave_1.username=test_save
spring.datasource.dynamic.datasource.slave_1.password=123456789
spring.datasource.dynamic.datasource.slave_1.driver-class-name=com.mysql.cj.jdbc.Driver
复制代码
测试数据
其中master库中表的用户信息如下:
其中slave_1库中表的用户信息如下:
启动类
/**
* 公众号:Java全栈架构师
* 掘金: 小阿杰
*/
@SpringBootApplication
@MapperScan(value = "com.example.demo.mapper")
public class DemoBootMybatisPlusDataSourceApplication {
public static void main(String[] args) {
SpringApplication.run(DemoBootMybatisPlusDataSourceApplication.class, args);
}
}
复制代码
测试接口
针对两个数据源,编写两个测试接口,然后通过接口调用不同的方法,看是否查询返回不同的数据库中的信息。
@Api(description = "用户管理")
@RequestMapping("user")
@RestController
public class UserController {
@Resource
private UserService userService;
//公众号:Java全栈架构师
@ApiOperation(value = "master根据用户名获取用户")
@RequestMapping(value = "getMasterUserList",method = RequestMethod.GET)
public List<User> getMasterUserList(){
return userService.list();
}
// 作者:掘金 小阿杰
@ApiOperation(value = "slave_1根据用户名获取用户")
@RequestMapping(value = "getUserList",method = RequestMethod.GET)
public List<User> getUserList(){
return userService.getUserList();
}
}
复制代码
实现
dynamic-datasource-spring-boot-starter提供了多数据源配置启动器中,默认使用的是master数据源。在我们需要切换数据源时可以使用@DS 切换数据源。@DS 可以注解在方法上或类上,同时存在就近原则 。
方法上注解 优先于 类上注解。 如下代码中示例,getUserList()方法上注解了@DS("slave_1"),所以优先查询的是slave_1库的数据信息
@Service
@DS("master")
public class UserServiceImpl extends ServiceImpl< UserMapper,User> implements UserService {
@Resource
private UserMapper userMapper;
@Override
@DS("slave_1")
public List<User> getUserList() {
System.out.println("slave_1");
List<User> list = userMapper.selectList(new QueryWrapper<User>());
System.out.println(list);
return list;
}
}
复制代码
运行演示
将项目启动完成之后,在浏览器输入地址信息,在Swagger中调用接口。 获取master库中用户表的所有用户信息,查询结果如下:
获取slave_1库中用户表的所有用户信息,查询结果如下:
结语
好了,以上就是Spring Boot 多数据源配置示例的介绍,感谢您的阅读,希望您喜欢,如对您有帮助,欢迎点赞收藏。如有不足之处,欢迎评论指正。下次见。
作者介绍:【小阿杰】一个爱鼓捣的程序猿,JAVA开发者和爱好者。公众号【Java全栈架构师】维护者,欢迎关注阅读交流。