Mybatis源码学习之全局配置文件和映射文件解析

于 2023-06-12 20:29:15 发布
阅读量509 收藏
点赞数
分类专栏： JavaEE 文章标签： mybatis 学习 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wsb_2526/article/details/131057143
版权

全局配置文件和映射文件解析

全局配置文件解析

  public static void main(String[] args) throws IOException {

    // 读取配置文件
    InputStream is = Resources.getResourceAsStream("org/apache/ibatis/builder/MapperConfig1.xml");
    // 创建SqlSessionFactory工厂
    SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
    SqlSessionFactory factory = sqlSessionFactoryBuilder.build(is);
    // 使用工厂生产SqlSession对象
    SqlSession session = factory.openSession();
     //使用SqlSession创建Dao接口的代理对象
    AuthorMapper authorMapper = session.getMapper(AuthorMapper.class);
    List<Author> authors = authorMapper.selectAllAuthors();
    //释放资源
    session.close();
    is.close();
  }

下面我们来进行源码分析。

配置文件的解析&创建SqlSessionFactory

配置文件的解析主要涉及到的类如下：XMLConfigBuilder、XPathParser、XPath、XNode，其中XPath、XNode是对
1、build方法内部首先会根据输入流等信息创建XMLConfigBuilder类的实例对象，然后调用XMLConfigBuilder实例的parse方法对配置文件进行解析；这里需要注意的是parse方法最后返回的是一个Configuration对象
在这里插入图片描述

2、parse方法则是调用了XPath对象的evalNode方法对配置文件中的configuration节点进行解析，会把节点内容放在XNode对象中然后返回；
在这里插入图片描述

3、parseConfiguration方法会对configuration节点解析出来的内容再进行解析，会把解析出来的内容放在configuration对象中；实际上配置文件中的内容解析出来后都会存到Configuration中。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-YjYs8014-1685886063612)(Pasted%20image%2020230223222648.png)]

