Mybatis整体架构

         好久之前就想学习一下mybatis的源码，从中学习一下框架中用到的设计模式以及比较给力的代码写法，从官方仓库 https://github.com/mybatis/mybatis-3 Fork 出属于自己的仓库，clone到本地，导入idea后的结构如下：

一眼看去真的好多包啊，感觉接下来的学习一定会很有意思了。

---

Mybatis的整体架构可以分为三层：

1）基础支持层

    该层包括：数据源模块、事务管理模块、缓存模块、反射模块、类型转换模块、日志模块、资源加载模块、解析器模块、异常模块、注解模块、Binding模块

2）核心处理层

     该层包括：配置解析、参数映射、SQL解析、SQL执行、结果映射、插件      

3）接口层

     该层包括：SqlSession

下面我们先了解一下每个模块对应的功能以及对应源码中的包。

---

一、基础支持层

该层主要为核心处理层提供了良好的支撑。

1、数据源模块（对应 datasource 包。）

       数据源是开发中常用到的组件之一，在该模块中，Mybatis自身提供了相应的数据源实现，也提供了与第三方数据源集成的接口。

2、事务管理模块（对应 transaction 包。）

       在很多实际开发场景中，Mybatis是与Spring框架集成，并由Spring框架管理事务。但是呢Mybatis自身对数据库事务进行了抽象，提供了相应的事务接口和简单实现。

3、缓存模块（对应 cache 包。）

       在优化系统的过程中，缓存是我们常用的手段之一，数据库缓存也不例外。但是做到正确且合理的对数据库添加缓存，将一部分数据库请求拦截在缓存这一层至关重要。作为一个大家常用的框架，Mybatis中有一级缓存和二级缓存，这两级缓存都依赖于缓存模块中的实现。但是在这里我们需要注意，这两级缓存与Mybatis以及整个应用是运行在同一个JVM中的，共享同一块内存，如果这两级缓存中的数据量较大，则可能影响系统中其它功能，所以需要缓存大量数据时，优先考虑使用Redis、Memcache等缓存产品。

4、解析器模块（对应 parsing 包）

该模块有两个主要功能：

       1）封装了XPath，为Mybatis初始化时解析mybatis-config.xml配置文件以及映射配置文件提供支持；

       2）为处理动态SQL语句中的占位符提供支持。

5、资源加载模块（对应 io 包）

       也可以叫做IO模块，该模块主要封装了类加载器，确定了类加载器的使用顺序，并提供了加载类文件和其它资源文件的功能。

6、反射模块（对应 reflection 包）

       该模块对Java原生的反射进行了很好的封装，提供了简易的API，方便上层调用，并且对反射操作进行了一系列的优化，如，缓存了类的元数据（MetaClass）和对象的元数据（MetaObject），提高了反射操作的性能。

7、类型转换模块（对应 type 包）

      为简化配置文件，Mybatis框架特别提供了别名机制，这种机制是类型转换模块的主要功能之一。

      类型转换模块的另一个功能是实现JDBC类型与Java类型间的转换。该功能在SQL语句绑定实参和映射查询结果集时都会涉及：

• 在映射结果集时，会将数据有JDBC类型转换成Java类型。
• 在SQL语句绑定实参时，会将数据有Java类型转换成JDBC类型。

8、日志模块（对应 logging 包）

       在我们的开发测试的过程中或者在实际生产环境下，日志的作用非常重要，给力的日志功能可以帮我们快速定位问题或者进行性能优化定位。目前已经很多的日志框架，例如Log4j、Log4j2、slf4j、Lombok等。MyBatis 作为一个设计优良的框架，除了提供详细的日志输出信息，还要能够集成多种日志框架，其日志模块的一个主要功能就是集成第三方日志框架。

9、注解模块（对应 annotations 包）

       虽然在实际的场景下，我们开发喜欢在XML格式的Mapper文件中进行便携SQL操作，其实MyBatis 提供了注解的方式，可以很方便的在 Mapper 接口上编写简单的数据库 SQL 操作代码，而无需编写 SQL 在 XML 格式的 Mapper 文件中的。

10、异常模块（对应 exceptions 包）

       在该模块中定义了 MyBatis 专有的 PersistenceException 和 TooManyResultsException 异常。

11、Binding 模块（对应 binding 包）

      在调用SqlSession相应方法执行数据库操作时，需要制定映射文件中定义的SQL节点，若sql中出现了拼写错误，只能在运行时才能发现。为了能尽早发现这种错误，Mybatis通过Binding模块将用户自定义的Mapper接口与映射文件关联起来，系统可以通过调用自定义Mapper接口中的方法执行相应的SQL语句完成数据库操作，从而避免上述问题。

       其实在实际的开发中，我们开发人员只是创建了Mapper接口，而并没有编写实现类，这是因为Mybatis自动为Mapper接口创建了动态代理对象。有时，自定义的Mapper接口可以完全代替映射配置文件，但有的映射规则和 SQL 语句的定义还是写在映射配置文件中比较方便，例如动态 SQL 语句的定义。

---

二、核心处理层

      该层实现了 MyBatis 的核心处理流程，包括 MyBatis 的初始化以及完成一次数据库操作的涉及的全部流程 。

1、配置解析

       对应 builder 和 mapping 包。前者为配置解析过程，后者主要为 SQL 操作解析后的映射。

       在 MyBatis 初始化过程中，会加载 mybatis-config.xml 配置文件、映射配置文件以及 Mapper 接口中的注解信息，解析后的配置信息会形成相应的对象并保存到 Configuration 对象中。例如：

   I：<resultMap>节点(即 ResultSet 的映射规则) 会被解析成 ResultMap 对象。

   II：<result> 节点(即属性映射)会被解析成 ResultMapping 对象。

      之后，利用该 Configuration 对象创建 SqlSessionFactory对象。待 MyBatis 初始化之后，开发人员可以通过初始化得到 SqlSessionFactory 创建 SqlSession 对象并完成数据库操作。

2、SQL 解析（对应 scripting 包）

Mybatis实现的动态SQL语句，几乎可以编写出所有满足需要的SQL。

scripting模块会根据用户传入的参数，解析映射文件中定义的动态SQL节点，形成数据库能执行的sql语句。

3、SQL 执行

 对应 executor 和 cursor 包。前者对应执行器，后者对应执行结果的游标。

SQL语句的执行涉及多个组件，其中比较重要的是Executor、StatementHandler、ParameterHandler和ResultSetHandler。

• Executor主要维护一级缓存和二级缓存，并提供事务管理的相关操作，它会将数据库相关操作委托给StatementHandler完成。
• StatementHandler首先通过ParameterHandler完成SQL语句的实参绑定，然后通过java.sql.Statement对象执行SQL语句并得到结果集。
• 最后通过ResultSetHandler完成结果集映射，得到结果对象并返回。

4、插件层（对应 plugin 模块）

Mybatis提供了插件接口，用户可以通过自定义插件的方式对Mybatis进行扩展。

---

三、接口层（对应 session 包）

       接口层很简单，其核心就是SqlSession接口，该接口定义了Mybatis暴露给应用程序调用的API，即与上层应用交互的通道。接口层在接收到调用请求时，会调用核心处理层的相应模块来完成具体的数据库操作。

---

最后，我们在通过下图可以比较直观的了解整体的过程：