Mybatis源码分析-流程详解

最新推荐文章于 2024-07-22 17:05:27 发布
置顶 最新推荐文章于 2024-07-22 17:05:27 发布
阅读量491 收藏 7
点赞数
分类专栏： mysql Java mybatis 文章标签： mybatis java mysql
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lx1315998513/article/details/117393672
版权
Java 同时被 3 个专栏收录
22 篇文章 1 订阅
订阅专栏
mybatis
9 篇文章 0 订阅
订阅专栏
mysql
5 篇文章 0 订阅
订阅专栏

从一次简单的Mybatis源码分析开启你的源码分析之路

一、概述

（一）什么是Mybatis

MyBatis是一款优秀的持久层（ORM）框架，但并不是一个完整的ORM框架，ORM是Object和Relation之间的映射，包括Object->Relation和Relation->Object两方面。Hibernate是个完整的ORM框架，而MyBatis完成的是Relation->Object，也就是其所说的data mapper framework。

ORM框架 -> 用于实现面向对象编程语言里不同类型系统的数据之间的转换
Java对象（字段、类型）  映射（类型字段名一一对应）->  数据库表（字段、类型）

（二）Mybatis能做些什么

它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

二、分析过程

（一）准备

从官方github下载源码：https://github.com/mybatis/mybatis-3

https://github.com/mybatis/mybatis-3.git

从作者的github下载源码：https://github.com/1315998513/mybatis-3

https://github.com/1315998513/mybatis-3.git

参考Mybatis官方文档：https://mybatis.net.cn/configuration.html
后续用到的一些配置详解，只拿了一部分出来，详情参考官方文档-配置（mybatis-config.xml）：

属性（properties）
这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。例如：

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/lastpass?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
username=root
password=123456

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值。比如:

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

环境配置（environments）
MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。
environments 元素定义了如何配置环境。

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments

数据源（dataSource）
dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。
大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。
有三种内建的数据源类型（也就是 type="[UNPOOLED|POOLED|JNDI]"）：
POOLED– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行，能使并发 Web 应用快速响应请求。

映射器（mappers）
定义 SQL 映射语句。 但首先，我们需要告诉 MyBatis 到哪里去找到这些语句。 在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。 你可以使用相对于类路径的资源引用，或完全限定资源定位符（包括 file:/// 形式的 URL），或类名和包名（Mapper加载的四种方法，包加载优先级最高，后续在源码中体现）等。

（二）宏观分析

以一个小demo大致的演示Mybatis的执行流程
结构图：
在这里插入图片描述
1.jdbc.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/lastpass?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
username=root
password=123456

2.mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <properties resource="jdbc.properties"/>
  <!-- 配置数据库连接：连接驱动、url、username、password -->
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="mapper/UserMapper.xml"/>
  </mappers>
</configuration>

3.bean -> User

public class User {
  private int id;
  private String name;
  private String password;
  ..getter setter
  ..toString
}

4.mapper -> UserMapper

public interface UserMapper {
  User selectUser(@Param("id") Integer id);
}

5.mapper.xml -> mapper/UserMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.mybatis.example.UserMapper">

  <select id="selectUser" resultType="org.apache.ibatis.demo.User">
    select * from user where id = #{id}
  </select>

</mapper>

6.MybatisMain

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

​    String resource = "mybatis-config.xml";
​    InputStream inputStream = Resources.getResourceAsStream(resource);

​    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

​    SqlSession session = sqlSessionFactory.openSession();

​    User user = session.selectOne("org.mybatis.example.UserMapper.selectUser", 1);
​    System.out.println(user);

  }
}

总结： 在main方法中，可以直观的看到，整个执行流程是：根据路径从配置文件读取流，构建会话工厂，通过会话工厂构建sql会话 （SqlSession底层是通过调用Execute（执行器）真正执行Java与数据库交互），SqlSession调用selectOne方法，指定执行的sql，传入参数。
执行结果：
在这里插入图片描述

（三）微观分析

    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    
    SqlSession session = sqlSessionFactory.openSession();
    
    User user = session.selectOne("org.mybatis.example.UserMapper.selectUser", 1);

对上面的三段代码进行底层的debug分析，在这过程中解决三个问题：

1.mybatis是如何获取数据库配置？
2.mybatis是如何执行sql语句？
3.mybatis是如何执行数据库的？

终于来到了本文的重点部分，断点调试，用到的几个命令：

F7：进入当前方法；	F8：进入下一行；	F9：进入下一断点
Ctrl+指向方法：进入方法查看
Ctrl+Alt+左方向键：返回上一指向方法处
还有很多用到的，详情百度...
Mybatis是如何获取数据库配置？