4、parseConfiguration方法中主要做的事如下：

  • 解析 properties节点
      /**
       * 解析 properties节点
       *     <properties resource="mybatis/db.properties" />
       *     解析到org.apache.ibatis.parsing.XPathParser#variables
       *           org.apache.ibatis.session.Configuration#variables
       */
      // issue #117 read properties first
      propertiesElement(root.evalNode("properties"));
  • 解析settings节点
      /**
       * 解析我们的mybatis-config.xml中的settings节点
       * 具体可以配置哪些属性:http://www.mybatis.org/mybatis-3/zh/configuration.html#settings
       * <settings>
       <setting name="cacheEnabled" value="true"/>
       <setting name="lazyLoadingEnabled" value="true"/>
       <setting name="mapUnderscoreToCamelCase" value="false"/>
       <setting name="localCacheScope" value="SESSION"/>
       <setting name="jdbcTypeForNull" value="OTHER"/>
       ..............
       </settings>
       *
       */
      Properties settings = settingsAsProperties(root.evalNode("settings"));
  • 解析
      /**
       * 基本没有用过该属性
       * VFS含义是虚拟文件系统；主要是通过程序能够方便读取本地文件系统、FTP文件系统等系统中的文件资源。
       Mybatis中提供了VFS这个配置，主要是通过该配置可以加载自定义的虚拟文件系统应用程序
       解析到：org.apache.ibatis.session.Configuration#vfsImpl
       */
      loadCustomVfs(settings);
  • 指定 MyBatis 所用日志的具体实现，未指定时将自动查找。
      /**
       * 指定 MyBatis 所用日志的具体实现，未指定时将自动查找。
       * SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING
       * 解析到org.apache.ibatis.session.Configuration#logImpl
       */
      loadCustomLogImpl(settings);
  • 解析别名
      /**
       * 解析别名
       * <typeAliases>
       <typeAlias alias="Author" type="cn.tulingxueyuan.pojo.Author"/>
       </typeAliases>
       <typeAliases>
       <package name="cn.tulingxueyuan.pojo"/>
       </typeAliases>
       解析到oorg.apache.ibatis.session.Configuration#typeAliasRegistry.typeAliases
       */
      typeAliasesElement(root.evalNode("typeAliases"));
  • 解析插件
      /**
       * 解析我们的插件(比如分页插件)
       * mybatis自带的
       * Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
       ParameterHandler (getParameterObject, setParameters)
       ResultSetHandler (handleResultSets, handleOutputParameters)
       StatementHandler (prepare, parameterize, batch, update, query)
       解析到：org.apache.ibatis.session.Configuration#interceptorChain.interceptors
       */
      pluginElement(root.evalNode("plugins"));
  • 设置settings
      // 设置settings 和默认值
      settingsElement(settings);
  • 解析mybatis环境
      /**
       * 解析mybatis环境
       <environments default="dev">
       <environment id="dev">
       <transactionManager type="JDBC"/>
       <dataSource type="POOLED">
       <property name="driver" value="${jdbc.driver}"/>
       <property name="url" value="${jdbc.url}"/>
       <property name="username" value="root"/>
       <property name="password" value="Zw726515"/>
       </dataSource>
       </environment>

       <environment id="test">
       <transactionManager type="JDBC"/>
       <dataSource type="POOLED">
       <property name="driver" value="${jdbc.driver}"/>
       <property name="url" value="${jdbc.url}"/>
       <property name="username" value="root"/>
       <property name="password" value="123456"/>
       </dataSource>
       </environment>
       </environments>
       *  解析到：org.apache.ibatis.session.Configuration#environment
       *  在集成spring情况下由 spring-mybatis提供数据源 和事务工厂
       */
      // read it after objectFactory and objectWrapperFactory issue #631
      environmentsElement(root.evalNode("environments"));
  • 解析数据库厂商
      /**
       * 解析数据库厂商
       <databaseIdProvider type="DB_VENDOR">
       <property name="SQL Server" value="sqlserver"/>
       <property name="DB2" value="db2"/>
       <property name="Oracle" value="oracle" />
       <property name="MySql" value="mysql" />
       </databaseIdProvider>
       *  解析到：org.apache.ibatis.session.Configuration#databaseId
       */
      databaseIdProviderElement(root.evalNode("databaseIdProvider"));
  • 解析类型处理器
      /**
       * 解析我们的类型处理器节点
       * <typeHandlers>
       <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
       </typeHandlers>
       解析到：org.apache.ibatis.session.Configuration#typeHandlerRegistry.typeHandlerMap
       */
      typeHandlerElement(root.evalNode("typeHandlers"));
  • 解析mapper文件
      /**
       * 解析mapper文件（SQL映射文件）
       *
       resource：来注册我们的class类路径下的
       url:来指定我们磁盘下的或者网络资源的
       class:
       若注册Mapper不带xml文件的,这里可以直接注册
       若注册的Mapper带xml文件的，需要把xml文件和mapper文件同名 同路径
       -->
       <mappers>
       <mapper resource="mybatis/mapper/EmployeeMapper.xml"/>
       <mapper class="com.tuling.mapper.DeptMapper"></mapper>


       <package name="com.tuling.mapper"></package>
       -->
       </mappers>
       * package 1.解析mapper接口 解析到：org.apache.ibatis.session.Configuration#mapperRegistry.knownMappers
       2.
       */
      mapperElement(root.evalNode("mappers"));

到这里配置文件就解析完了，mybatis会根据configuration对象创建SqlSessionFactory类的对象。

SQL映射文件解析

