Mybatis源码和设计模式(数据源创建和和策略模式)

码炫课堂-码哥

于 2024-05-06 15:01:06 发布

阅读量1.2k

点赞数 27

CC 4.0 BY-SA版权

分类专栏： mybatis专题文章标签： mybatis 设计模式策略模式

本文链接：https://blog.youkuaiyun.com/smart_an/article/details/138495443

mybatis专题专栏收录该内容

44 篇文章

订阅专栏

作者简介：大家好，我是smart哥，前中兴通讯、美团架构师，现某互联网公司CTO

联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬

学习必须往深处挖，挖的越深，基础越扎实！

阶段1、深入多线程

 阶段2、深入多线程设计模式

 阶段3、深入juc源码解析

阶段4、深入jdk其余源码解析

阶段5、深入jvm源码解析

码哥源码部分

码哥讲源码-原理源码篇【2024年最新大厂关于线程池使用的场景题】

码哥讲源码【炸雷啦！炸雷啦！黄光头他终于跑路啦！】

码哥讲源码-【jvm课程前置知识及c/c++调试环境搭建】

码哥讲源码-原理源码篇【揭秘join方法的唤醒本质上决定于jvm的底层析构函数】

码哥源码-原理源码篇【Doug Lea为什么要将成员变量赋值给局部变量后再操作？】

码哥讲源码【你水不是你的错,但是你胡说八道就是你不对了！】

码哥讲源码【谁再说Spring不支持多线程事务，你给我抽他！】

终结B站没人能讲清楚红黑树的历史，不服等你来踢馆！

打脸系列【020-3小时讲解MESI协议和volatile之间的关系，那些将x86下的验证结果当作最终结果的水货们请闭嘴】

数据源创建和和策略模式

一、数据源

在10-Mybatis源码和设计模式-1(数据源模块和工厂模式，代理模式)中我们了解了数据源模块有三种类型，POOL，UNPOOL和JNDI三种，知道这三种类型的数据源都是通过工厂模式创建出来的，但没有分析数据源的创建过程和创建的策略，仅仅只是静态分析了源码结构。数据源的类型由Environment里的type指定，对于客户端来说不管底层是如何创建数据源的都没有关系，只需要修改配置就能够生产出3种不同类型的数据源。而这种思想恰好和策略模式相符合，因此数据源的创建使用了策略模式。
关于策略模式后面再说

1.1 配置

配置示例如下:

    <!--配置environment环境 -->
        <environments default="development">
            <!-- 环境配置1，每个SqlSessionFactory对应一个环境 -->
            <environment id="development">
                <transactionManager type="JDBC"/>
                <!-- 配置数据源类型 -->
                <dataSource type="POOLED">
                    <property name="driver" value="${jdbc_driver}"/>
                    <property name="url" value="${jdbc_url}"/>
                    <property name="username" value="${jdbc_username}"/>
                    <property name="password" value="${jdbc_password}"/>
                </dataSource>
            </environment>
            <environment id="other">
                <transactionManager type="JDBC"/>
                <!-- 配置数据源类型 -->
                <dataSource type="POOLED">
                    <property name="driver" value="${jdbc_driver_other}"/>
                    <property name="url" value="${jdbc_url_other}"/>
                    <property name="username" value="${jdbc_username_other}"/>
                    <property name="password" value="${jdbc_password_other}"/>
                </dataSource>
            </environment>
        </environments>

1.2 源码

这小节我们通过跟踪源码来看数据源模块的创建过程，这个过程中会解析Mybatis的配置文件生产Configuration对象，而数据源类型的配置是在主配置文件的environments节点，由此容易推测数据源的创建应该是在environments节点解析的入口里面。我直接定位到XMLConfigBuilder#parseConfiguration方法，该方法是解析的主流程，而XMLConfigBuilder#environmentsElement就是解析environments节点的入口，也是我们想要找的。

1.2.1 XMLConfigBuilder#environmentsElement

