加载文件路径_[Mybatis]-[基础支持层]-mapper class 接口文件解析

忘是亡心i 2023-01-07 10:07 89阅读 0赞

![63e18bbd413cdb1d54d9e4118740696c.png][]

> 该系列文章针对 Mybatis 3.5.1 版本

上一篇文章提到，针对 `mybatis-config.xml` XML 配置中的 `<mappers>` ，Mybaits 主要会加载两个模块的数据

*  1、 XML 文件
 *  2、 mapper class 接口文件

来回顾一下 `mybatis-config.xml` 中 `<mappers>` 的配置示例，如下图：

![7ed0c10141951249ddcfb5669aa6d12d.png][]

如图，有两种配置方式，

一种：单独配置，通过 `<mapper resource="xml路径">`配置。多个 xml 文件，就有多个配置  
一种：扫包配置，通过 `<package name="xml.mapper"/>` 配置，配置 xml 文件所在的包路径，让程序扫包配置

再来回顾一下，`XMLConfigBuilder` 解析时序简图，如下：

![262c8046be10d3677556f59249c41ac7.png][]

在时序图中 `<mappers>` 加载解析在 `XMLConfigBuilder#mapperElement` 中完成，相关解析代码如下：

![59bce16da62281966a00e98c94ff76b0.png][]

如上述代码，针对 `<mappers>` 子标签的解析分为两种：扫包批量解析和单个文件解析。

而无论是扫包批量解析亦或者单个文件解析，都会对 xml 文件 和 class 文件进行解析处理。

本章，主要来讨论 mapper class 接口文件的加载，这里以 `<mapper>` 单个的加载为例，`<package>` 扫包方式类似可以自行查阅。

## **\`<mapper>\` 单文件加载分析** ##

先来看一下 `XMLConfigBuilder` 的解析入口，如下：

![6047c6520992bb0259ec1566cd0f5c33.png][]

如上述代码所示，针对 `<mapper>` 标签属性读取一共有三个，分别是：resource，url 和 class

其中 `resource` 和 `url` 配置的是 xml 文件路径，`resource` 对应的是本地项目路径，`url` 对应的远程文件路径。`resource` 、 `url` 和 `class` 属性配置在加载完xml文件后，同时也会加载相应的 class 类文件，并解析 class 类文件中的注解式的 SQL 语句。

针对本次章节讨论的 mapper class 文件解析，无论是 `resource` 、 `url` 和 `class` 属性配置，最后都会进行处理，mapper class 文件最终处理调用的是 `Configuration#addMappers` 代码。

> 关于 XML 文件的加载解析，在下一篇文章中展开

`Configuration#addMappers` 方法代码如下

![f67039b00feb0ac64e81f8ba4f2c169b.png][]

通过 `Configuration#addMappers` 能够看到一个容器类 `MapperRegistry`,该容器类存放了所有加载之后的 `Mapper.class` 内容，

> `MapperRegistry` 和前面提到的 `TypeAliasRegistry` 和 `TypeHandlerRegistery` 一样都是用来存储 Mybatis 特定内容的容器。

来看一下 Mapper class 文件注册到 MapperRegistry 容器的代码， `MapperRegistry#addMapper` 。

![34e36a7a75e19cf7ba89db2c748a0205.png][]

通过上述代码整理 mapper class 解析流程判断如下：

1、`Mapper.class` 必须是一个接口  
2、`Mapper.class` 会以代理对象的形式存储于 `MapperRegistry#knownMappers` 中，该代理对象为 `MapperProxyFactory`  
3、`Mapper.class` 中方法上的 `@Select` 等注解解析通过 `MapperAnnotationBuilder` 完成。

从上述流程能够再将 mapper class 解析后的数据分为两部分：

一部分：mapper class 本身对应的代理类工厂 `MapperProxyFactory` ，该信息存储在 `MapperRegistry#knownMappers` 中  
一部分：mapper class 方法函数上对应的注解，所绑定的 SQL

> 关于 Mapper.class 中 `@Select` 等注解的解析，将会在下一章和 Mapper xml 中 `<select>` 等标签解析一起讲解 `Mapper.class` 代理对象 `MapperProxy` 的使用将在核心业务层，进行数据访问调用时展开。

## **完善Mybatis 运行框架图** ##

Mybatis 在加载 mapper class 文件后，会将其通过 `MapperProxyFactory` 代理工厂进行包装，然后存放在 `MapperRegistry` 中，同时会将 `MapperRegistry` 以属性对象的形式，存储在 `Configuration` 对象中。

完善对应的运行框架图，如下：

![f30cc1a2067a601a4b1911b5957ec386.png][]

[63e18bbd413cdb1d54d9e4118740696c.png]: /images/20221119/7537ac3a6aa34ee28b040c2f435477e7.png
[7ed0c10141951249ddcfb5669aa6d12d.png]: /images/20221119/388d12881f954805aea6411c1b7aa43b.png
[262c8046be10d3677556f59249c41ac7.png]: /images/20221119/40b351a0d9784785ae63ae83a5d123cc.png
[59bce16da62281966a00e98c94ff76b0.png]: /images/20221119/d699747beb0b4d159959511209bf58bf.png
[6047c6520992bb0259ec1566cd0f5c33.png]: /images/20221119/9e0469f2bae34160ac31698eb8d7434f.png
[f67039b00feb0ac64e81f8ba4f2c169b.png]: /images/20221119/7bcb86bbd20a4b1c8efc98f73587f452.png
[34e36a7a75e19cf7ba89db2c748a0205.png]: /images/20221119/f33bb4a423cd4103b62d4e6e02b169dd.png
[f30cc1a2067a601a4b1911b5957ec386.png]: /images/20221119/ef678e089a84451bb33dd1cbee08d696.png