上面解析全局配置文件的最后一行代码就是解析SQL映射文件的入口，下面我们来分享一下SQL映射文件的解析。
mapperElement方法中首先判断注册SQL映射的方式（通过package、resource、url还是class），然后再去解析对应的mapper文件。
在这里插入图片描述
parse方法中首先会判断mapper文件是否被加载过，如果被加载过就不需要再次解析了。

  • configurationElement方法中会解析mapper文件中的各个节点；
  • cacheRefElement(context.evalNode(“cache-ref”))：处理缓存；
  • parameterMapElement(context.evalNodes(“/mapper/parameterMap”))：处理sql参数；
  • resultMapElements(context.evalNodes(“/mapper/resultMap”))：处理返回值；
  • sqlElement(context.evalNodes(“/mapper/sql”))：解析sql节点；
  • buildStatementFromContext(context.evalNodes(“select|insert|update|delete”))：解析sql语句（insert/update/delete/select）
    在这里插入图片描述
  /**
   * 方法实现说明:解析我们的<mapper></mapper>节点
   * @param context document节点
   */
  private void configurationElement(XNode context) {
    try {
      //解析namespace属性
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.isEmpty()) {
        throw new BuilderException("Mapper's namespace cannot be empty");
      }

      //保存我们当前的namespace  并且判断接口完全类名==namespace
      builderAssistant.setCurrentNamespace(namespace);

//
//      解析我们的缓存引用
//     说明我当前的缓存引用和DeptMapper的缓存引用一致
//      <cache-ref namespace="com.tuling.mapper.DeptMapper"></cache-ref>
//      解析到org.apache.ibatis.session.Configuration#cacheRefMap<当前namespace,ref-namespace>
//      异常下（引用缓存未使用缓存）：org.apache.ibatis.session.Configuration#incompleteCacheRefs
      cacheRefElement(context.evalNode("cache-ref"));

//      解析我们的cache节点
//        <cache type="org.mybatis.caches.ehcache.EhcacheCache"></cache>
//        解析到：org.apache.ibatis.session.Configuration#caches
//      org.apache.ibatis.builder.MapperBuilderAssistant#currentCache
      cacheElement(context.evalNode("cache"));

      //解析paramterMap节点(该节点mybaits3.5貌似不推荐使用了)
      parameterMapElement(context.evalNodes("/mapper/parameterMap"));

      //解析我们的resultMap节点
      //解析到：org.apache.ibatis.session.Configuration#resultMaps
      // 异常 org.apache.ibatis.session.Configuration#incompleteResultMaps
      resultMapElements(context.evalNodes("/mapper/resultMap"));

      /**
       * 解析我们通过sql节点
       *  解析到org.apache.ibatis.builder.xml.XMLMapperBuilder#sqlFragments
       *   其实等于 org.apache.ibatis.session.Configuration#sqlFragments
       *   因为他们是同一引用，在构建XMLMapperBuilder 时把Configuration.getSqlFragments传进去了
       */
      sqlElement(context.evalNodes("/mapper/sql"));

      /**
       * 解析我们的select | insert |update |delete节点
       * 解析到org.apache.ibatis.session.Configuration#mappedStatements
       */
      buildStatementFromContext(context.evalNodes("select|insert|update|delete"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing Mapper XML. The XML location is '" + resource + "'. Cause: " + e, e);
    }
  }

我们看一下buildStatementFromContext方法，这个方法最终会把节点解析成MappedStatement对象。
在这里插入图片描述
下面3张图都是一个方法中的代码
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
上面一张图中的createSqlSource方法会解析出Sql，接下来我们看下此方法是怎么解析的。
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
最后解析出来的sql如下图所示：
在这里插入图片描述
到这里sql就解析完成了。

Mybatis中关于sql解析的一些类：

  • XMLConfigBuilder：解析mybatis中configLocation属性中的全局xml文件，内部会使用XMLMapperBuilder解析各个xml文件
  • XMLMapperBuilder：遍历mybatis中mapperLocations属性中的xml文件中每个节点的Builder，比如user.xml，内部会使用XMLStatementBuilder处理xml中的每个节点
  • XMLStatementBuilder：解析mapper配置文件中的节点，如select、insert等，内部会使用XMLScriptBuilder处理节点的sql部分，遍历产生的数据会放到Configuration的mappedStatements属性中
  • XMLScriptBuilder：解析xml中各个节点sql部分的Builder；

Configuration中使用map存储MappedStatement对象，key是mapper接口中的方法名；MappedStatement中存储的信息如下：
在这里插入图片描述sqlSource是解析出来的sql。
在这里插入图片描述

XMLScriptBuilder类结构如下图所示。这个类中有许多继承了NodeHandler接口的内部类，在解析动态sql的时候，会使用whereHandler去解析where节点，IfHandler解析if节点，其它的类似。
在这里插入图片描述

下面给出的是一条update语句，parseDynamicTags的解析流程如下：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

parseDynamicTags方法的返回值是一个List，也就是一个Sql节点集合

  1. 首先根据update节点(Node)得到所有的子节点，分别是3个子节点
    • 文本节点 UPDATE users
    • trim子节点
    • 文本节点 \n where id = #{id}
  2. 遍历各个子节点
    • 如果节点类型是文本或者CDATA，构造一个TextSqlNode或StaticTextSqlNode
    • 如果节点类型是元素，说明该update节点是个动态sql，然后会使用NodeHandler处理各个类型的子节点
  3. 遇到子节点是元素的话，重复以上步骤

参考

  1. Mybatis官方文档
  2. Mybatis视频
wmxz520
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
MyBatis底层实现（三）复杂标签SQL的解析
surpass0728的博客
07-23 1416
先给出一段代码，类似于下面的复杂SQL，在解析过程中又是怎么执行的，调用了哪些API &lt;select id="getAll" parameterType="map" resultType="map"&gt; &lt;bind name="pattern" value="'%' + _parameter.getTitle() + '%'" /&gt;
IDEA中的mybatis开发第一天
SmallScorpion
08-11 300
一、mybati架构图 mybatis配置 SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。 mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。 通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂 由会话工厂创建sqlSe...
Mybatis解析动态sql原理分析（搬运）
JoyceYoung的博客
10-01 427
目录1、首先，附上原文链接：2、介绍MyBatis中一些关于动态SQL的接口和类3、源码分析走起4、实例分析5、总结 1、首先，附上原文链接： https://www.cnblogs.com/fangjian0423/p/mybaits-dynamic-sql-analysis.html 废话不多说，直接进入文章。 我们在使用mybatis的时候，会在xml中编写sql语句。 比如这段动态sql代码： <update id="update" parameterType="org.format.dyna
Mybatis源码解读系列(一)-对查询标签的解析&创建BoundSql相关类分析
Feverasa的博客
12-12 372
一、xml中的select查询节点 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="org.apache.ibatis.submitted.maptypehandler.Mapper"> <select id="getUserXML" result
学习在IDEA中使用Mybatis（三）映射文件之参数处理
qq_41884677的博客
07-16 2051
映射文件指导着MyBatis如何进行数据库增删改查， 有着非常重要的意义 cache –命名空间的二级缓存配置 cache-ref – 其他命名空间缓存配置的引用 resultMap – 自定义结果集映射 parameterMap – 已废弃！老式风格的参数映射 sql –抽取可重用语句块。 insert – 映射插入语句 update 映射更新语句 delete – 映射删除语句 select...
Mybatis源码分析.pdf
08-30
1. 加载配置并初始化：MyBatis读取全局配置文件、Mapper XML文件等，将SQL配置信息转化为MappedStatement对象存储在内存中。 2. 接收调用请求：当调用MyBatis API时，传入SQL的ID和参数对象。 3. 处理操作请求：这一...
阿里巴巴P7架构师纯手工打造MyBatis源码——1小时解密底层源码.txt
10-10
通过对阿里巴巴P7架构师精心制作的MyBatis源码解析文档的学习，我们可以深入了解MyBatis的工作原理及其内部实现细节。这不仅有助于我们更好地理解和使用MyBatis，还能为我们解决实际开发中遇到的问题提供有力的支持...
mybatis详解源码
01-21
1. XML配置解析：MyBatis如何解析XML配置文件，包括映射文件（mapper.xml）和全局配置文件（mybatis-config.xml）。 2. SQL动态解析：MyBatis如何处理动态SQL，如if、choose、when、otherwise等标签，以及如何拼接...
java-ORM框架Mybatis源码分析
最新发布
02-27
在执行SQL前，MyBatis需要将XML中的SQL语句和结果集映射解析为`MappedStatement`对象，这一步由`Configuration`类完成。`MappedStatement`包含了完整的SQL语句、参数映射信息和结果集映射信息。通过`BoundSql`，...
Mybatis的增删查改Java学习资料源码教程
06-24
- `mybatis-config.xml`：Mybatis全局配置文件，包括数据源、事务管理器等配置。 - `mapper`目录：存放映射文件，如`UserMapper.xml`，其中包含SQL语句和结果映射。 - `pojo`目录：实体类，如`User.java`，对应...
在idea中创建MyBatis核心配置文件和映射文件的模板、使用模板搭建MyBatis框架
weixin_46065214的博客
09-08 2288
在idea中创建MyBatis核心配置文件和映射文件的模板、使用模板搭建MyBatis框架
Mybatis原理--动态生成SQL
bingguang1993的博客
12-31 1541
本文将带你分析Mybatis是如何动态生成SQL。 首先，会根据源码分析框架初始化时xml文件的加载、解析、缓存过程。着重介绍 xml的解析过程 和 使用解析的结果，最后列举实例和对照源码DeBug分析：当DAO接口调用时标签的解析、参数的创建、SQL的生成过程，并总结整个流程。 数据的处理 Mybatis对数据的处理可以分为 用入参动态的拼装sql 和 对sql执行的结果封装成 Ja...
Mybatis源码分析系列之配置文件加载（三）
Magic_洋实战各种技术
12-16 301
Mybatis源码分析系列之配置文件加载（三） 也许文中的一些说明能解决你的困惑。也许有表述不清晰的地方。请大家多多指点。欢迎下方留言。本人准备系统的总结一下各种框架的一些源码。也希望大家能给我提出宝贵意见 我们今天继续上文 传送门：Mybatis源码分析系列之配置文件加载（二） 2.11 mapperElement private void mapperElement(XNode parent)...
Mybatis解析动态sql原理分析
多看多听多总结
08-11 5748
前言 废话不多说，直接进入文章。 我们在使用mybatis的时候，会在xml中编写sql语句。 比如这段动态sql代码： "update" parameterType="org.format.dynamicproxy.mybatis.bean.User"> UPDATE users "SET" prefixOverrides=","> if test="
Ibatis 关于DynamicSql源码的解读
zhoxing
03-15 4385
一. 业务背景由于最近在做数据罗盘的开发，其中会有挺多的排序,聚会运算的要求。而我们利用了集团的garuda运算平台，想利用它建的智能索引和智能查询优化器来优化sql处理复杂业务,所以sql会堆上一些较复杂业务。比如:现在有一个需求，需要对一个二维的数组List里的数据进行迭代遍历，一维数组我们都知道可以用iterate标签遍历，如下:<iterate conjunction="," propert
Mybatis源码分析（四）：mapper.xml增删查改的节点解析和动态SQL的实现
源码之下，了无秘密
02-27 4132
概述 我们通常在mapper.xml中定义增删查改select|insert|update|delete的相关SQL，在对应的select|insert|update|delete节点中支持通过if，（choose, when, otherwise），（trim, where, set），foreach等内嵌节点来实现动态SQL定义，动态SQL的使用方法可以参考：动态 SQL 。 对于增删查改，...
Nginx学习之Nginx.conf配置文件详解
wsb_2526的博客
10-10 5483
概述 Nginx.conf配置文件分为3个部分，分别是全局块、events块和http块，其中http块又分为http全局块和server块，每个server块中可以包含多个location块和server全局块。 配置详解 全局块 全局块是默认配置文件从开始到events块之间的一部分内容，主要设置一些影响Nginx服务器整体运行的配置指令。通常包括配置运行Nginx服务器的用户（组）、允许生成的worker process数、Nginx进程PID存放路径、日志的存放路径和类型以及配置文件引入等。 eve
SpringSecurity框架学习与使用
wsb_2526的博客
05-01 3246
request . antMatchers("/") . permitAll() . antMatchers("/home") . permitAll() // /home、/ 的请求可以访问 . antMatchers("/test/test1") . hasRole("SALES") . antMatchers("/test/test2") . hasAuthority("admin") . anyRequest() . authenticated();//除了上面的，其它的请求必须认证通过 });
MyBatis全局配置解析与优化策略详解
"深入探讨MyBatis的全局配置文件解析及其在应用优化中的策略，了解MyBatis相对于传统JDBC的优势，以及如何通过配置文件优化MyBatis应用的性能和可维护性。" MyBatis是一个流行的Java持久层框架，它为开发者提供了更...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值