前言:本内容主要是按照mybatis-plus官方文档实现。官网地址:https://mp.baomidou.com
优势
网上关于动态数据源的切换的文档有很多,核心只有两种。
- 构建多套环境,优势是方便控制也容易集成一些简单的分布式事务,缺点是非动态同时代码量较多,配置难度大。
- 基于spring提供原生的
AbstractRoutingDataSource
,参考一些文档自己实现切换。
如果你的数据源较少,场景不复杂,选择以上任意一种都可以。如果你需要更多特性,请尝试本动态数据源。
- 数据源分组,适用于多种场景 纯粹多库 读写分离 一主多从 混合模式。
- 简单集成Druid数据源监控多数据源,简单集成Mybatis-Plus简化单表,简单集成P6sy格式化sql,简单集成Jndi数据源。
- 简化Druid和HikariCp配置,提供全局参数配置。
- 提供自定义数据源来源(默认使用yml或properties配置)。
- 项目启动后能动态增减数据源。
- 使用spel动态参数解析数据源,如从session,header和参数中获取数据源。(多租户架构神器)
- 多层数据源嵌套切换。(一个业务ServiceA调用ServiceB,ServiceB调用ServiceC,每个Service都是不同的数据源)
- 使用正则匹配或spel表达式来切换数据源(实验性功能)。
#劣势
不能使用多数据源事务(同一个数据源下能使用事务),网上其他方案也都不能提供。
如果你需要使用到分布式事务,那么你的架构应该到了微服务化的时候了。
如果呼声强烈,项目达到800 star,作者考虑集成分布式事务。
PS: 如果您只是几个数据库但是有强烈的需求分布式事务,建议还是使用传统方式自己构建多套环境集成atomic这类,网上百度很多。
#约定
- 本框架只做 切换数据源 这件核心的事情,并不限制你的具体操作,切换了数据源可以做任何CRUD。
- 配置文件所有以下划线
_
分割的数据源 首部 即为组的名称,相同组名称的数据源会放在一个组下。 - 切换数据源即可是组名,也可是具体数据源名称,切换时默认采用负载均衡机制切换。
- 默认的数据源名称为 master ,你可以通过spring.datasource.dynamic.primary修改。
- 方法上的注解优先于类上注解。
#建议
强烈建议在 主从模式 下遵循普遍的规则,以便他人能更轻易理解你的代码。
主数据库 建议 只执行 INSERT
UPDATE
DELETE
操作。
从数据库 建议 只执行 SELECT
操作。
#使用方法
引入依赖:
<properties>
<java.version>1.8</java.version>
<mybatis-plus.version>3.0.5</mybatis-plus.version>
<velocity.version>2.0</velocity.version>
</properties>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>${velocity.version}</version>
</dependency>
<!--开发者工具-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
<!--mybatis-plus 持久层-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<!--添加tomcat-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.0.1</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<scope>runtime</scope>
</dependency>
主要是这个依赖:dynamic-datasource-spring-boot-starter<
接下来看看我的的配置文件:如果想配置多主多从,或者纯粹多库,混合配置的话,可以参考官网配置:https://mp.baomidou.com/guide/dynamic-datasource.html
# 服务端口
server.port=8099
# 服务名
spring.application.name=test
# 环境设置:dev、test、prod
spring.profiles.active=dev
# mysql数据库连接
spring.datasource.dynamic.primary=mysql
spring.datasource.dynamic.datasource.mysql.username=root
spring.datasource.dynamic.datasource.mysql.password=xxx
spring.datasource.dynamic.datasource.mysql.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.dynamic.datasource.mysql.url=jdbc:mysql://122.51.97.164:3306/jk?useSSL=false&serverTimezone=UTC
spring.datasource.dynamic.datasource.slave_1.username=root
spring.datasource.dynamic.datasource.slave_1.password=xxxx
spring.datasource.dynamic.datasource.slave_1.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.dynamic.datasource.slave_1.url=jdbc:mysql://127.0.0.1:3306/travel?useSSL=false&serverTimezone=UTC
#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
#返回json的全局时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
#spring.jackson.time-zone=GMT+8
接下来,我们看看我的数据表,我的数据表很简单,就是两个特别简单的表。
就是这两个表
下面贴出这两个实体类的代码
public class Ss {
Integer id;
String name;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public String toString() {
return "Ss{" +
"id=" + id +
", name='" + name + '\'' +
'}';
}
}
public class Tt {
Integer id;
String name;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public String toString() {
return "Tt{" +
"id=" + id +
", name='" + name + '\'' +
'}';
}
}
还有两个mapper的代码
public interface SsMapper extends BaseMapper<Ss> {
}
public interface TtMapper extends BaseMapper<Tt> {
}
然后是两个service的代码,里面的方法就是简单的全部查询。
public interface SsService extends IService<Ss> {
List<Ss> info();
}
public interface TtService extends IService<Tt> {
List<Tt> info();
}
两个impl的代码
@Service
@DS("mysql")
public class SsServiceImpl extends ServiceImpl<SsMapper, Ss> implements SsService {
@Autowired
private SsMapper ssMapper;
@Override
public List<Ss> info() {
List<Ss> sses = ssMapper.selectList(null);
return sses;
}
}
@Service
@DS("slave_1")
public class TtServiceImpl extends ServiceImpl<TtMapper, Tt> implements TtService {
@Autowired
private TtMapper ttMapper;
@Override
public List<Tt> info() {
List<Tt> tts = ttMapper.selectList(null);
return tts;
}
}
这里我们实现动态数据源,主要就是用得到@DS注解。
下面是我从官网拷贝来的
使用 @DS 切换数据源。
@DS 可以注解在方法上和类上,同时存在方法注解优先于类上注解。
注解在service实现或mapper接口方法上,但强烈不建议同时在service和mapper注解。 (可能会有问题)
注解 结果
没有@DS 默认数据源
@DS("dsName") dsName可以为组名也可以为具体某个库的名称
就是@DS里面写自己在配置文件中的数据库,配置文件中可以配置很多数据源,都像我的impl里面的添加注解就行
ok!到此我们就算简单实现了动态数据源的配置,接下来我们就测试一下吧。
我么写两个test方法
@Test
public void contextLoads() {
List<Tt> info = ttService.info();
System.out.println(info);
}
@Test
public void contextLoad() {
List<Ss> info = ssService.info();
System.out.println(info);
}
执行第一个测试方法
测试第二个测试方法。
怎么样,是不是超级简单就实现了动态数据源,相比传统的aop实现动态数据源,这样是不是超级简单?
我们这样就实现了多个数据库查询数据,简单实现了动态数据源。在这里我们多感谢mybatis-plus开发人员,给我们提供了这么好的开发工具,真的是帮我们解决了很多开发中繁琐的事情。
如果有问题的话,欢迎给我留言。
相关代码在github上:https://github.com/Wujungang/more-datasources.git