1.F7进调
在这里插入图片描述
2.F7进调
在这里插入图片描述
3.这里创建了一个用于解析配置内容的对象XMLConfigBuilder，F7进入parse（）看看解析具体的实现
在这里插入图片描述
4.F7进入parseConfiguration（）
在这里插入图片描述
5.可以看到该方法是对xml配置文件中的 configuration进行解析，F7进environmentsElement（）查看对environments部分的解析
在这里插入图片描述
6.F7进dataSourceElement（）查看对dataSource部分的解析
在这里插入图片描述
7.getChildrenAsProperties（）拿到Properties中的数据封装成Properties对象
在这里插入图片描述
8.F7进入resolveClass（）
在这里插入图片描述
9.F7进入resolveAlias（）
在这里插入图片描述
10.F7进入resolveAlias（）
在这里插入图片描述
11.根据字符串“POOLED”转小写，从typeAliases这个map中拿到对应的对象“org.apache.ibatis.datasource.pooled.PooledDataSourceFactory”
在这里插入图片描述
12.一直F8往下调回到上面第6步的时候，过了setEnvironment（）后，可以看到数据源等配置已经被赋值到configuration全局配置类中了
在这里插入图片描述
13.F8下一步直到返回到第5步，F7进入mapperElement（），这部分是对mappers的解析
在这里插入图片描述
14.mapper加载的4中方式，package优先级最高，这里创建了XMLMapperBuilder用于解析mapper部分的xml标签，F7进入parse()
在这里插入图片描述
15.F7进入configurationElement
在这里插入图片描述
16.F7进入到buildStatementFromContext（）
在这里插入图片描述
17.此时查看刚刚解析的select标签然后传参进来的list，可以看到解析到的select标签id，返回值类型，sql，F7进入到
在这里插入图片描述
18.F7进入buildStatementFromContext（）
在这里插入图片描述
19.F7进入parseStatementNode（）
在这里插入图片描述
20.这部分是对标签中解析到的select标签id，返回值类型，sql等等属性进行封装到builderAssistant中，往下查看
在这里插入图片描述
21.这部分是对sql部分进行解析，F7进入createSqlSource（）
在这里插入图片描述
22.F7进入parseScriptNode（）
在这里插入图片描述
23.F7进入RawSqlSource（）
在这里插入图片描述
24.F7进入this（）构造函数，F7进入parse（）
在这里插入图片描述
25.F7进入parse（）
在这里插入图片描述
26.这个方法是对sql进行语法解析，将#{xxx}转换为"?"，往下拉查看在这里插入图片描述
27.转换后
在这里插入图片描述
28.F8下一步直到返回到第23步，可以看到返回的sql已被转换
在这里插入图片描述
29.F8下一步直到返回到第21步，这部分是拿到定义的返回值类型
在这里插入图片描述
30.F7进入addMappedStatement（）
在这里插入图片描述
31.往下查看
在这里插入图片描述
32.解析到的mapper被封装到configuration中
在这里插入图片描述
总结： 好呢，这就完结了呢，new SqlSessionFactoryBuilder().build(inputStream)做的事就是把xml里面的所有配置解析成Java对象。

	/**
     * 一、解析数据库配置封装到 Configuration 对象
     * 1.SqlSessionFactoryBuilder().build(inputStream)
     *  2.XMLConfigBuilder.prase()
     *    3.parseConfiguration()
     *      4.environmentsElement()
     *        5.dataSourceElement()
     *          6.configuration.setEnvironment(environmentBuilder.build())
     * 二、解析Mapper封装到 Configuration 对象
     * 1.mapperElement()
     *  2.XMLMapperBuilder.prase()
     *    3.configurationElement()
     *      4.buildStatementFromContext()
     *        5.buildStatementFromContext()
     *          6.parseStatementNode()
     *            7.addMappedStatement()
     *              8.configuration.addMappedStatement(statement)
     */
Mybatis是如何执行sql语句？

1.F7进入openSession（）
在这里插入图片描述
2.F7进入openSessionFromDataSource（）
在这里插入图片描述
3.F7进入newExecutor（）
在这里插入图片描述
4.这部分是判断创建哪一个执行器，默认创建SimpleExecutor（），Ctrl到SIMPLE查看
在这里插入图片描述
5.创建执行器的三种类型
在这里插入图片描述
6.回退到第4步，Ctrl查看defaultExecutorType
在这里插入图片描述
7.回退到第4步，可以看到这里创建了一级缓存
在这里插入图片描述
8.Ctrl查看cacheEnabled，默认是true
在这里插入图片描述
9.回退到第1步
在这里插入图片描述
总结： mybaits是通过创建一个executor执行器来执行sql的，其底层是对jdbc的封装，下面会看到。

    /**
     * 执行器初始化，构建sqlSession，通过SqlSession得到Mapper接口对象进行数据库操作
     * 1.openSessionFromDataSource()
     *  2.configuration.newExecutor()
     *    3.new SimpleExecutor()
     */
