从0开始只要三步手写一个MyBatis

柔情只为你懂 2024-04-07 13:06 104阅读 0赞

最近研究了一下Mybatis，给大家磕叨磕叨，MyBatis框架的核心功能其实不难，无非就是动态代理和jdbc的操作，难的是写出来可扩展，高内聚，低耦合的规范的代码。本文完成的Mybatis功能比较简单，代码还有许多需要改进的地方，大家可以结合Mybatis源码去动手完善。  
一、Mybatis框架流程简介

![f0107ab8409b4cd0a4b9bcc52a869fe7.png][]  
在手写自己的Mybatis框架之前，我们先来了解一下Mybatis，它的源码中使用了大量的设计模式，阅读源码并观察设计模式在其中的应用，才能够更深入的理解源码。我们对上图进行分析总结：

mybatis的配置文件有2类

mybatisconfig.xml，配置文件的名称不是固定的，配置了全局的参数的配置，全局只能有一个配置文件。

Mapper.xml 配置多个statemement，也就是多个sql，整个mybatis框架中可以有多个Mappe.xml配置文件。

通过mybatis配置文件得到SqlSessionFactory

通过SqlSessionFactory得到SqlSession，用SqlSession就可以操作数据了。

SqlSession通过底层的Executor（执行器），执行器有2类实现：

![b7a41a09de42447396b7c5fdd844edfb.png][]  
基本实现

带有缓存功能的实现

MappedStatement是通过Mapper.xml中定义statement生成的对象。

参数输入执行并输出结果集，无需手动判断参数类型和参数下标位置，且自动将结果集映射为Java对象

HashMap，KV格式的数据类型

Java的基本数据类型

POJO，java的对象

二、梳理自己的Mybatis的设计思路

根据上文Mybatis流程，我简化了下，分为以下步骤：

![b736c254e45b4608b3144bdc74b9c71c.png][]  
1.读取xml文件，建立连接

从图中可以看出，MyConfiguration负责与人交互。待读取xml后，将属性和连接数据库的操作封装在MyConfiguration对象中供后面的组件调用。本文将使用dom4j来读取xml文件，它具有性能优异和非常方便使用的特点。

2.创建SqlSession，搭建Configuration和Executor之间的桥梁

我们经常在使用框架时看到Session，Session到底是什么呢？一个Session仅拥有一个对应的数据库连接。类似于一个前段请求Request，它可以直接调用exec(SQL)来执行SQL语句。从流程图中的箭头可以看出，MySqlSession的成员变量中必须得有MyExecutor和MyConfiguration去集中做调配，箭头就像是一种关联关系。我们自己的MySqlSession将有一个getMapper方法，然后使用动态代理生成对象后，就可以做数据库的操作了。

3.创建Executor，封装JDBC操作数据库

Executor是一个执行器，负责SQL语句的生成和查询缓存（缓存还没完成）的维护，也就是jdbc的代码将在这里完成，不过本文只实现了单表，有兴趣的同学可以尝试完成多表。

4.创建MapperProxy，使用动态代理生成Mapper对象

我们只是希望对指定的接口生成一个对象，使得执行它的时候能运行一句sql罢了，而接口无法直接调用方法，所以这里使用动态代理生成对象，在执行时还是回到MySqlSession中调用查询，最终由MyExecutor做JDBC查询。这样设计是为了单一职责，可扩展性更强。

三、实现自己的Mybatis

工程文件及目录：

![8cbbd5444bf9443193761a824732f4b0.png][]  
首先，新建一个maven项目，在pom.xml中导入以下依赖：

![5c1cc30ad35a4da2910810ff42a0f04a.png][]  
创建我们的数据库xml配置文件：

![e78b300bddae4efea75deee8fc0ae70f.png][]  
然后在数据库创建test库，执行如下SQL语句：

![421a982e70c94c2290f2043a9c49a0ed.png][]  
创建User实体类，和UserMapper接口和对应的xml文件:

![4aed2df88779473fae349edbc27d9528.png][]  
基本操作配置完成，接下来我们开始实现MyConfiguration：

