MyBatis源代码学习

最新推荐文章于 2025-05-18 16:26:14 发布
原创 最新推荐文章于 2025-05-18 16:26:14 发布 · 588 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #mybatis

什么是 MyBatis

 

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

版本

mybatis：3.5.3

源码分析

使用（不集成Spring）

public class App {
    public static void main(String[] args) {
        String resource = "mybatis-config.xml";
        Reader reader;
        try {
            //将XML配置文件构建为Configuration配置类
            reader = Resources.getResourceAsReader(resource);
            // 通过加载配置文件流构建一个SqlSessionFactory  DefaultSqlSessionFactory
            SqlSessionFactory sqlMapper = new SqlSessionFactoryBuilder().build(reader);
            // 数据源 执行器  DefaultSqlSession
            SqlSession session = sqlMapper.openSession();
            try {
                // 执行查询 底层执行jdbc
                TimeZoneName timeZoneName = (TimeZoneName)session.selectOne("com.whc.mapper.TimeZoneNameMapper.selectById", 12);

                TimeZoneNameMapper timeZoneNameMapper = session.getMapper(TimeZoneNameMapper.class);
                TimeZoneName zoneName = timeZoneNameMapper.selectById(11);
                System.out.println(zoneName);
                /*UserMapper mapper = session.getMapper(UserMapper.class);
                System.out.println(mapper.getClass());
                User user = mapper.selectById(1L);*/
                session.commit();
                System.out.println(timeZoneName);
            } catch (Exception e) {
                e.printStackTrace();
            }finally {
                session.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

流程主要分为以下几步：

1.解析配置文件

2.解析mapper

3.获取SqlSession

4.使用

解析配置文件

最终在org.apache.ibatis.builder.xml.XMLConfigBuilder#parseConfiguration 中解析xml配置文件各个属性

 private void parseConfiguration(XNode root) {
        try {
            //1.解析 properties节点
            propertiesElement(root.evalNode("properties"));
            //2.解析 settings节点
            Properties settings = settingsAsProperties(root.evalNode("settings"));
            //3.加载自定义文件系统
            loadCustomVfs(settings);
            //4.加载自定义日志实现类
            loadCustomLogImpl(settings);
            //5.加载别名
            typeAliasesElement(root.evalNode("typeAliases"));
            //6.加载插件
            pluginElement(root.evalNode("plugins"));
            //不常用
            objectFactoryElement(root.evalNode("objectFactory"));
            objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
            reflectorFactoryElement(root.evalNode("reflectorFactory"));
            //7.设置settings 和默认值
            settingsElement(settings);
            //8.environments节点
            environmentsElement(root.evalNode("environments"));
            //9.解析数据库厂商
            databaseIdProviderElement(root.evalNode("databaseIdProvider"));
            //10.解析我们的类型处理器节点
            typeHandlerElement(root.evalNode("typeHandlers"));
            //11.解析mapper
            mapperElement(root.evalNode("mappers"));
        } catch (Exception e) {
            throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
        }
    }

1.解析属性（properties）

<properties resource="org/mybatis/example/config.properties">
  <property name="username" value="dev_user"/>
  <property name="password" value="F2Fa3!33TYyg"/>
</properties>

2.解析设置（settings）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 

<settings>
  <setting name="cacheEnabled" value="true"/>
  <setting name="lazyLoadingEnabled" value="true"/>
  <setting name="multipleResultSetsEnabled" value="true"/>
  <setting name="useColumnLabel" value="true"/>
  <setting name="useGeneratedKeys" value="false"/>
  <setting name="autoMappingBehavior" value="PARTIAL"/>
  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <setting name="defaultStatementTimeout" value="25"/>
  <setting name="defaultFetchSize" value="100"/>
  <setting name="safeRowBoundsEnabled" value="false"/>
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <setting name="localCacheScope" value="SESSION"/>
  <setting name="jdbcTypeForNull" value="OTHER"/>
  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>

3.加载自定义文件系统

VFS含义是虚拟文件系统；主要是通过程序能够方便读取本地文件系统、FTP文件系统等系统中的文件资源。

Mybatis中提供了VFS这个配置，主要是通过该配置可以加载自定义的虚拟文件系统应用程序 解析到：org.apache.ibatis.session.Configuration#vfsImpl

4.加载自定义日志实现类

指定 MyBatis 所用日志的具体实现，未指定时将自动查找。

* SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING *

解析到org.apache.ibatis.session.Configuration#logImpl

5.加载类型别名（typeAliases）

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

当这样配置时，Blog 可以用在任何使用 domain.blog.Blog 的地方。

6.加载插件

configuration.addInterceptor(interceptorInstance);

 会加入到  InterceptorChain 拦截器链

7.设置settings 和默认值

 private void settingsElement(Properties props) {
    configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL")));
    configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE")));
    configuration.setCacheEnabled(booleanValueOf(props.getProperty("cacheEnabled"), true));
    configuration.setProxyFactory((ProxyFactory) createInstance(props.getProperty("proxyFactory")));
    configuration.setLazyLoadingEnabled(booleanValueOf(props.getProperty("lazyLoadingEnabled"), false));
    configuration.setAggressiveLazyLoading(booleanValueOf(props.getProperty("aggressiveLazyLoading"), false));
    configuration.setMultipleResultSetsEnabled(booleanValueOf(props.getProperty("multipleResultSetsEnabled"), true));
    configuration.setUseColumnLabel(booleanValueOf(props.getProperty("useColumnLabel"), true));
    configuration.setUseGeneratedKeys(booleanValueOf(props.getProperty("useGeneratedKeys"), false));
    configuration.setDefaultExecutorType(ExecutorType.valueOf(props.getProperty("defaultExecutorType", "SIMPLE")));
    configuration.setDefaultStatementTimeout(integerValueOf(props.getProperty("defaultStatementTimeout"), null));
    configuration.setDefaultFetchSize(integerValueOf(props.getProperty("defaultFetchSize"), null));
    configuration.setDefaultResultSetType(resolveResultSetType(props.getProperty("defaultResultSetType")));
    configuration.setMapUnderscoreToCamelCase(booleanValueOf(props.getProperty("mapUnderscoreToCamelCase"), false));
    configuration.setSafeRowBoundsEnabled(booleanValueOf(props.getProperty("safeRowBoundsEnabled"), false));
    configuration.setLocalCacheScope(LocalCacheScope.valueOf(props.getProperty("localCacheScope", "SESSION")));
    configuration.setJdbcTypeForNull(JdbcType.valueOf(props.getProperty("jdbcTypeForNull", "OTHER")));
    configuration.setLazyLoadTriggerMethods(stringSetValueOf(props.getProperty("lazyLoadTriggerMethods"), "equals,clone,hashCode,toString"));
    configuration.setSafeResultHandlerEnabled(booleanValueOf(props.getProperty("safeResultHandlerEnabled"), true));
    configuration.setDefaultScriptingLanguage(resolveClass(props.getProperty("defaultScriptingLanguage")));
    configuration.setDefaultEnumTypeHandler(resolveClass(props.getProperty("defaultEnumTypeHandler")));
    configuration.setCallSettersOnNulls(booleanValueOf(props.getProperty("callSettersOnNulls"), false));
    configuration.setUseActualParamName(booleanValueOf(props.getProperty("useActualParamName"), true));
    configuration.setReturnInstanceForEmptyRow(booleanValueOf(props.getProperty("returnInstanceForEmptyRow"), false));
    configuration.setLogPrefix(props.getProperty("logPrefix"));
    configuration.setConfigurationFactory(resolveClass(props.getProperty("configurationFactory")));
  }

8.environments环境配置节点

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

不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。

9.解析数据库厂商

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。 MyBatis 会加载带有匹配当前数据库 databaseId 属性和所有不带 databaseId 属性的语句。 如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。 为支持多厂商特性，只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

<databaseIdProvider type="DB_VENDOR" />

10.解析我们的类型处理器typeHandlers节点

MyBatis 在设置预处理语句（PreparedStatement）中的参数或从结果集中取出一个值时， 都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。

11.解析映射器（mappers）

指定mapper映射文件可以通过如下4中方式：类路径的资源引用，或完全限定资源定位符（包括 file:/// 形式的 URL），或类名和包名

<!-- 使用相对于类路径的资源引用 -->
<mappers>
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
<mapper resource="org/mybatis/builder/BlogMapper.xml"/>
<mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>
<!-- 使用完全限定资源定位符（URL） -->
<mappers>
<mapper url="file:///var/mappers/AuthorMapper.xml"/>
<mapper url="file:///var/mappers/BlogMapper.xml"/>
<mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
<mapper class="org.mybatis.builder.AuthorMapper"/>
<mapper class="org.mybatis.builder.BlogMapper"/>
<mapper class="org.mybatis.builder.PostMapper"/>
</mappers>
<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
<package name="org.mybatis.builder"/>
</mappers>

解析mapper文件

入口在：org.apache.ibatis.builder.xml.XMLConfigBuilder#mapperElement

我们是通过<package name=""></package> 包名批量注册的，所以会走

if ("package".equals(child.getName()))分支，

通过configuration.addMappers(mapperPackage)来解析

在MapperRegistry#addMappers(java.lang.String, java.lang.Class<?>)中循环指定包名下的每个类，使用 MapperAnnotationBuilder 的parse()解析每个类，

最终用XMLMapperBuilder.parse() 方法解析mapper.xml文件

我们来看看org.apache.ibatis.builder.xml.XMLMapperBuilder#configurationElement，具体解析mapper.xml

 private void configurationElement(XNode context) {
    try {
      /**
       * 1.解析namespace属性
       * <mapper namespace="com.whc.mapper.EmployeeMapper">
       */
      String namespace = context.getStringAttribute("namespace");
      if (namespace == null || namespace.equals("")) {
        throw new BuilderException("Mapper's namespace cannot be empty");
      }
      /**
       * 2.保存当前的namespace  并且判断接口完全类名==namespace
       */
      builderAssistant.setCurrentNamespace(namespace);
      /**
       * 3.解析缓存引用
       * 说明我当前的缓存引用和DeptMapper的缓存引用一致
       * <cache-ref namespace="com.whc.mapper.DeptMapper"></cache-ref>
            解析到org.apache.ibatis.session.Configuration#cacheRefMap<当前namespace,ref-namespace>
            异常下（引用缓存未使用缓存）：org.apache.ibatis.session.Configuration#incompleteCacheRefs
       */
      cacheRefElement(context.evalNode("cache-ref"));
      /**
       * 4.解析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"));
      /**
       * 5.解析paramterMap节点(该节点mybaits3.5貌似不推荐使用了)
       */
      parameterMapElement(context.evalNodes("/mapper/parameterMap"));
      /**
       * 6.解析我们的resultMap节点
       * 解析到：org.apache.ibatis.session.Configuration#resultMaps
       *    异常 org.apache.ibatis.session.Configuration#incompleteResultMaps
       *
       */
      resultMapElements(context.evalNodes("/mapper/resultMap"));
      /**
       * 7.解析我们通过sql节点
       *  解析到org.apache.ibatis.builder.xml.XMLMapperBuilder#sqlFragments
       *   其实等于 org.apache.ibatis.session.Configuration#sqlFragments
       *   因为他们是同一引用，在构建XMLMapperBuilder 时把Configuration.getSqlFragments传进去了
       */
      sqlElement(context.evalNodes("/mapper/sql"));
      /**
       * 8.解析我们的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);
    }
  }

当配置了<cache ></cache>节点后，会在“4”中创建二级缓存对象

二级缓存对象通过装饰器模式，一层层包装

SynchronizedCache-->LoggingCache-->SerializedCache-->LruCache-->PerpetualCache

而解析select | insert |update |delete节点会在XMLMapperBuilder#buildStatementFromContext(java.util.List<org.apache.ibatis.parsing.XNode>)方法中，通过 langDriver.createSqlSource()，由默认的XMLLanguageDriver 驱动来解析，最终递归解析每个节点

递归解析  selectById这个sql元素会解析成
   1层  MixedSqlNode <SELECT>
   2层  WhereSqlNode <WHERE>
   2层  IfSqlNode <IF>

把解析结果放入 mappedStatement

获取SqlSession

通过SqlSessionFactory.openSession()获得回话

openSession()主要作用：

1.创建执行器 Executor ： newExecutor

2.依次调用每个插件的plugin方法，包装Executor

  public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
    executorType = executorType == null ? defaultExecutorType : executorType;
    executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
    Executor executor;
    /**
     * 判断执行器的类型
     * 批量的执行器
     */
    if (ExecutorType.BATCH == executorType) {
      executor = new BatchExecutor(this, transaction);
    } else if (ExecutorType.REUSE == executorType) {
      //可重复使用的执行器
      executor = new ReuseExecutor(this, transaction);
    } else {
      //简单的sql执行器对象
      executor = new SimpleExecutor(this, transaction);
    }
    //判断mybatis的全局配置文件是否开启缓存
    if (cacheEnabled) {
      //把当前的简单的执行器包装成一个CachingExecutor
    }
    executor = new CachingExecutor(executor);
    /**
     * 调用所有的拦截器对象plugin方法
     */
    executor = (Executor) interceptorChain.pluginAll(executor);
    return executor;
  }

执行查询

 TimeZoneNameMapper timeZoneNameMapper = session.getMapper(TimeZoneNameMapper.class);
                TimeZoneName zoneName = timeZoneNameMapper.selectById(11);

 由于我们是返回单个对象，所以调用selectOne

 最后我们得到了

O：className

R：jdbcTypes

M：columnNames

根据对应关系，我们得到了返回值对象

流程图

总体

 解析xml

 执行sql

mybatis源码学习
每天进步一点点
07-04 228
什么是mybatis MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。 mybatis的初始化 String resource = "mybatis-config.xml"; InputStream inp
Mybatis系列学习源码
12-31
Mybatis系列学习源码 详细学习系列请参考http://www.cnblogs.com/daviddai/p/3485574.html
学习Mybatis源码
03-14 510
在周末没事的时候，可以学习下Kafka,Mybatis,Tomcat,Spring,Zk,springBoot等源码，从中可以学习到很多东西，比如里面用到哪些设计模式，项目架构，优秀代码示例，这对我们工作中 开发代码或排查定位问题都会提供一定的帮助。 1.新建demo项目 搞个简单的增删改查就行，这个很简单（不会的网上查下）然后同时把源码也从github上下载，下载地址见 ht...
Mybatis源码学习-sql执行流程
最新发布
qq_45325916的博客
05-18 978
在mapperRegistry 从已知的knownMappers 一个集合中获取 Mapper代理对象工厂，再由MapperProxyFactory 去创建一个实例，最终返回，BaseExecutor 中有一个 localCache ，应该就是Mybatis的一级缓存，CachingExecutor 中的是二级缓存，当缓存中不存在时，则从数据库中查询。在 mapperRegistry 中有一个 mapperRegistry的方法，我们在这里打一个断点，然后重新启动，观察是什么时候进入到这个方法的。
Mybatis源码学习(一)-整体框架理解
weixin_34289744的博客
07-22 155
2019独角兽企业重金招聘Python工程师标准>>> ...
MyBatis源码学习
POISON_HU的博客
05-27 241
1.Mybatis特性 MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架 MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集 MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录 MyBatis 是一个 半自动的ORM（Object Relation Mapping）框架 轻量级，性能出色 SQL 和 Java 编码分开，功能边.
基于Java的Mybatis源代码学习与logback日志配置文件配置技巧
10-03
在Mybatis源代码学习方面，开发者可以从源文件中了解到Mybatis的核心组件如SqlSessionFactory、SqlSession、Executor、StatementHandler、ParameterHandler以及ResultHandler等，这些都是Mybatis框架中处理数据库...
MyBatis源代码.zip
03-27
通过对MyBatis源代码的学习，我们可以了解其内部设计模式和工作流程，更好地利用这个框架，甚至为它贡献自己的代码。此外，熟悉数据库建库脚本有助于理解MyBatis在实际项目中的应用，确保数据表结构与Java实体类的...
mybatis源代码
12-10
在MyBatis-3.3.0中，你可以通过查看源代码学习到如何构建复杂的SQL查询，理解MyBatis的动态SQL机制，以及如何利用MyBatis的缓存机制提高性能。此外，还可以深入了解MyBatis的事务管理和异常处理策略。通过深入学习...
Mybatis源代码+jar包
09-02
Mybatis 是一个流行的Java持久层框架，用于简化数据库操作，特别是与...通过阅读源代码，可以学习到Mybatis的设计模式和实现细节，提升开发能力。同时，jar包的使用则使得快速开发成为可能，降低了项目中的复杂度。
Mybatis学习源代码
05-11
本文将基于“Mybatis学习源代码”这一主题，深入探讨Mybatis的基本概念、核心功能以及如何通过狂神说的视频教程进行学习。 Mybatis是一个基于Java的持久层框架，它提供了一个SQL映射框架，可以将SQL语句与Java代码...
mybatis源码学习（一）
vermouth的博客
05-18 278
MyBatis 3.5.1 MyBatis官方文档 源码下载地址（推荐使用码云中转下载） mybatis-parent项目下载地址 选择自己所需要的MyBatis版本下载 查看pom文件中所对应的mybatis-parent项目版本 根据tag下载所需要的项目包。 导入idea，选择jdk进行编译。 新建一个maven模块 pom文件引入依赖 ` <dependency> <groupId>org.mybatis</groupId>
MyBatis源码学习（1）
yangxiaochen0302的博客
07-28 399
MyBatis源码学习（1） MyBatis环境搭建 最近开始准备学习MyBatis的源码，第一件事当然就是搭建环境。 JDK:1.8 IDE:Idea mysql:8.0.11 首先需要安装Git，正常下载安装就可以，然后需要在Idea中配置一下，如下 图： 配置完Git，就可以开始在GitHub上下载代码了，MyBtais是MAVEN构建的，所以还要再...
Mybatis源码学习
dongdong199033的博客
06-13 1346
本篇文章只是简单的带大家过一下整个Mybatis的流程，先有个初步的认识，后续有机会，再针对性的剖析细节。
Mybatis源码学习理解
m0_37601207的博客
12-19 885
Mybatis源码学习理解 一、Mabatis的介绍： MyBatis是一个持久层（ORM）框架，使用简单，学习成本较低。可以执行自己手写的SQL语句，比较灵活。但 是MyBatis的自动化程度不高，移植性也不高，有时从一个数据库迁移到另外一个数据库的时候需要自己修改配 置，所以称只为半自动ORM框架； 二、传统数据库连接弊端： 数据库是软件项目中存储持久化数据最常用的场所，应用十分广泛。 但是：1.数据库连接创建，释放频繁造成资源的浪费，从而影响系统性能，使用数据库连接池可以解决问题。 2.sql
Mybatis 源码学习分享
weixin_38303310的博客
05-31 295
Mybatis 源码学习分享 前言 最近我参加了网易云课堂的微专业学习，在里面学习到了一种看框架源码的方法，就拿比较简单的 Mybatis 框架来小试牛刀一下，所以今天跟大家来分享一下 自己看框架学习到的内容（ps. 这是我第一次写的文章，如果有什么纰漏请大家指出哈~，如果大家对排版有什么意见的话也可以说一下，希望下一次的文章会有所进步） Mybatis 简介 想要了解什么是 Mybatis 必须先了解什么是 ORM（Object Relational Mapping） 框架， ORM 的意思是对象关系
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值