MyBatis源码分析（02）Configuration和SqlSessionFactory

爱被打了一巴掌 2022-12-09 05:29 104阅读 0赞

分析和学习一个框架的源码是一件非常枯燥和无聊的事（看同事的代码也是如此），所以我们遵循简单的步骤，从粗到细，从我们熟悉的内容到具体内容，一点点来学习mybatis。

其实我们对jdbc是很熟悉的，也了解jdbc的步骤，mybatis的底层是jdbc，那么mybatis在大步骤上一定和jdbc是差不多的，而在每一步上面，mybatis又是如何加入了自己的特色和元素，这是我们要分析和学习的地方。

首先来看一下我们前面写过的代码：

![a7b8a1a7ad5ea0cc42d4673aa1a5e834.png][]

上面的代码第一行和第二行是用来读取资源文件的，最后一行用来打印日志，这两行没有什么问题。从SqlSessionFactory开始，我们来加入几个断点，这样可以查看代码走到了哪里。

![fb04da38c732684961a69b35f4195fd9.png][]

我们的第一个起点是：

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

这个语句调用的是build方法，进入这个方法：

![3336505db46eb5058c4fe38a2bbce899.png][]

方法中还没有什么具体操作，然后我们记下第二步代码的过程：

> 1、SqlSessionFactory sqlSessionFactory =new SqlSessionFactoryBuilder().build(inputStream);
> 
> 2、org.apache.ibatis.session.SqlSessionFactoryBuilder 类的 build(java.io.InputStream)方法

然后进入下一个方法：

![e611e5eba4752df7dd7adff199d0c9cf.png][]

方法中使用了XMLConfigBuilder类，可以看出我们是在xml中做全局配置的，下面记录下现在第三步的过程：

下面的这一行build(parser.parse())是对配置的解析，我们进入，看看如何解析，先进入参数中的parse方法内：

![b3029e222f043df3450514733217c706.png][]

从上面我们看到了我们熟悉的mybatis全局配置的 "/configuration" 节点，也是配置文件的根节点，我们记录下第四步过程：

倒数第二行的方法parseConfiguration英文意思是解析配置的意思，我们进入看看：

![61b78bf31104593fd11bf9a6947b1cda.png][]

在这个方法中，相信大家能看到很多熟悉的关键字，它们都是mybatis全局配置文件中的标签，这个方法其实就是解析读取mybatis全局配置文件的内容，这个方法的参数是root，我们来看一下root的内容：

![049f06172568acd09f8a041496122517.png][]

其实就是我们配置文件的根目录下面的所有内容。而且不同的节点内容会用不同的方法解析，比如propertiesElement、typeAliasesElement、pluginElement等等，下面记录一下第五步过程：

这些节点解析中，我们重点看一下mapperElement，看看如何解析mappers节点，首先看一下root.evalNode("mappers")这个方法：

![0dddec3f87bda2a0257cabc69a115170.png][]

进来后调用的也是一个解析方法，我们记录一下第六步过程：

然后进入下一个解析方法：

![955993c3ae3a5824d629dd2b8ca46871.png][]

我们来记录一下第七步过程：

> 1、SqlSessionFactory sqlSessionFactory =new SqlSessionFactoryBuilder().build(inputStream);
> 
> 2、org.apache.ibatis.session.SqlSessionFactoryBuilder 类的 build(java.io.InputStream)方法
> 
> 3、org.apache.ibatis.session.SqlSessionFactoryBuilder 类的 build(java.io.InputStream, java.lang.String, java.util.Properties)方法
> 
> 4、org.apache.ibatis.builder.xml.XMLConfigBuilder 类的 parse方法
> 
> 5、org.apache.ibatis.builder.xml.XMLConfigBuilder 类的 parseConfiguration 方法
> 
> 6、org.apache.ibatis.parsing.XNode\#evalNode
> 
> 7、org.apache.ibatis.parsing.XPathParser\#evalNode(java.lang.Object, java.lang.String)

这个方法下面是evaluate方法：

![f3afd78f200e98b1330d32486892e5fe.png][]

这个方法是所有的解析xml节点的方法，都会调用这里。过程记录一下第八步过程：

上面的xpaht是一个接口，执行了evaluate方法，我们来看一下这个方法的具体实现，在idea中，按住ctrl+alt，然后点击方法名：

![6797df7c410925e351e920e870c29811.png][]

这是接口的实现方法，记录一下第九步过程：

可以看到这一步解析的方法已经不是mybatis中的类了，它使用的是jdk中的方法来解析xml的节点。这个方法中，前面是一系列的判断，最下面的try语句是执行的过程，我们看最后的return语句调用的方法：

![032756c9d4631cf873076cf2baf7ff38.png][]

最终的xml内容被解析成了集中基本的固定类型数据。关于jdk解析xml的这几个类，大家有兴趣可以自己学习一下。我们记录一下过程：

上面10步可以跟踪到xml数据的解析过程，我们回头再来看第5步，org.apache.ibatis.builder.xml.XMLConfigBuilder 类的 parseConfiguration 方法，

![35eccc1d69791bd6aa3b0bc61788f35d.png][]

节点解析完后进入的是mapperElement方法，

![21cdf28bb83bba4bdb6e8f632aa16fa4.png][]

这个方法的重点是解析mappers，从代码逻辑上可以看到，轮训mappers节点的子节点，然后判断类型是package还是resource或者其它，根据不同的类型做不同的操作，但是最终都执行了一个 configuration.addMapper(mapperInterface)  ，也就是把mappers的配置加到总的configuration配置中，可以想到其它类型的节点也是这样，比如：

