从 0 开始手写一个 Mybatis 框架，三步搞定！

小Hub领读：

弄懂mybatis的各个组件的关系，然后逐渐构建组件，搞成一个框架！

• 作者：我叫刘半仙

源码地址：github.com/qq53182347/liugh-mybatis

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

一、Mybatis 框架流程简介

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

1、 mybatis 的配置文件有 2 类

• mybatisconfig.xml，配置文件的名称不是固定的，配置了全局的参数的配置，全局只能有一个配置文件。
• Mapper.xml 配置多个 statemement，也就是多个 sql，整个 mybatis 框架中可以有多个 Mappe.xml 配置文件。

2、 通过 mybatis 配置文件得到 SqlSessionFactory

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

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

• 基本实现

• 带有缓存功能的实现

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

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

• HashMap，KV 格式的数据类型
• Java 的基本数据类型
• POJO，java 的对象

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

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

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

工程文件及目录：

首先，新建一个 maven 项目，在 pom.xml 中导入以下依赖：

创建我们的数据库 xml 配置文件：

然后在数据库创建 test 库，执行如下 SQL 语句：

创建 User 实体类，和 UserMapper 接口和对应的 xml 文件:

基本操作配置完成，接下来我们开始实现 MyConfiguration：

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

Function 对象包括 sql 的类型、方法名、sql 语句、返回类型和参数类型。

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

紧接着创建 Excutor 和实现类：

MyExcutor 中封装了 JDBC 的操作：

MyMapperProxy 代理类完成 xml 方法和真实方法对应，执行查询：

到这里，就完成了自己的 Mybatis 框架，我们测试一下：

执行结果：

查询一个不存在的用户试试：

到这里我们就大功告成了！

我是个普通的程序猿，水平有限，文章难免有错误，欢迎牺牲自己宝贵时间的读者，就本文内容直抒己见，我的目的仅仅是希望对读者有所帮助。