![b18ac20ab6684c9cbda94154e62f0ab9.png][]![ae53a8f3e1bf4f54b754c918c082d3c7.png][] ![4d6a843c27e442b6883687a8aefe141f.png][] ![b4a06a850ad14ef29f9aac26b421979e.png][]

用面向对象的思想设计读取xml配置后：

![694ee4754fde4d7e8f82fd318f5c4f38.png][]  
接下来实现我们的MySqlSession,首先的成员变量里得有Excutor和MyConfiguration，代码的精髓就在getMapper的方法里。

![5b4c084bc5614b868c069996c4d563a7.png][]  
紧接着创建Executor和实现类：

![0065bdb3188e4d2f8bfc1106250edce4.png][]  
MyExecutor中封装了JDBC的操作：

![93c5c0a30dc84fe2951538ff3872ed75.png][]

![b54d73fd30a44670909f76f60f9908b8.png][]MyMapperProxy代理类完成xml方法和真实方法对应，执行查询：

![cdc6255bdb06467086fce0318a5b2924.png][]  
到这里，就完成了自己的Mybatis框架，我们测试一下：

![3aacfecb288c4df6a10ab250c6d33f8a.png][]  
执行结果：

![d2ea5e49f8824e2ab166b78ed4322459.png][]  
查询一个不存在的用户试试：

![7d700de7b6a64e418118c54c2c32f683.png][]  
到这里我们就大功告成了！

[f0107ab8409b4cd0a4b9bcc52a869fe7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/8eba6f438b4041308ccc845bf314cda7.png
[b7a41a09de42447396b7c5fdd844edfb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d26929946c7b402e884fdb8849dd6ac5.png
[b736c254e45b4608b3144bdc74b9c71c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/32b0145055e44337b438c60ab867240e.png
[8cbbd5444bf9443193761a824732f4b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/867488dd527b45ef9c867a6e2ea19568.png
[5c1cc30ad35a4da2910810ff42a0f04a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f7b28f36724d464faefe7886d79e49de.png
[e78b300bddae4efea75deee8fc0ae70f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/6f55681a6bb04f72b8418505284a5f5c.png
[421a982e70c94c2290f2043a9c49a0ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/47e44bf369a04691beebb8d7a451ac4d.png
[4aed2df88779473fae349edbc27d9528.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/1671de300bd5479da540faec9730b5af.png
[b18ac20ab6684c9cbda94154e62f0ab9.png]: https://img-blog.csdnimg.cn/b18ac20ab6684c9cbda94154e62f0ab9.png
[ae53a8f3e1bf4f54b754c918c082d3c7.png]: https://img-blog.csdnimg.cn/ae53a8f3e1bf4f54b754c918c082d3c7.png
[4d6a843c27e442b6883687a8aefe141f.png]: https://img-blog.csdnimg.cn/4d6a843c27e442b6883687a8aefe141f.png
[b4a06a850ad14ef29f9aac26b421979e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d8b4791cd27847e6b1e2a7b2d82f535f.png
[694ee4754fde4d7e8f82fd318f5c4f38.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/e048151a352844af9585a524b31ab0b8.png
[5b4c084bc5614b868c069996c4d563a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/af544c4cbfa94161adae2c2106c2fd27.png
[0065bdb3188e4d2f8bfc1106250edce4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/cc0397a80c6b400784e544277682c9ab.png
[93c5c0a30dc84fe2951538ff3872ed75.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f7f9f6ce6b8f402eb1dc2af302f922d1.png
[b54d73fd30a44670909f76f60f9908b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/bd9197ea19034168a11f1ee34b126bc2.png
[cdc6255bdb06467086fce0318a5b2924.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/08b5a8415ba644489a1c933cc4056179.png
[3aacfecb288c4df6a10ab250c6d33f8a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/9c6e6ab95c3a4020b24d1d7408aa483f.png
[d2ea5e49f8824e2ab166b78ed4322459.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/94616a09bd5b41838df70e0a7a9665c6.png
[7d700de7b6a64e418118c54c2c32f683.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/b80d5e572bb44bf287420c0eb00cab95.png