Mybatis源码结构
简介
MyBatis 是一款优秀的持久层框架。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集
Mybatis可以将Sql语句配置在XML文件中,避免将Sql语句硬编码在Java类中。与JDBC相比:
- Mybatis通过参数映射方式,可以将参数灵活的配置在SQL语句中的配置文件中,避免在Java类中配置参数(JDBC)
- Mybatis通过输出映射机制,将结果集的检索自动映射成相应的Java对象,避免对结果集手工检索(JDBC)
- Mybatis可以通过Xml配置文件对数据库连接进行管理。
架构
我们把Mybatis的功能架构分为三层:
(1)API接口层:提供给外部使用的接口API,开发人员通过这些本地API来操纵数据库。接口层一接收到调用请求就会调用数据处理层来完成具体的数据处理。
(2)数据处理层:负责具体的SQL查找、SQL解析、SQL执行和执行结果映射处理等。它主要的目的是根据调用的请求完成一次数据库操作。
(3)基础支撑层:负责最基础的功能支撑,包括连接管理、事务管理、配置加载和缓存处理,这些都是共用的东西,将他们抽取出来作为最基础的组件。为上层的数据处理层提供最基础的支撑。
结构
MyBatis整个项目的包结构如下:
.
└── org
└── apache
└── ibatis
├── annotations (注解)
├── binding (绑定)
├── builder(构建)
├──annotation
├──xml
├── cache (缓存)
├──decorators
├──impl
├── cursor
├── datasource (数据源)
├── -- org.apache.ibatis.datasource.jndi
├── -- org.apache.ibatis.datasource.pooled
├── -- org.apache.ibatis.datasource.unpooled
├── exceptions (异常)
├── executor (执行器)
├──keygen
├──loader
├──cglib
├──javassist
├──parameter
├──result
├──resultset
├──statement
-- org.apache.ibatis.executor.Executor
├── io (通过类加载器在jar包中寻找一个package下满足条件(比如某个接口的子类)的所有类)
├── jdbc (jdbc工具)
├── logging (日志)
├── -- org.apache.ibatis.logging.commons
├── -- org.apache.ibatis.logging.jdbc
├── -- org.apache.ibatis.logging.jdk14
├── -- org.apache.ibatis.logging.log4j
├── -- org.apache.ibatis.logging.log4j2
├── -- org.apache.ibatis.logging.nologging
├── -- org.apache.ibatis.logging.slf4j
├── -- org.apache.ibatis.logging.stdout
├── mapping (映射)
├── parsing (解析,xml解析,${} 格式的字符串解析)
├── plugin (插件)
├── reflection (反射)
├── scripting (脚本)
├── session (会话)
├──defaults
├── -- org.apache.ibatis.session.SqlSession
├── transaction (事务)
├── -- org.apache.ibatis.transaction.jdbc
├── -- org.apache.ibatis.transaction.managed
└── type (类型处理器,实现java和jdbc中的类型之间转换)
- SqlSession 作为MyBatis工作的主要顶层API,表示和数据库交互的会话,完成必要数据库增删改查功能
- Executor MyBatis执行器,是MyBatis 调度的核心,负责SQL语句的生成和查询缓存的维护
- StatementHandler 封装了JDBC Statement操作,负责对JDBCstatement的操作,如设置参数、将Statement结果集转换成List集合。
- ParameterHandler 负责对用户传递的参数转换成JDBC Statement 所需要的参数
- ResultSetHandler *负责将JDBC返回的ResultSet结果集对象转换成List类型的集合;
- TypeHandler 负责java数据类型和jdbc数据类型之间的映射和转换
-
MappedStatement MappedStatement维护了一条<select update delete insert>节点的封 - SqlSource 负责根据用户传递的parameterObject,动态地生成SQL语句,将信息封装到BoundSql对象中,并返回
- BoundSql 表示动态生成的SQL语句以及相应的参数信息
- Configuration MyBatis所有的配置信息都维持在Configuration对象之中
流程
(1)加载配置并初始化
- 触发条件:加载配置文件
- 配置来源于两个地方,一处是配置文件,一处是Java代码的注解,将SQL的配置信息加载成为一个个MappedStatement对象(包括了传入参数映射配置、执行的SQL语句、结果映射配置),存储在内存中。
(2)接收调用请求
- 触发条件:调用Mybatis提供的API
- 传入参数:为SQL的ID和传入参数对象
- 处理过程:将请求传递给下层的请求处理层进行处理。
(3)处理操作请求 触发条件:API接口层传递请求过来
- 传入参数:为SQL的ID和传入参数对象
- 处理过程:
(A)根据SQL的ID查找对应的MappedStatement对象。 (B)根据传入参数对象解析MappedStatement对象,得到最终要执行的SQL和执行传入参数。 (C)获取数据库连接,根据得到的最终SQL语句和执行传入参数到数据库执行,并得到执行结果。 (D)根据MappedStatement对象中的结果映射配置对得到的执行结果进行转换处理,并得到最终的处理结果。 (E)释放连接资源。
(4)返回处理结果将最终的处理结果返回。
核心类
SqlSessionFactoryBuilder
每一个MyBatis的应用程序的入口是SqlSessionFactoryBuilder。
它的作用是通过XML配置文件创建Configuration对象(当然也可以在程序中自行创建),然后通过build方法创建SqlSessionFactory对象。没有必要每次访问Mybatis就创建一次SqlSessionFactoryBuilder,通常的做法是创建一个全局的对象就可以了
SqlSessionFactory
由SqlSessionFactoryBuilder创建
它的主要功能是创建SqlSession对象,和SqlSessionFactoryBuilder对象一样,没有必要每次访问Mybatis就创建一次SqlSessionFactory,通常的做法是创建一个全局的对象就可以了。SqlSessionFactory对象一个必要的属性是Configuration对象,它是保存Mybatis全局配置的一个配置对象,通常由SqlSessionFactoryBuilder从XML配置文件创建
SqlSession
SqlSession对象的主要功能是完成一次数据库的访问和结果的映射,它类似于数据库的session概念,由于不是线程安全的,所以SqlSession对象的作用域需限制方法内。SqlSession的默认实现类是DefaultSqlSession,它有两个必须配置的属性:Configuration和Executor。Configuration前文已经描述这里不再多说。SqlSession对数据库的操作都是通过Executor来完成的
Executor
Executor对象在创建Configuration对象的时候创建,并且缓存在Configuration对象里。Executor对象的主要功能是调用StatementHandler访问数据库,并将查询结果存入缓存中(如果配置了缓存的话)。
StatementHandler
StatementHandler是真正访问数据库的地方,并调用ResultSetHandler处理查询结果。
ResultSetHandler
处理查询结果。