mybatis源码学习之mybatis执行流程分析

太过爱你忘了你带给我的痛 2024-03-16 13:17 56阅读 0赞

## Mybatis执行流程分析 ##

### mybatis全局配置文件 ###

mybatis全局配置文件中涉及的标签如下图所示  
![在这里插入图片描述][57b702119f964e1884b9c20487c37b14.png]

### 配置文件解析 ###

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对象**  
![在这里插入图片描述][ecbe52bd45bf49fea84c382bc93dc285.png]

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

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

### 获取SqlSession ###

调用openSession()方法获取SqlSession  
![69d67c8f48bd46afb3a8166229f2b36f.png][]  
![在这里插入图片描述][df779a60296b42548d8a087983f7b547.png]

创建Executor的对象，这里会根据类型去创建对应的Executor  
![在这里插入图片描述][2259ac7f47314ef8a0492f37a53f4118.png]

最后一行的代码：interceptorChain.pluginAll(executor)的作用是会调用所有拦截器对象的plugin方法  
![bf7b93766a6a488083cd003c2201ce30.png][]

![e4e72087bd4b4c4cacfd88aa10aa2858.png][]  
最后执行到Plugin类的wrap方法对executor进行包装  
![ff30c532d35f405cba65eb87feebffc2.png][]

### 执行getMapper方法 ###

实际上调用的是configuration对象的getMapper方法  
![在这里插入图片描述][ae356da8283e4a009cc163cd0b975069.png]

而configuration对象则是调用了mapperRegistry对象的getMapper方法；  
![在这里插入图片描述][25816b7d2b234f4996c17e5d46cc7aa4.png]

**MapperRegistry简介**

*  MapperRegistry实质上是一个Map，里面注册了启动过程中解析的各种mapper.xml；
 *  MapperRegistry的key是接口的Class类型，MapperRegistry的value是MapperProxyFactory，用于生成对应的MapperProxy（动态代理类）；
 *  由于Mybatis中的Mapper接口没有实现类，所以MapperProxy这个代理对  
    象中没有委托类，也就是说MapperProxy干了代理类和委托类的事情  
    ![在这里插入图片描述][b039e20f5ab444a6a4f84a44a7176eba.png]

接着往下看；mapperRegistry的getMapper方法则是调用了mapperProxyFactory的newInstance方法  
![在这里插入图片描述][8903cc293e184a89a7b7a63c61255226.png]  
**MapperProxyFactory介绍**

*  在通过sqlSession获取Mapper时，其实先获取到的是这个工厂，然后通过这个工厂创建Mapper的动态代理类

MapperProxyFactory中的newInstance方法如下：  
![在这里插入图片描述][240d73cf27574501a54789bfb3cb5cdf.png]

这里用到了动态代理，最后会调用MapperProxy中重写的的invoke方法  
![在这里插入图片描述][4687baa046c7460480357e6c5d53a599.png]  
![在这里插入图片描述][d76da7d5ba2546b983faf6476d977934.png]

execute方法如下：  
![在这里插入图片描述][787fb2438af84141b5bdd7af61781927.png]

接着会调用executeForManay方法  
![在这里插入图片描述][313524388c384aa7be692b14e1dc7ef0.png]

selectList方法如下：  
![在这里插入图片描述][c6b68acb7746429e814f068d84b12824.png]

接着会执行exector中的query方法  
![在这里插入图片描述][681924e53e934ff489b6998145b6f963.png]  
![在这里插入图片描述][5f11c107739348ffbf41863b279e66bd.png]

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-6lTPACoy-1685886501778)(Pasted%20image%2020230321214105.png)\]][img-6lTPACoy-1685886501778_Pasted_20image_2020230321214105.png]

可以看到最后使用的还是JDBC中的Statement，最后把查询到的结果返回查询流程就结束了。  
![在这里插入图片描述][e196221b25a34bcbb745934ffaa39a7b.png]

下面mybatis总的一个处理流程：  
![在这里插入图片描述][a86b1baeeab14fd099d97faf574d0a91.png]

mybatis一个大致的执行流程分析就到这里结束了，后面会继续详细讲解执行流程中涉及到的相关内容。

### 参考 ###

*  [Mybatis文档][Mybatis]
 *  mybatis学习视频

[57b702119f964e1884b9c20487c37b14.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/20052fe9b1d2431da108793a5f1bcd33.png
[ecbe52bd45bf49fea84c382bc93dc285.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/e11b424bb89e44978647f8c1d631c1c1.png
[99989760f13941a5bec733131f5ba38b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/93a19eb8bfa84e6291e98756dfd5c0e2.png
[img-YjYs8014-1685886063612_Pasted_20image_2020230223222648.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/5c4d83101a1f4a35ad6611a6daafc05a.png
[69d67c8f48bd46afb3a8166229f2b36f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/ee45f1367fd44dccb91d3b26093bd09a.png
[df779a60296b42548d8a087983f7b547.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/5a902582940649e98decb84801486aa5.png
[2259ac7f47314ef8a0492f37a53f4118.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/cd606cd11a744e1b8934c20ca7e27cf5.png
[bf7b93766a6a488083cd003c2201ce30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/c8d50fa4de2545e68c5e0cd0ebbd05d0.png
[e4e72087bd4b4c4cacfd88aa10aa2858.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/53c59e6afac84f60a479ede876f65143.png
[ff30c532d35f405cba65eb87feebffc2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/832a39ad26874d9d8f9206811a57161b.png
[ae356da8283e4a009cc163cd0b975069.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/d04b29f0ee32427b89ce48237a88f40b.png
[25816b7d2b234f4996c17e5d46cc7aa4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/f70ec624c74d4c60b38bfcf49ef7fa94.png
[b039e20f5ab444a6a4f84a44a7176eba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/471e747b49294269a057de872744c02d.png
[8903cc293e184a89a7b7a63c61255226.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/3ff0dc1a47ab4a0bb81bf2545597dcd8.png
[240d73cf27574501a54789bfb3cb5cdf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/7513355b7d774e0fb264b127e3e2fcd7.png
[4687baa046c7460480357e6c5d53a599.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/274066c7bed64a6e9dd4b57606d76ce0.png
[d76da7d5ba2546b983faf6476d977934.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/c61411a8bbb649ccbeede3a1233f324f.png
[787fb2438af84141b5bdd7af61781927.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/50fb7eb0884f459fb996df724c441a0b.png
[313524388c384aa7be692b14e1dc7ef0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/cb9c31f3f3e247ac89b0a1ba2f9cd0b6.png
[c6b68acb7746429e814f068d84b12824.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/29e537c7aa5f40c0afc50f990dbec7f5.png
[681924e53e934ff489b6998145b6f963.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/3105ff5e14b2454692ba4d946da944d7.png
[5f11c107739348ffbf41863b279e66bd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/44653871f0984cfaa5a5409808a24952.png
[img-6lTPACoy-1685886501778_Pasted_20image_2020230321214105.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/2ab929231c414594ba742f2b29cf52a1.png
[e196221b25a34bcbb745934ffaa39a7b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/a8a0bf96aa5f4bdc843967999aa35f68.png
[a86b1baeeab14fd099d97faf574d0a91.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/ae24bda55fd147b2a5102dfbe6985e39.png
[Mybatis]: https://mybatis.org/mybatis-3