XMLConfigBuilder#environmentsElement是解析主配置文件environments节点的方法

    /**
       * 解析environments节点，数据源的初始化在该流程里面完成
       * */
      private void environmentsElement(XNode context) throws Exception {
        if (context != null) {
          //1.根据default获取到多个环境中默认的那一个环境的id
          if (environment == null) {
            environment = context.getStringAttribute("default");
          }
          //2.依次遍历解析所有environment子节点
          for (XNode child : context.getChildren()) {
            //3.获取到id
            String id = child.getStringAttribute("id");
            //4.和default获取到的id一样的才是目标environment,其余的都不需要解析
            if (isSpecifiedEnvironment(id)) {
              //5.解析transactionManager节点
              TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
              //6.解析dataSource节点，得到数据源工厂
              DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
              //7.工厂模式，由数据源工厂得到数据源(这部分可以参考: https://blog.youkuaiyun.com/my_momo_csdn/article/details/93489371)
              DataSource dataSource = dsFactory.getDataSource();
              //8.创建Environment，很显然使用了建造者模式
              Environment.Builder environmentBuilder = new Environment.Builder(id)
                  .transactionFactory(txFactory)
                  .dataSource(dataSource);
              //9.将Environment设置到Configuration对象里面去
              configuration.setEnvironment(environmentBuilder.build());
            }
          }
        }
      }

1.2.2 XMLConfigBuilder#dataSourceElement

XMLConfigBuilder#dataSourceElement是解析主配置文件dataSource子节点的方法。

    /**
       *解析主配置文件dataSource子节点
       * */
      private DataSourceFactory dataSourceElement(XNode context) throws Exception {
        if (context != null) {
            //1.获取数据源类型
          String type = context.getStringAttribute("type");
          //2.获取子节点属性；其实是获取所有的name和value属性，封装到Properties里面，通常这里包含了driver，url，username，password的信息
          Properties props = context.getChildrenAsProperties();
          //3.通过类型获取对应类型的的数据源工厂，这里会到TypeAliasRegistry.TYPE_ALIASES这个Map里面去找type对应的类型
          //通常情况这里面保存的是类的别名和类的Class对象，但是Mybatis把pool，unpool，jndi也保存在里面，对应的类型是对应的工厂类
          //因此获取到之后再newInstance就得到了工厂实例, 最后调用的是TypeAliasRegistry.resolveAlias方法
          DataSourceFactory factory = (DataSourceFactory) resolveClass(type).newInstance();
          //4.数据源工厂是可以设置属性的，这些属性最后都会设置给数据源DataSource
          factory.setProperties(props);
          return factory;
        }
        //6.没有配置dataSource节点需要抛出异常
        throw new BuilderException("Environment declaration requires a DataSourceFactory.");
      }
      
      
      public <T> Class<T> resolveAlias(String string) {
        try {
          if (string == null) {
            return null;
          }
          // issue #748
          String key = string.toLowerCase(Locale.ENGLISH);
          Class<T> value;
          //通过类别名到TYPE_ALIASES查找对应的类型，得到Class对象
          if (TYPE_ALIASES.containsKey(key)) {
            value = (Class<T>) TYPE_ALIASES.get(key);
          } else {
            value = (Class<T>) Resources.classForName(string);
          }
          return value;
        } catch (ClassNotFoundException e) {
          throw new TypeException("Could not resolve type alias '" + string + "'.  Cause: " + e, e);
        }
      }

下面是我调试的时候，查看到的TypeAliasRegistry.TYPE_ALIASES这个map里保存的别名和类的对应关系：

到此我们看到了数据源的创建过程 : 获取配置->策略模式实例化工厂->获取数据源->构建Environment；
详细步骤如下所示。

    ->解析environments节点
    ->获取default表示的id
    ->找到对应id的environment配置
    ->获取transactionManager配置
    ->获取driver，url，username，password配置
    ->根据别名找到对应的工厂类，实例化工厂类->设置属性给工厂类
    ->从工厂获取数据源dataSource
    ->builder模式创建Environment，传入transactionManager和dataSource参数构造Environment对象
    ->将Environment对象设置到Configuration对象