Mybatis是如何执行数据库的？

1.F7进入selectOne（）在这里插入图片描述
2.F7进入selectList（）
在这里插入图片描述
3.F7进入selectList（）
在这里插入图片描述
4.F7进入query（）
在这里插入图片描述
5.F7进入query（）在这里插入图片描述
6.F7进入query（）
在这里插入图片描述
7.F7进入到queryFromDatabase（）
在这里插入图片描述
8.F7进入doQuery（）
在这里插入图片描述
9.F7进入query（）
在这里插入图片描述
10.F7进入handleResultSets（）
在这里插入图片描述
11.F7进入getFirstResultSet（）
在这里插入图片描述
12.F7进入ResultSetWrapper（）
在这里插入图片描述
13.F7进入super（）初始化，会创建三个List数组
在这里插入图片描述
14.创建三个list数组，分别用于存放数据表列名、Java对象字段类型名、数据表字段类型名
在这里插入图片描述
15.ORM框架的本质：不同系统数据类型之间的映射
在这里插入图片描述
16.F8下一步直到返回到第11步，F7进入handleResultSet（）
在这里插入图片描述
17.F7进入handleRowValues（）在这里插入图片描述
18.F7进入handleRowValuesForSimpleResultMap（）
在这里插入图片描述
19.F7进入getRowValue（）
在这里插入图片描述
20.F7进入applyAutomaticMappings（）
在这里插入图片描述
21.这部分是逐个根据映射拿到对应数据封装成对象，F7进入getResult（）
在这里插入图片描述
22.F7进入getNullableResult（）
在这里插入图片描述
23.getNullableResult（）主要就是将返回值作为Integer返回。
在这里插入图片描述
24.遍历完成后
在这里插入图片描述
结果如下：
在这里插入图片描述
总结：

    /**
     * 底层调用执行器查询数据：先开启本地缓存，在本地缓存中查找为空后，去数据库查找，然后把查询到的数据设置到缓存，在进行数据的映射、返回
     * 1.selectOne()
     *  2.selectList() -> selectList()
     *    3.executor.query()  -> createCacheKey() 创建缓存
     *      4.query() -> query()
     *        5.queryFromDatabase()
     *          6.doQuery()
     *            7.handleResultSets()
     *              8.getFirstResultSet()
     *                9.getResultSet()
     *                  10.ResultSetWrapper()
     *                  创建三个list数组，分别用于存放 数据表列名、Java对象字段类型名、数据表字段类型名
     *                  columnNames.add(configuration.isUseColumnLabel() ? metaData.getColumnLabel(i) : metaData.getColumnName(i));
     *                  jdbcTypes.add(JdbcType.forCode(metaData.getColumnType(i)));
     *                  classNames.add(metaData.getColumnClassName(i));
     *                    11.handleResultSet()
     *                      12.handleRowValues()
     *                        13.handleRowValuesForNestedResultMap
     *                          14.getRowValue()
     *                            15.applyAutomaticMappings() //自动映射
     */

（四）图解分析

经过微观分析，整个Mybatis的完整执行流程图，如下：

原图连接：https://processon.com/view/5cc57a59e4b059e20a0c21c0

在这里插入图片描述
在这里插入图片描述

架构图：
在这里插入图片描述

三、END

通过这一次简单的分析，对mybatis有了更深的认知呢，分析过程中省略了很多部分，并不全面，有兴趣的朋友可以自己去调试查看，这里对各个方法属性的解释也很少，因为都可以从名称语言上知道它们的作用，直接翻译，点进去看看实现吧~
欢迎留言指正、探讨、建议~
参考资料：

