Mybatis源码分析（2）---初始化配置文件

最新推荐文章于 2023-01-19 14:52:08 发布
最新推荐文章于 2023-01-19 14:52:08 发布
阅读量4.4k 收藏
点赞数 1
分类专栏： Mybatis 文章标签： mybatis 源码
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40685915/article/details/89355405
版权
1. 背景

上篇博客Mybatis源码分析（1）—mybatis简单入门中，我们通过搭建Mybatis的Demo工程mybatisCode，大概了解了整个mybatis运行的过程，是通过SqlSessionFactoryBuilder类，利用配置文件的输入流，创建了SqlSessionFactory，最后创建了SqlSession会话去执行Sql查询信息，具体代码我们可以回顾一下：
在这里插入图片描述

2. MyBatis初始化过程

本篇文章开始，我们依然围绕的Demo工程mybatisCode，从SqlSessionFactoryBuilder类出发，层层解析mybatis配置文件初始化的过程，可以使用下面简单的图来展示.
在这里插入图片描述

2.1 SqlSessionFactoryBuilder类源码解析
  1. 类结构：
    在这里插入图片描述
    通过SqlSessionFactoryBuilder类的源码结构中，我们可以看出来，整个SqlSessionFactoryBuilder类都是用来创建SqlSessionFactory对象的，创建的方式大体分为三种：
    第一种：读取配置文件mybatis-config.xml，解析成Inpustream流的方式来创建；
    第二种：读取配置文件mybatis-config.xml，解析成Reader流的方式来创建；
    第三种：通过配置Configuration类创建；
    以下我们将根据Demo工程中的代码，使用Inpustream流的方式来进一步的窥探源码初始化的过程
  2. SqlSessionFactoryBuilder源码
    这里我们分析使用字节流InputStream创建SqlSessionFactory 的源码，其他字符流Reader或者Configuration源码创建的原理基本一样，我们直接上源码
public class SqlSessionFactoryBuilder {
  //通过字节流（InputStream）的方式构件SqlSessionFacotry
  public SqlSessionFactory build(InputStream inputStream) {
    return build(inputStream, null, null);
  }
  
  public SqlSessionFactory build(InputStream inputStream, String environment) {
    return build(inputStream, environment, null);
  }
  
  public SqlSessionFactory build(InputStream inputStream, Properties properties) {
    return build(inputStream, null, properties);
  }
  
  public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {
    try {
      //通过mybatis-config.xml配置文件流，创建XMLConfigBuilder对象
      XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
      //通过XMLConfigBuilder对象的parse()方法，解析mybatis-config.xml配置文件，获得全局Configuration对象，最后创建了SqlSessionFactory对象
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        inputStream.close();
      } catch (IOException e) {
      }
    }
  }
  //最终通过全局Configuration配置类,实例化SqlSessionFactory
  public SqlSessionFactory build(Configuration config) {
    //DefaultSqlSessionFactory为SqlSessionFactory的实现类,既SqlSessionFactory为接口
    return new DefaultSqlSessionFactory(config);
  }
}

通过上面的源码，我们可以得到几个信息：

  • Inpustream流的build方式，最终调用的是build(InputStream inputStream, String environment, Properties properties)方法来创建SqlSessionFactory；
  • build方法的内部构建了XMLConfigBuilder对象，来解析mybatis-config.xml配置文件信息，注册到全局Configuration配置类中；
  • 最后通过SqlSessionFactory的实现类DefaultSqlSessionFactory和全局Configuration配置类实例化了SqlSessionFactory对象；

这里我们会产生以下几个问题：

  • XMLConfigBuilder对象是什么，具体的作用是什么？
  • 它是怎么解析mybatis-config.xml配置文件？
  • 它是怎么获取到Configuration实例呢？

接下来我们具体来分析XMLConfigBuilder对象及其源码；

2.2 XMLConfigBuilder类源码解析
2.2.1 XMLConfigBuilder介绍
  • 具体作用：XMLConfigBuilder见名知意，它是用来解析XML配置文件的，在mybatis中它负责解析mybatis的XML配置文件，本文中它解析的就是mybatis-config.xml配置文件
  • 类结构：
XMLConfigBuilder BaseBuilder 初始化全局Configuration配置类对象 XMLConfigBuilder BaseBuilder 
public class XMLConfigBuilder extends BaseBuilder {

}
public abstract class BaseBuilder {
  //全局的Configuration对象，使用final修饰，只能初始化一次
  protected final Configuration configuration;
  protected final TypeAliasRegistry typeAliasRegistry;
  protected final TypeHandlerRegistry typeHandlerRegistry;
  //带参构造方法，通过configuration对象初始化BaseBuilder 
  public BaseBuilder(Configuration configuration) {
    this.configuration = configuration;
    this.typeAliasRegistry = this.configuration.getTypeAliasRegistry();
    this.typeHandlerRegistry = this.configuration.getTypeHandlerRegistry();
  }
}
  • XMLConfigBuilder 继承了父类 BaseBuilder 对象，BaseBuilder 维护了整个mybatis全局的 Configuration 对象（因为使用了final修饰，具体可看上面源码）
  • 在创建XMLConfigBuilder 对象时，会初始化这个全局的 Configuration 对象。
