mybatis-flex实现多数据源操作

 更新时间:2024年06月24日 10:12:12   作者:kunkun2580  
MyBaits-Flex内置了功能完善的多数据源支持,本文主要介绍了mybatis-flex实现多数据源操作,具有一定的参考价值,感兴趣的可以了解一下

多数据源

MyBaits-Flex 内置了功能完善的多数据源支持^1.0.6,不需要借助第三方插件或者依赖,开箱即用, 支持包括 druidhikaricpdbcp2beecp 在内的任何数据源,MyBatis-Flex 多数据源配置如下:

mybatis-flex:
  datasource:
    ds1:
      url: jdbc:mysql://127.0.0.1:3306/db
      username: root
      password: 123456
    ds2:
      url: jdbc:mysql://127.0.0.1:3306/db2
      username: root
      password: 123456

在以上配置中,ds1 和 ds2 是由用户自定义的,我们可以理解为数据源的名称,或者数据源的 key,这个在动态切换数据库中非常有用。

在无 Spring 框架的场景下,代码如下:

DataSource dataSource1 = new HikariDataSource();
dataSource1.setJdbcUrl(....)

DataSource dataSource2 = new HikariDataSource();
dataSource2.setJdbcUrl(....)

DataSource dataSource3 = new HikariDataSource();
dataSource3.setJdbcUrl(....)

MybatisFlexBootstrap.getInstance()
        .setDataSource("ds1", dataSource1)
        .addDataSource("ds2", dataSource2)
        .addDataSource("ds3", dataSource3)
        .start();

开始使用

默认使用第一个配置的数据源:

List<Row> rows = Db.selectAll("tb_account");
System.out.println(rows);

通过编码的方式,切换到数据源 ds2

try{
    DataSourceKey.use("ds2")
    List<Row> rows = Db.selectAll("tb_account");
    System.out.println(rows);
}finally{
    DataSourceKey.clear();
}

或者

List<Row> rows =  DataSourceKey.use("ds2"
    , () -> Db.selectAll("tb_account"));

数据源切换(设置)

MyBatis-Flex 提供了 4 种方式来配置数据源:

  • 1、编码,使用DataSourceKey.use 方法。
  • 2、@UseDataSource("dataSourceName") 在 Mapper 类上,添加注解,用于指定使用哪个数据源。
  • 3、@UseDataSource("dataSourceName") 在 Mapper 方法上,添加注解,用于指定使用哪个数据源。
  • 4、@Table(dataSource="dataSourceName") 在 Entity 类上添加注解,该 Entity 的增删改查请求默认使用该数据源。

在 SpringBoot 项目上,@UseDataSource("dataSourceName") 也可用于在 Controller 或者 Service 上。若是 Spring 项目(非 SpringBoot), 用户需要参考 MultiDataSourceAutoConfiguration 进行配置后才能使用。

DataSourceKey.use 示例:

try{
    DataSourceKey.use("ds2")
    List<Row> rows = Db.selectAll("tb_account");
    System.out.println(rows);
}finally{
    DataSourceKey.clear();
}

@UseDataSource("dataSourceName") 示例:

@UseDataSource("ds2")
interface AccountMapper extends BaseMapper{
    List<Account> myMethod();
}

或者

interface AccountMapper extends BaseMapper{

    @UseDataSource("ds2")
    List<Account> myMethod();
}

@Table(dataSource="dataSourceName") 示例:

@Table(value = "tb_account", dataSource = "ds2")
public class Account {

    @Id(keyType = KeyType.Auto)
    private Long id;

    private String userName;
}

数据源配置的优先级

DataSourceKey.use() > @UseDataSource()在方法上 > @UseDataSource()在类上 >@Table(dataSource="...")

更多的 Spring Yaml 配置支持

mybatis-flex:
  datasource:
    ds1:
      url: jdbc:mysql://127.0.0.1:3306/db
      username: root
      password: 123456
    ds2:
      url: jdbc:mysql://127.0.0.1:3306/db2
      username: root
      password: 123456

在以上配置中,ds1 和 ds2 并未指定使用哪个数据连接池,MyBatis-Flex 会 自动探测 当前项目依赖了哪个连接池。 目前支持了 druidhikaricpdbcp2beecp 的自动探测,如果项目中使用的不是这 4 种类型只有,需要添加 type 配置,如下所示:

mybatis-flex:
  datasource:
    ds1:
      type: com.your.datasource.type1
      url: jdbc:mysql://127.0.0.1:3306/db
      username: root
      password: 123456
    ds2:
      type: com.your.datasource.type2
      url: jdbc:mysql://127.0.0.1:3306/db2
      username: root
      password: 123456

同时,项目若使用到了多个数据源类型,则也需要添加 type 来指定当前数据源的类型。

除了 typeurlusernamepassword 的配置以外,MyBatis-Flex 支持该 DataSource 类型的所有参数配置, 例如,在 DruidDataSource 类中存在 setAsyncInit 方法,我们就可以添加 asyncInit 的配置,如下所示:

mybatis-flex:
  datasource:
    ds1:
      type: druid
      url: jdbc:mysql://127.0.0.1:3306/db
      username: root
      password: 123456
      asyncInit: true
    ds2:
      type: com.your.datasource.type2
      url: jdbc:mysql://127.0.0.1:3306/db2
      username: root
      password: 123456

因此,只要该 DataSource 有 setter 方法,我们就可以在配置文件中进行配。与此相反的是:若该 DataSource 类型没有该属性,则不能使用这个配置。

提示

在数据源的配置中,type 可以配置为某个 DataSource 的类名,也可以配置为别名,别名支持有:druid、 hikarihikaricpbeebeecpdbcpdbcp2

动态添加新的数据源