https://www.bilibili.com/video/BV1kt4y1e7iM?from=search&seid=9805382726736153233
https://mybatis.net.cn/logging.html
林⁣熙
关注
  • 0
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis源码分析
11-20
mybatis源码分析，包含建表语句，等等。开发者可以通过此源码分析mybatis实现原理。
通过源代码分析Mybatis的功能流程详解
08-18
通过源代码分析Mybatis的功能流程详解 Mybatis是当前最流行的持久化层框架之一，它提供了许多功能强大且灵活的特性，例如动态SQL、缓存机制、事务管理等等。想要真正理解Mybatis的功能流程，仅仅依靠官方文档和API...
MyBatis 源码分析——介绍
weixin_30747253的博客
01-31 122
笔者第一次接触跟MyBatis框架是在2009年未的时候。不过那个时候的他并不叫MyBatis，而是叫IBatis。2010年的时候改为现在的名字——MyBatis。这几年过去了，对于笔者来讲有一点陌生了。而且那个时候他也没有这么出名。hibernate占了大部分市场。虽然笔者早年的时候查看过他的源码，但是并没有很深入去理解他。主要的原因是因为当时我还在看hibernate的源码。太累了所以就没有...
Mybatis源码剖析
最新发布
weixin_70630201的博客
07-22 353
Mybatis关键源码剖析，超详细版
Mybatis源码分析（一）
蛾子
10-18 389
对于web开发的人来说mybatis并不陌生，用官网的话来说MyBatis是一个支持普通SQL查询，存储过程和高级映射的优秀持久层框架。它的优势在于消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录。...
Mybatis源码解析
weixin_42216907的博客
10-24 1717
Mybatis 在前面介绍了JDBC后，如果每次操作数据库都写一套JDBC，代码臃肿，耦合性高，因此Mybatis顺势而生。 文章目录Mybatis一、Mybatis是什么？二、使用步骤1.引入库2.读入数据总结欢迎使用Markdown编辑器新的改变功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能
Mybatis源码分析.pdf
08-30
总结起来，MyBatis源码分析涵盖了从配置加载到数据库操作的全过程，涉及到了配置解析、SQL执行、结果映射等多个关键环节，以及Executor、StatementHandler等核心组件。通过深入学习MyBatis的源码，开发者不仅可以...
MyBatis源码详解学习.zip
09-30
源码分析时，会了解到SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession等关键类的作用，它们构成了MyBatis的主要工作流程。 SqlSessionFactoryBuilder用于构建SqlSessionFactory，这是MyBatis的核心工厂，...
mybatis详解源码
01-21
MyBatis的源码分析主要涉及以下几个关键部分： 1. XML配置解析：MyBatis如何解析XML配置文件，包括映射文件（mapper.xml）和全局配置文件（mybatis-config.xml）。 2. SQL动态解析：MyBatis如何处理动态SQL，如if、...
MyBatis 的执行流程.pdf
07-07
### MyBatis执行流程详解 #### 1. Mapper接口和映射文件的绑定 MyBatis的Mapper接口与映射文件的绑定主要发生在项目启动时，当加载`mybatis-config.xml`配置文件时，MyBatis会解析其中的`<mappers>`节点来加载映射...
Mybatis源码分析
numun的博客
11-21 174
Mybatis源码分析 目录 一、 架构图 二、核心组件 三、源码分析 1、mybatis-config.xml获取sqlSessionFactory对象 2、根据sqlSessionFactory获取SqlSession对象 3、获取Mapper 4、mybatis执行SQL语句源码分析 一、 架构图 二、核心组件 Configuration：用于描述 MyBatis 主配置文件信息，MyBatis 框架在启动时会加载主配置文件，将配置信息转换为 Configura...
mybatis 源码分析
tumu6889的博客
07-24 451
mybatis
Mybatis 源码分析（一）
cfa3288的博客
10-10 563
我们主要完成了config配置文件、Mapper文件、Mapper接口中注解的解析我们得到了一个最重要的对象Configuration，这里面存放了全部的配置信息，在它的属性里还有各种各样的容器最后返回了一个DefaultSqlSessionFactory，里面持有了Configuration的实例最后时序图。
MyBatis源码分析
qq_68974327的博客
04-14 345
1.首先我们先了解一下Mybatis是什么： MyBatis 是一个开源、轻量级的数据持久化框架，是 JDBC 和 Hibernate 的替代方案。MyBatis 内部封装了 JDBC，简化了加载驱动、创建连接、创建 statement 等繁杂的过程，开发者只需要关注 SQL 语句本身。 2.工作原理和示例代码：（如图所示） 这里是一个查询总行数的 Test类： 总体步骤为： 1、加载核心配置文件到Configuration 2、构建SqlSessionFactory 3、打开SqlS...
Mybatis核心流程源码分析
大唐雨夜的博客
04-01 241
Mybatis启动过程 // 1. 读取配置文件，读成字节输入流，注意：现在还没解析 InputStream resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml"); // 2. 解析配置文件，封装Configuration对象。创建DefaultSqlSessionFactory对象 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().b
"Mybatis缓存配置与源码分析详解
本文主要讨论了Mybatis的缓存机制，包括一级缓存和二级缓存的使用、配置、工作流程以及源码分析。下面是全文总结： Mybatis是一款流行的Java持久化框架，它通过提供ORM（对象关系映射）的功能，将Java对象与数据库...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值