![08d39339916fccac6b0b29bab0c62664.png][]

我们来记录一下过程，从第五步开始记：

现在再来看上面的第四步，parse方法返回的就是一个Configuration对象，这个对象就是我们前面提到的核心概念的第一个类：

![f077b32ce6aecf6ee86dd86d5c8ccd5e.png][]

现在我们对mybatis如何组织这个Configuration对象已经了解了，再来看第三步，

![7c0aede71f50627ee78f8bb83f8c9a0b.png][]

这个方法最终调用下面的build返回一个SqlSessionFactory，这个类就是我们前面提到的核心概念的第二个类：

![8c8ec23c387c5d2ccd6d21dfcf08cd80.png][]

来记录一下：

这样我们的第一步代码也就走完了：

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

现在我们已经知道mybatis如何根据一个全局的xml配置文件生成一个全局的配置对象，然后再根据这个配置对象返回一个SqlSessionFactory对象了。

下面总结一下，如果想看单个节点的解析过程：

如果想看mybatis全局配置中单个元素的解析过程（例如mappers），也就是全局Configuration对象的生成过程：

如果想看SqlSessionFactory生成的大致过程：

使用debug查看源码是一个不错的方法，不过要注意做好记录，否则中间可以会凌乱。从上面可以知道，mybatis的全局配置xml文件最终会组合成一个全局配置对象Configuration，我们进去看一下这个类：

![d28ad66db109af5fff24805439cc2cd1.png][]

这个类的所有属性和方法都是针对全局配置服务的，我们随便进入一个属性，比如第一个：

![4a46f8245830e56f1e9b1f3ad943abfe.png][]

这里面就有针对环境配置的所有参数：

![52bd4c5144d5ff042d74ad20f9ad3a7d.png][]

mybatis根据这个全局配置对象，生成一个SqlSessionFactory示例，SqlSessionFactory是一个接口，默认使用的实现类是DefaultSqlSessionFactory，可以进去简单看一下：

![c503c83447e29717e319ea7dde0c53e9.png][]

这里面大部分都是方法，只有一个属性，就是Configuration属性。

再对比jdbc，大家可以想一下，加载驱动，使用地址和用户名密码连接数据库，jdbc中只要两行代码就可以，mybatis为了让框架好用又具有适应性，做了很多工作。很多时候看框架源代码也能对我们开发自己的项目有很多启发。

[a7b8a1a7ad5ea0cc42d4673aa1a5e834.png]: /images/20221123/d472e8df2f17476a82f4dc36ff167bfb.png
[fb04da38c732684961a69b35f4195fd9.png]: /images/20221123/880850ede3184e93b54246c8024a7818.png
[3336505db46eb5058c4fe38a2bbce899.png]: /images/20221123/526b6ac3f3a34028b32e7fe3f2c1dcaa.png
[e611e5eba4752df7dd7adff199d0c9cf.png]: /images/20221123/04157026a5da4914b86d495711f36460.png
[b3029e222f043df3450514733217c706.png]: /images/20221123/8f5eb8bb386044928be2a3ed04b46005.png
[61b78bf31104593fd11bf9a6947b1cda.png]: /images/20221123/7b412bb1ac9e47e4be80ddcae188cf20.png
[049f06172568acd09f8a041496122517.png]: /images/20221123/a1e1d746b11945f8a7509dc0fd0b84a4.png
[0dddec3f87bda2a0257cabc69a115170.png]: /images/20221123/9b212543e2e843d7a7b7a6e748a03321.png
[955993c3ae3a5824d629dd2b8ca46871.png]: /images/20221123/826eff0c72174f6e98a9ffe416e0f295.png
[f3afd78f200e98b1330d32486892e5fe.png]: /images/20221123/cdb95098cdd0440b8b79bdfb6965e758.png
[6797df7c410925e351e920e870c29811.png]: /images/20221123/bfa81a0f86734920beebe2ca01c3100b.png
[032756c9d4631cf873076cf2baf7ff38.png]: /images/20221123/35afa0a563ac4a2699254e8cbaf03185.png
[35eccc1d69791bd6aa3b0bc61788f35d.png]: /images/20221123/80648c15288b4304a323fc1a2047def1.png
[21cdf28bb83bba4bdb6e8f632aa16fa4.png]: /images/20221123/c61a1cfcf1264de79567f1902af472a8.png
[08d39339916fccac6b0b29bab0c62664.png]: /images/20221123/af005a75842e4532b420c8b2822bbe1d.png
[f077b32ce6aecf6ee86dd86d5c8ccd5e.png]: /images/20221123/25f0f8ecddeb4801ad037ce9d4106095.png
[7c0aede71f50627ee78f8bb83f8c9a0b.png]: /images/20221123/9481d665c27a4a5d8a15101a34a8a04b.png
[8c8ec23c387c5d2ccd6d21dfcf08cd80.png]: /images/20221123/a3d1d5c3e83744bd81510a642c3c88ad.png
[d28ad66db109af5fff24805439cc2cd1.png]: /images/20221123/f07ea5bc40ad4f4e8dad31c1c4334802.png
[4a46f8245830e56f1e9b1f3ad943abfe.png]: /images/20221123/2ee60af5dfbd4c36888a37cae7ee8027.png
[52bd4c5144d5ff042d74ad20f9ad3a7d.png]: /images/20221123/b6e55d32bdc1451db3c97c98f9eb7c95.png
[c503c83447e29717e319ea7dde0c53e9.png]: /images/20221123/86e27a62b52b43c8aec089afeddb68d5.png