//通过mybatis-config.xml配置文件流，创建XMLConfigBuilder对象
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
return build(parser.parse());

public class XMLConfigBuilder extends BaseBuilder {
  //用来标记XMLConfigBuilder只能解析一次mybatis-config.xml的标识
  private boolean parsed;
  //xml文件解析器，使用final只能初始化一次
  private final XPathParser parser;
  //当前数据库环境
  private String environment;
  
  public XMLConfigBuilder(InputStream inputStream, String environment, Properties props) {
    //XPathParser为xml解析器，把mybatis-config.xml流创建了XPathParser实例
    this(new XPathParser(inputStream, true, props, new XMLMapperEntityResolver()), environment, props);
  }

  private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {
  	//初始化父类BaseBuilder中的全局 Configuration 对象
    super(new Configuration());
    ErrorContext.instance().resource("SQL Mapper Configuration");
    this.configuration.setVariables(props);
    this.parsed = false;//标识
    this.environment = environment;//此处因为我们只通过配置流实例化XMLConfigBuilder，因此environment=null
    this.parser = parser;//实例化全局的xml解析器 
  }
}
  • 通过mybatis-config.xml配置文件流，创建了 XMLConfigBuilder 对象后，XMLConfigBuilder 其父类维护了全局的Configuration对象，其自身的维护了一个全局的XPathParser的xml解析器
//通过mybatis-config.xml配置文件流，创建XMLConfigBuilder对象
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
//parser.parse()开始解析mybatis-config.xml配置文件，配置文件信息注册到全局Configuration配置类中
return build(parser.parse());

public class XMLConfigBuilder extends BaseBuilder {
  //解析mybatis配置文件
  public Configuration parse() {
    if (parsed) {
      //每个XMLConfigBuilder只能解析一次mybatis-config.xml
      throw new BuilderException("Each XMLConfigBuilder can only be used once.");
    }
    parsed = true;
    //XPathParser是xml文件的解析器，包括检测xml文件格式,默认解析configuration根节点
    //通过解析mybatis-config.xml各个节点信息，注册到全局Configuration配置类中
    parseConfiguration(parser.evalNode("/configuration"));
    //返回全局的Configuration对象
    return configuration;
  }
  //最后逐一解析mybatis-config.xml配置文件中的各个节点
  private void parseConfiguration(XNode root) {
    try {
      //解析<properties>节点
      propertiesElement(root.evalNode("properties"));
      //解析<settings>节点
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      loadCustomLogImpl(settings);
      //解析<typeAliases>节点
      typeAliasesElement(root.evalNode("typeAliases"));
      //解析<plugins>节点
      pluginElement(root.evalNode("plugins"));
      //解析<objectFactory>节点
      objectFactoryElement(root.evalNode("objectFactory"));
      //解析<reflectorFactory>节点
      objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
      //解析<reflectorFactory>节点
      reflectorFactoryElement(root.evalNode("reflectorFactory"));
      settingsElement(settings);
      // read it after objectFactory and objectWrapperFactory issue #631
      //解析<environments>节点
      environmentsElement(root.evalNode("environments"));
      //解析<databaseIdProvider>节点
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
      //解析<typeHandlers>节点
      typeHandlerElement(root.evalNode("typeHandlers"));
      //解析<mappers>节点
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }
}
  • 回顾我们的Demo工程中，目前的mybatis-config.xml配置文件内容
    在这里插入图片描述
  • 当前 XMLConfigBuilder 对象的 parse() 方法中解析的是我们的 environments 节点和 mappers 节点内容，对应的解析方法分别为：environmentsElement(root.evalNode(“environments”)) 和 mapperElement(root.evalNode(“mappers”))
  • 我们在代码注释中提到解析mybatis-config.xml配置文件的各个节点信息后，会将节点信息注册到父类BaseBuilder维护的全局Configuration对象中
  • 接下来我们就通过environments节点来看看是XMLConfigBuilder是怎么把节点信息注册到全局Configuration对象的；
  • 分析 environments 节点的信息注册到全局Configuration对象
  //context此时为节点<environments>信息
  private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
      if (environment == null) {
      	//获取<environments>节点属性default的值，既environment=mysql，具体可参照上面配置文件截图
        environment = context.getStringAttribute("default");
      }
      //遍历<environments>节点的所有子节点<environment>
      //根据配置文件，子节点目前只有一个<environment id="mysql">
      for (XNode child : context.getChildren()) {
        //获取子节点<environment id="mysql">中的属性id值为mysql
        String id = child.getStringAttribute("id");
        //判断子节点<environment>属性id的值跟父节点<environments>属性default是否一致，一致则当前的子节点<environment>信息作为mybatis的数据库环境
        if (isSpecifiedEnvironment(id)) {
          //获取<environment>的其子节点<transactionManager type=“JDBC”>，实例化事务工厂对象
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
          //获取<environment>的其子节点<dataSource type=“POOLED”>，实例化数据源工程对象
          DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
          //通过数据源工厂，获取数据源DataSource对象
          DataSource dataSource = dsFactory.getDataSource();
          //mybatis通过id=mysql实例化mysql的环境，把事务工厂和数据源赋予environmentBuilder构建者创建了mysql数据库环境
          Environment.Builder environmentBuilder = new Environment.Builder(id)
              .transactionFactory(txFactory)
              .dataSource(dataSource);
          //最后把mysql数据库环境注册到全局Configuration中
          configuration.setEnvironment(environmentBuilder.build());
        }
      }
    }
   }
  private boolean isSpecifiedEnvironment(String id) {
    if (environment == null) {
      throw new BuilderException("No environment specified.");
    } else if (id == null) {
      throw new BuilderException("Environment requires an id attribute.");
    } else if (environment.equals(id)) {
      return true;
    }
    return false;
  }
  • 在整个environments节点的源码中，我们知道了，XMLConfigBuilder 对象只解析了environments节点中跟属性default值和子节点environment的属性值id一致的节点信息，构建该子节点environment的数据库环境，最后注册到了全局Configuration配置类中
  • 通过parseConfiguration方法，我们知道了mybatis配置文件有11个节点，分别是：properties、settings、typeAliases、plugins、objectFactory、objectWrapperFactory、reflectorFactory（旧版本没有该节点）、environments、databaseIdProvider、typeHandlers、mappers
  • 每个节点最后解析后信息均注册到了全局Configuration中，具体代码可以在各个节点解析的方法中去查看，而其他节点的解析源码，我们在后面还是一样围绕着demo工程mybatisCode来一一分析。
  • 最后本篇中整个源码的分析总结，通过以图的方式帮助整理mybatis-config.xml配置文件初始化的整个过程
    在这里插入图片描述
