前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >苞米豆的多数据源 → dynamic-datasource-spring-boot-starter,挺香的!

苞米豆的多数据源 → dynamic-datasource-spring-boot-starter,挺香的!

作者头像
青石路
发布2023-04-28 19:24:03
5.4K1
发布2023-04-28 19:24:03
举报
文章被收录于专栏:开发技术

MyBatis-Plus 多数据源

  关于苞米豆(baomidou),我们最熟悉的肯定是 MyBatis-Plus

  但旗下还有很多其他优秀的组件

  多数据源就是其中一个,今天我们就来会会它

  数据源准备

  用 docker 准备一个 MySQL 和 SQL Server ,图省事,两个数据库服务器放到同个 docker 下了

  有小伙伴会觉得放一起不合适,有单点问题!

  楼主只是为了演示,纠结那么细,当心敲你狗头

MySQL 版本: 8.0.27

  建库: datasource_mysql ,建表: tbl_user ,并插入初始化数据

代码语言:javascript
复制
CREATE DATABASE datasource_mysql;
USE datasource_mysql;
CREATE TABLE tbl_user (
    id INT UNSIGNED NOT NULL AUTO_INCREMENT,
    user_name VARCHAR(50),
    PRIMARY KEY(id)
);
INSERT INTO tbl_user(user_name) VALUES('张三'),('李四');

SQL Server 版本: Microsoft SQL Server 2017 ... ,是真长,跟楼主一样长!

  建库: datasource_mssql ,建表: tbl_order ,并插入初始化数据

代码语言:javascript
复制
CREATE DATABASE datasource_mssql;
USE datasource_mssql;
CREATE TABLE tbl_order(
    id BIGINT PRIMARY KEY IDENTITY(1,1),
    order_no NVARCHAR(50),
    created_at DATETIME NOT NULL DEFAULT(GETDATE()),
    updated_at DATETIME NOT NULL DEFAULT(GETDATE())
);
INSERT INTO tbl_order(order_no) VALUES('123456'),('654321');

  dynamic-datasource 使用

  基于 spring-boot 2.2.10.RELEASE 、 mybatis-plus 3.1.1 搭建

dynamic-datasource-spring-boot-starter 也是 3.1.1

  依赖很简单, pom.xml

代码语言:javascript
复制
<?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>

    <groupId>com.lee</groupId>
    <artifactId>mybatis-plus-dynamic-datasource</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.10.RELEASE</version>
    </parent>

    <properties>
        <java.version>1.8</java.version>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <mybatis-plus-boot-starter.version>3.1.1</mybatis-plus-boot-starter.version>
        <mssql-jdbc.version>6.2.1.jre8</mssql-jdbc.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus-boot-starter.version}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
            <version>${mybatis-plus-boot-starter.version}</version>
        </dependency>
        <!-- MySQL驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!-- SQL Server 驱动-->
        <dependency>
            <groupId>com.microsoft.sqlserver</groupId>
            <artifactId>mssql-jdbc</artifactId>
            <version>${mssql-jdbc.version}</version>
        </dependency>
    </dependencies>
</project>

  配置也很简单, application.yml

代码语言:javascript
复制
server:
  port: 8081
spring:
  application:
    name: dynamic-datasource
  datasource:
    dynamic:
      datasource:
        mssql_db:
          driver-class-name: com.microsoft.sqlserver.jdbc.SQLServerDriver
          url: jdbc:sqlserver://10.5.108.225:1433;DatabaseName=datasource_mssql;IntegratedSecurity=false;ApplicationIntent=ReadOnly;MultiSubnetFailover=True
          username: sa
          password: Root#123456
        mysql_db:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://10.5.108.225:3306/datasource_mysql?useSSL=false&useUnicode=true&characterEncoding=utf-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=Asia/Shanghai
          username: root
          password: 123456
      primary: mssql_db
      strict: false