在多租户等某些场景下,我们可能需要用到动态的添加新的数据源,此时可以通过如下的方式进行添加。

FlexDataSource flexDataSource = FlexGlobalConfig.getDefaultConfig()
                                .getDataSource();

//新的数据源
HikariDataSource newDataSource = new HikariDataSource();

flexDataSource.addDataSource("newKey", newDataSource);

需要注意的是: 通过 FlexGlobalConfig 去获取 FlexDataSource 时,需等待应用完全启动成功后,才能正常获取 FlexDataSource, 否则将会得到 null 值。

Spring 用户可以通过 ApplicationListener 去监听 ContextRefreshedEvent 事件,然后再去添加新的数据源,如下代码所示:

public class DataSourceInitListener implements ApplicationListener<ContextRefreshedEvent> {

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        FlexDataSource dataSource = FlexGlobalConfig.getDefaultConfig()
                                    .getDataSource();

        dataSource.addDataSource("....", new DruidDataSource("..."));
    }

}

多数据源负载均衡 ^1.5.4

数据源负载均衡指的是:在进行数据查询的时候,随机使用一个数据源。 这是的在高并发的场景下,起到负载的效果。

假设多数据源配置如下:

mybatis-flex:
  datasource:
    ds1:
      type: druid
      url: jdbc:mysql://127.0.0.1:3306/db
      username: root
      password: 123456
      asyncInit: true
    ds2:
      type: com.your.datasource.type2
      url: jdbc:mysql://127.0.0.1:3306/db2
      username: root
      password: 123456
    other:
      type: com.your.datasource.type2
      url: jdbc:mysql://127.0.0.1:3306/db2
      username: root
      password: 123456

以上配置了三个数据源,分别为:ds1ds2other,假设我们想负载均衡使用 ds1ds2 ,那么代码如下:

try{
    DataSourceKey.use("ds*");
    List<Row> rows = Db.selectAll("tb_account");
    System.out.println(rows);
}finally{
    DataSourceKey.clear();
}

DataSourceKey.use("ds*") 中的 ds* 指的是使用 ds 开头的任意一个数据源。ds* 必须以 "*" 结尾, 中间不能有空格,比如 "ds *" 中间有空格是不行的。

到此这篇关于mybatis-flex实现多数据源操作的文章就介绍到这了,更多相关mybatis-flex 多数据源操作内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot+Jersey跨域文件上传的实现示例

    SpringBoot+Jersey跨域文件上传的实现示例

    在SpringBoot开发后端服务时,我们一般是提供接口给前端使用,本文主要介绍了SpringBoot+Jersey跨域文件上传的实现示例,具有一定的参考价值,感兴趣的可以了解一下
    2024-07-07
  • Java this关键字的使用详解

    Java this关键字的使用详解

    this 关键字是 Java 常用的关键字,可用于任何实例方法内指向当前对象,也可指向对其调用当前方法的对象,或者在需要当前类型对象引用时使用
    2021-11-11
  • SpringBoot使用 Sleuth 进行分布式跟踪的过程分析

    SpringBoot使用 Sleuth 进行分布式跟踪的过程分析

    Spring Boot Sleuth是一个分布式跟踪解决方案,它可以帮助您在分布式系统中跟踪请求并分析性能问题,Spring Boot Sleuth是Spring Cloud的一部分,它提供了分布式跟踪的功能,本文将介绍如何在Spring Boot应用程序中使用Sleuth进行分布式跟踪,感兴趣的朋友一起看看吧
    2023-10-10
  • SpringBoot整合MongoDB的步骤详解

    SpringBoot整合MongoDB的步骤详解

    这篇文章主要介绍了SpringBoot整合MongoDB的步骤详解,帮助大家更好的理解和学习使用SpringBoot框架,感兴趣的朋友可以了解下
    2021-04-04
  • Java检测网络是否正常通讯

    Java检测网络是否正常通讯

    在网络应用程序中,检测IP地址和端口是否通常是必要的,本文主要介绍了Java检测网络是否正常通讯,具有一定的参考价值,感兴趣的可以了解一下
    2023-11-11
  • Java heap space OOM 精准定位与体系化排查方案详解

    Java heap space OOM 精准定位与体系化排查方案详解

    精准定位Java堆内存溢出(OOM)需要结合监控、JVM参数、内存快照和可视化工具,本文介绍Java heap space OOM 精准定位与体系化排查方案,感兴趣的朋友一起看看吧
    2026-04-04
  • Java中消息队列任务的平滑关闭详解

    Java中消息队列任务的平滑关闭详解

    对于消息队列的监听,我们一般使用Java写一个独立的程序,在Linux服务器上运行。程序启动后,通过消息队列客户端接收消息,放入一个线程池进行异步处理,并发的快速处理。这篇文章主要给大家介绍了关于Java中消息队列任务的平滑关闭的相关资料,需要的朋友可以参考下。
    2017-11-11
  • Java中this关键字用法梳理详细讲解

    Java中this关键字用法梳理详细讲解

    this关键字是java常用的关键字,可用于任何实例方法内指向当前对象,也可指向对其调用当前方法的对象,下面这篇文章主要介绍了Java中this关键字用法梳理的相关资料,需要的朋友可以参考下
    2025-07-07
  • SpringBoot3集成SLF4J+logback进行日志记录的实现

    SpringBoot3集成SLF4J+logback进行日志记录的实现

    本文主要介绍了SpringBoot3集成SLF4J+logback进行日志记录的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • Spring中的注解之@Override和@Autowired

    Spring中的注解之@Override和@Autowired

    看别人写的代码,经常会用到 @Override 和 @Autowired 这两个注解.这边总结一下这两个注解的作用,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-05-05

最新评论