结尾

下篇开始Mybatis源码分析（3）—配置节点properties源码解析，我们将对mybatis-config.xml配置文件中的各个节点，逐篇的分析，每个节点mybatis源码解析的过程，按照节点解析的顺序，我们优先解析节点properties

午托饭
关注
专栏目录
mybatis源码分析1 - 框架
谢杨易的博客
01-14 1万+
1 源码结构 我们分析的mybatis源码version为3.4.5，mybaits-spring源码version为2.0.0-SNAPSHOT。先看mybatis的源码目录结构，如下图所示。 我们只用看src/main/java下的目录即可。 annotations：注解定义，我们知道mybatis配置可以采用XML文件形式，也可以采用注解形式 binding：主要是mapper动
mybatis-初探源码
java技术博客
06-06 173
1.通过 SqlSessionFactoryBuilder 对象 , 基于 配置文件(mybatis-config.xml) 构建SqlSessionFactory2.通过 SqlSessionFactory 连接工厂 创建 SqlSession 对象3.通过 SqlSession 对象过去 Mapper 接口mapper接口 --> mapper.xml 的 namespacemapper接口方法- —> mapper.xml 的 idsqlsession 执行 sql 语句 , 并处理接口4.执行方法
mybatis-config.xml文件无法找到出错原因
INSIGNER的博客
08-08 1493
文件的名字写错。这是一个常出现的错误，不容易发现。先看下面的。 文件的位置 maven 真的找不到。这有两种解法： 方法一：将文件放在主目录下的 resources 文件中，这是 maven 默认会扫描配置文件的目录。 方法二：将下面这几行代码添加到 pom.xml 文件中 <build> <resources> <resource> <!--directory 用于指定maven扫描并提.
Mybatis
weixin_53502108的博客
05-14 248
Mybaits
九、生命周期和作用域
有人的地方，就是江湖
11-30 240
狂神说Java：https://www.bilibili.com/video/BV1NE411Q7Nx 不同作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。 1、SqlSessionFactoryBuilder 这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder.
Mybatis 源码解析01 - 配置、启动加载
最新发布
一斗水的专栏
01-19 484
mybatis是目前非常流行的ORM框架，在其基础上还衍生了mybatis-plus)等优秀的框架。mybatis简单，易用，易扩展。 接下来我们用一个简单的例子（几乎包含所有配置）来看一下mybatis相关的配置项 下面是一个包含用户、商品、订单的DAO例子，关系图如下： MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 各属性介绍可以参考[官网](mybatis – MyBatis 3 | 配置) 此示例项目的内容如下 下面是mapper配置，即xml映射文件的配置，我
java配置文件初始化_mybatis 源码学习(一)配置文件初始化
weixin_35172279的博客
02-17 259
关键的方法在于new SqlSessionFactoryBuilder().build(reader); 可以看到parser.parse() 返回的结果是Configuration ，而mybatis所有的配置文件初始化在这个类里面，这个是很关键的类。 这里可以看到读取configuration节点，我们知道configuration节点里面有数据源的配置以及xml文件的所在包或者路径。 这里...
Mybatis初始化加载流程————配置文件解析
朱玉强的博客
06-07 2378
本次测试的实例中的相关配置文件如下： application.xml文件： &amp;amp;lt;?xml version=&amp;quot;1.0&amp;quot; encoding=&amp;quot;UTF-8&amp;quot;?&amp;amp;gt; &amp;amp;lt;beans xmlns=&amp;quot;http://www.springframework.org/schema/beans&amp
Mybatis源码分析-上课笔记1
08-03
在分析MyBatis源码时，可以采用宏观和微观两种视角。宏观上理解整个框架的架构和流程，微观上深入到具体的类和方法，通过阅读和调试代码来理解其实现细节。同时，绘制流程图或UML图能帮助更好地梳理组件间的交互。 ...
Mybatis源码分析.pdf
08-30
1. 加载配置并初始化：MyBatis读取全局配置文件、Mapper XML文件等，将SQL配置信息转化为MappedStatement对象存储在内存中。 2. 接收调用请求：当调用MyBatis API时，传入SQL的ID和参数对象。 3. 处理操作请求：这一...
mybatis源码学习------动态sql的解析(SqlNode)
我是兴锅的博客
11-04 2056
123
Java架构师之源码分析专题SpringBoot2.x、Spring5、SpringMVC、Mybatis源码分析
08-23
源码分析将涵盖`ApplicationContext`的初始化过程，AOP（面向切面编程）的实现，以及事件传播机制。通过对这些核心组件的了解，可以提高你的Spring应用性能和可维护性。 SpringMVC作为Spring框架的一部分，负责处理...
MyBatis
小趴菜不能喝的博客
09-28 490
详细介绍mybatis，动态sql及mybatis缓存
Mybatis原理学习3：Mybatis的初始化（配置文件的读取和解析）
不忘初心
03-11 1976
步骤一：读取Ibatis的主配置文件，并将文件读成文件流形式(InputStream)。代码：String resource = "org/mybatis/example/mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource);//读取Mybaits的主配置配置文件，并返回该文件的
使用XMLInputFactory，XMLStreamReader，XMLEventReader解析XML文件
内事问度娘，外事问谷歌！
07-31 1409
package com.org.domain; import java.io.IOException; import java.io.InputStream; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.s...
Mybatis源代码解析（操作数据库全流程）
Konan96的博客
04-23 308
1.从 XML 中构建 SqlSessionFactory String resource = "org/mybatis/example/mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new...
MyBatis的使用
muzihao6的博客
04-14 912
MyBatis的使用 ​ 开源的数据持久化层框架，实体类与SQL语句之间建立映射关系。 1、使用MyBatis的开发步骤： 1.1、下载MyBatis-3.2.2.jar包并导入工程 1.2、编写MyBatis核心配置文件 1.2.1、在src目录下创建一个mybatis-config.xml的配置文件，该文件用来配置数据库连接信息和MyBatis的参数。 <?xml version="1....
Mybatis中遇到的坑
qq_37658806的博客
07-15 363
Mybatis的基本配置 1. 首先使用Maven添加对应的依赖 <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis&lt...
【MyBatis】MyBatis 启动流程
九师兄
05-14 1591
1.概述 转载：MyBatis 启动流程 MyBatis 是第一个支持自定义 SQL、存储过程和高级映射的类持久框架。MyBatis 消除了大部分 JDBC 的样板代码、手动设置参数以及检索结果。MyBatis 能够支持简单的 XML 和注解配置规则。使 Map 接口和 POJO 类映射到数据库字段和记录。 2.MyBatis 的特点 那么 MyBatis 具有什么特点呢？或许我们可以从如下几个方面来描述 MyBatis 中的 SQL 语句和主要业务代码分离，我们一般会把 MyBatis 中的 SQL 语.
MyBatis-Spring 源码深度解析
"mybatis 高级特性，包括SqlSessionFactoryBean、MapperFactoryBean和MapperScannerConfigurer的源码分析，以及MyBatis插件开发的介绍。" 在MyBatis与Spring的整合中，有三个核心类起着关键作用，它们是...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值