mybatis-plus:
  mapper-locations: classpath:mappers/*.xml
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

  然后在对应的类或者方法上加上注解 DS("数据源名称") 即可,例如

  我们来看下效果

  是不是很神奇?

  完整代码:mybatis-plus-dynamic-datasource

  原理探究

@DS 用于指定数据源,可以注解在方法上或类上,同时存在则采用就近原则 方法上注解 优先于 类上注解

  这可不是我瞎说,官方文档就是这么写的

  难道一个 @DS 就有如此强大的功能?你们不信,我也不信,它背后肯定有人!

  那么我们就来揪一揪背后的它

  怎么揪了,这又是个难题,我们先打个断点,看一下调用栈

  点一下,瞬间高潮了,不是,是瞬间清醒了

  红线框住的,分 2 点:1: determineDatasource ,2: DynamicDataSourceContextHolder.push

  我们先看 determineDatasource

  1、获取 Method 对象

  2、该方法上是否有 DS 注解,有则取方法的 DS 注解,没有则取方法对应的类上的 DS 注解;这个看明白了没?

  3、获取注解的值,也就是 @DS("mysql_db") 中的 mysql_db

  4、如果数据源名不为空并且数据原名以动态前缀(#)开头,则你们自己去跟 dsProcessor.determineDatasource

    否则则直接返回数据源名

  针对案例的话,这里肯定是返回类上的数据源名(方法上没有指定数据源,也没有以动态前缀开头)

  我们再来看看 DynamicDataSourceContextHolder.push

  很简单,但 LOOKUP_KEY_HOLDER 很有意思

  是一个栈,而非楼主在spring集成mybatis实现mysql读写分离 采用的

  至于为什么,人家注释已经写的很清楚了,试问楼主的实现能满足一级一级数据源切换的调用场景吗?

  但不管怎么说, LOOKUP_KEY_HOLDER 的类型还是 ThreadLocal

  接下来该分析什么?

  我们回顾下:原理解密 → Spring AOP 实现动态数据源(读写分离),底层原理是什么

  直接跳到总结

   框住的 3 条,上面的 2 条在上面已经分析过了把,是不是?你回答是就完事了

  注意,楼主的 DynamicDataSource 是自实现的类,继承了 spring-jdbc 的 AbstractRoutingDataSource

  那我们就找 AbstractRoutingDataSource 的实现类呗

  发现它就一个实现类,并且是在 spring-jdbc 下,而不是在 com.baomidou 下

  莫非苞米豆有自己的 AbstractRoutingDataSource ? 我们来看看 AbstractDataSource 的实现类有哪些

  看到了没,那么我们接下来就分析它

  内容很简单,最重要的 determineDataSource 还是个抽象方法,那没办法了,看它有哪些子类实现

DynamicRoutingDataSource 的 determineDataSource 方法如下

DynamicDataSourceContextHolder 有没有感觉到熟悉?

  想想它的 ThreadLocal<Deque<String>> LOOKUP_KEY_HOLDER ,回忆上来了没?

  出栈,获取到当前的数据源名;接下来该分析谁了?

  那肯定是 getDataSource 方法

  1、如果数据源为空,那么直接返回默认数据源,对应配置文件中的

  2、分组数据源,我们的示例代码那么简单,应该没涉及到这个,先不管

  3、所有数据源,是一个 LinkHashMap ,key 是 数据源名 ,value 是数据源

    可想而知,我们示例的数据源获取就是从该 map 获取的

  4、是否启用严格模式,默认不启动。严格模式下未匹配到数据源直接报错,,非严格模式下则使用默认数据源 primary 所设置的数据源

  5、对应 4,未开启严格模式,未匹配到数据源则使用 primary 所设置的数据源

  那现在又该分析谁?肯定是 dataSourceMap 的值是怎么 put 进去的

  我们看哪些地方用到了 dataSourceMap

  发现就一个地方进行了 put

  那这个 addDataSource 方法又在哪被调用了?

DynamicRoutingDataSource 实现了 InitializingBean ,所以在启动过程中,它的 afterPropertiesSet 方法会被调用,至于为什么,大家自行去查阅

  接下来该分析什么?那肯定是 Map<String, DataSource> dataSources = provider.loadDataSources();

  我们跟进 loadDataSources() ,发现有两个类都有该方法

  那么我们应该跟谁?有两种方法

  1、凭感觉,我们的配置文件是 yml

  2、打断点,重新启动项目,一目了然

YmlDynamicDataSourceProvider 的 loadDataSources 方法如下

  (这里留个疑问: dataSourcePropertiesMap 存放的是什么,值是如何 put 进去的?

  继续往下跟 createDataSourceMap 方法

  1、配置文件中的数据源属性,断点下就很清楚了

  2、根据数据源属性创建数据源,然后放进 dataSourceMap 中

  创建数据源的过程就不跟了,感兴趣的自行去研究

  至此,不知道大家清楚了没? 我反正是晕了

总结

  1、万变不离其宗,多数据源的原理是不变的

原理解密 → Spring AOP 实现动态数据源(读写分离),底层原理是什么

  2、苞米豆的多数据源的自动配置类

    com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceAutoConfiguration

    这个配置类很重要,很多重要的对象都是在这里注入到 Spring 容器中的

    关于自动配置,大家可参考:springboot2.0.3源码篇 - 自动配置的实现,发现也不是那么复杂

  3、遇到问题,不要立马一头扎进去,自己实现,多查查,看是否有现成的第三方实现

    自己实现,很容易踩别人踩过的坑,容易浪费时间;另外局限性太大,不易拓展,毕竟一人之力有限

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2023-04-21,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • MyBatis-Plus 多数据源
    •   数据源准备
      •   dynamic-datasource 使用
        •   原理探究
        • 总结
        相关产品与服务
        云数据库 SQL Server
        腾讯云数据库 SQL Server (TencentDB for SQL Server)是业界最常用的商用数据库之一,对基于 Windows 架构的应用程序具有完美的支持。TencentDB for SQL Server 拥有微软正版授权,可持续为用户提供最新的功能,避免未授权使用软件的风险。具有即开即用、稳定可靠、安全运行、弹性扩缩等特点。
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档