Mybatis初始化知识小结
作者：毛奇志 发布时间：2023-11-01 13:59:27
一、前言
对于任何框架而言，在使用前都要进行一系列的初始化，MyBatis也不例外。
二、MyBatis的初始化做了什么
2.1 Mybatis的初始化过程就是加载自己运行时所需要的配置信息的过程
任何框架的初始化，无非是加载自己运行时所需要的配置信息，Mybatis也是如此，Mybatis的初始化过程就是加载自己运行时所需要的配置信息的过程。
Spring的初始化过程就是加载自己运行时所需要的配置信息的过程，Mybatis的初始化过程就是加载自己运行时所需要的配置信息的过程。
2.2 Mybatis的配置信息有哪些
MyBatis的配置信息，大概包含以下信息，其层级结构如下：
× configuration 配置
× properties 属性
× settings 设置
× typeAliases 类型命名
× typeHandlers 类型处理器
× objectFactory 对象工厂
× plugins 插件
× environments 环境
× environment 环境变量
× transactionManager 事务管理器
× dataSource 数据源
× 映射器
MyBatis的上述配置信息会配置在XML配置文件中，那么，这些信息被加载进入MyBatis内部，MyBatis是怎样维护的呢？
2.3 mybatis-config.xml与Configuration类
MyBatis采用了一个非常直白和简单的方式：使用 org.apache.ibatis.session.Configuration 对象作为一个所有配置信息的容器，Configuration对象的组织结构和XML配置文件的组织结构几乎完全一样（当然，Configuration对象的功能并不限于此，它还负责创建一些MyBatis内部使用的对象，如Executor等）。如下图所示：
MyBatis根据初始化好Configuration信息，这时候用户就可以使用MyBatis进行数据库操作了。可以这么说，MyBatis初始化的过程，就是创建 Configuration对象的过程。
2.4 MyBatis初始化的两种方式
MyBatis的初始化可以有两种方式（对应Mybatis引导层：基于XML配置文件+基于Java API）：
(1) 基于XML配置文件：基于XML配置文件的方式是将MyBatis的所有配置信息放在XML文件中，MyBatis通过加载并XML配置文件，将配置文信息组装成内部的Configuration对象。
(2) 基于Java API：这种方式不使用XML配置文件，需要MyBatis使用者在Java代码中，手动创建Configuration对象，然后手动将配置参数set 进入Configuration对象中。
接下来我们将通过 基于XML配置文件方式的MyBatis初始化，深入探讨MyBatis是如何通过配置文件构建Configuration对象，并使用它。
三、MyBatis基于XML配置文件创建Configuration对象的过程
3.1 定位到Mybatis初始化的关键一句
现在就从使用MyBatis的简单例子入手，深入分析一下MyBatis是怎样完成初始化的，都初始化了什么。看以下代码：
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
// 1、Mybatis初始化(根据InputStream得到SqlSessionFactory)
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2、创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3、执行SQL语句并返回结果
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");
有过MyBatis使用经验的读者会知道，上述语句的作用是执行com.foo.bean.BlogMapper.queryAllBlogInfo 定义的SQL语句，返回一个List结果集。总的来说，上述代码经历了 “mybatis初始化 -->创建SqlSession -->执行SQL语句并返回结果” 三个过程。
上述代码的功能是根据配置文件 mybatis-config.xml 配置文件，创建SqlSessionFactory对象，然后产生SqlSession，执行SQL语句。而mybatis的初始化就发生在第三句，就是这一句：
SqlSessionFactory sqlSessionFactory =
new SqlSessionFactoryBuilder().build(inputStream);
现在就让我们看看第三句到底发生了什么。
3.2 MyBatis初始化基本过程
SqlSessionFactoryBuilder根据传入的数据流（上面的inputStream）生成Configuration对象，然后根据Configuration对象创建默认的SqlSessionFactory实例。
3.2.1 Mybatis初始化时序图
初始化的基本过程如下序列图所示：
该时序图中涉及的类与接口：SqlSessionFactoryBuilder、XMLConfigBuilder、Configuration、XPathParser、XMLMapperEntityResolver
（1）SqlSessionFactoryBuilder ：是一个一个非抽象类， SqlSessionFactory的构造器，用于创建SqlSessionFactory，采用了Builder设计模式；
（2）XMLConfigBuilder：使用inputStream/reader得到XMLConfigBuilder类对象，引用名为parser，用来parse()得到Configuration对象。
上面时序图对应的解释是：
// mybatis初始化第一步，调用build()，上图中的1
build(inputStream) 调用 build(inputStream,null,null)
// mybatis初始化第二步，手动创建XMLConfigBuilder，上图中的2
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null);
// mybatis初始化第三步，parse()方法构建configuration对象的过程，上图中的 3 和 4
Configuration configuration=parser.parse();
// mybatis初始化第四步，使用Configuration对象创建SqlSessionFactory 上图中 5
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
3.2.2 Mybatis初始化四步骤
由上图所示，mybatis初始化要经过简单的以下几步：
最外层调用SqlSessionFactoryBuilder对象的build(inputStream)方法，此方法内部明细就是下面的2、3、4；
new XMLConfigBuilder()底层：SqlSessionFactoryBuilder会根据输入流inputStream等信息创建XMLConfigBuilder对象；
parse()底层parse()得到Configuration对象：SqlSessionFactoryBuilder调用XMLConfigBuilder对象的parse()方法，XMLConfigBuilder对象的parse()方法返回Configuration对象；
bulid()底层Configuration对象得到DefaultSessionFactory对象：SqlSessionFactoryBuilder根据Configuration对象创建一个DefaultSessionFactory对象，它是SqlSessionFactory接口的实现类，所有build()返回的返回类型为SqlSessionFactory；SqlSessionFactoryBuilder返回 DefaultSessionFactory对象给Client，供Client使用。
3.2.3 Mybatis初始化四步骤代码解析
SqlSessionFactoryBuilder相关的代码如下所示：
SqlSessionFactoryBuilder.java
public SqlSessionFactory build(InputStream inputStream)
{ //1. 调用SqlSessionFactoryBuilder对象的build(inputStream)方法
return build(inputStream, null, null);
}
public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties)
{
try
{
//2. 创建XMLConfigBuilder对象用来解析XML配置文件，生成Configuration对象
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);
//3. 将XML配置文件内的信息解析成Java对象Configuration对象
Configuration config = parser.parse();
//4. 根据Configuration对象创建出SqlSessionFactory对象
return build(config);
}
catch (Exception e)
{
throw ExceptionFactory.wrapException("Error building SqlSession.", e);
}
finally
{
ErrorContext.instance().reset();
try
{
inputStream.close();
}
catch (IOException e)
{
// Intentionally ignore. Prefer previous error.
}
}
}
//从此处可以看出，MyBatis内部通过Configuration对象来创建SqlSessionFactory,用户也可以自己通过API构造好Configuration对象，调用此方法创建SqlSessionFactory
public SqlSessionFactory build(Configuration config)
{
return new DefaultSqlSessionFactory(config);
}
3.2.4 Mybatis初始化涉及的接口与类
上述的初始化过程中，涉及到了以下几个对象：
（1）SqlSessionFactoryBuilder ：是一个一个非抽象类， SqlSessionFactory的构造器，用于创建SqlSessionFactory，采用了Builder设计模式
（2）XMLConfigBuilder：负责将mybatis-config.xml配置文件解析成Configuration对象，供SqlSessonFactoryBuilder使用，创建SqlSessionFactory
（3）Configuration ：是一个非抽象类，可以实例化对象，该对象是mybatis-config.xml文件中所有mybatis配置信息
（4）SqlSessionFactory：SqlSession工厂类，是一个接口，实现类是DefaultSqlSessionFactory，以工厂形式创建SqlSession对象，采用了Factory工厂设计模式
3.3 parse()内部创建Configuration对象的过程
问题：在MyBatis初始化基本过程中，当SqlSessionFactoryBuilder执行build()方法，调用了XMLConfigBuilder的parse()方法，然后返回了Configuration对象。那么parse()方法是如何处理XML文件，生成Configuration对象的呢？
回答：四个步骤，如下：
第一步，从XMLConfigBuilder到XPathParser
第二步，解析configuration节点
第三步，解析出来的值设置到Configuration对象中
第四步，返回Configuration对象
3.3.1 从XMLConfigBuilder到XPathParser
XMLConfigBuilder类会将XML配置文件的信息转换为Document对象，而XML配置定义文件DTD转换成XMLMapperEntityResolver对象，然后将二者(Document对象和XMLMapperEntityResolver对象)封装到XpathParser对象中，XpathParser的作用是提供根据Xpath表达式获取基本的DOM节点Node信息的操作。如下图所示：
XML配置文件（mybatis-config.xml + XxxMapper.xml）的信息转换为Document对象，而XML配置定义文件DTD（mybatis-3-config.dtd + mybatis-3-mapper.dtd 这里的3表示mybatis的版本）转换成XMLMapperEntityResolver对象，然后将二者封装到XpathParser对象中。
XpathParser的作用是提供根据Xpath表达式获取基本的DOM节点Node信息的操作，如下所示：
3.3.2 解析configuration节点
XMLConfigBuilder调用parse()方法：会从XPathParser中取出 <configuration>节点对应的Node对象，然后解析此Node节点的子Node：properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers，一个10个，代码如下：
public Configuration parse()
{
if (parsed)
{
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
parsed = true;
//源码中没有这一句，只有 parseConfiguration(parser.evalNode("/configuration"));
//为了让读者看得更明晰，源码拆分为以下两句
XNode configurationNode = parser.evalNode("/configuration");
parseConfiguration(configurationNode);
return configuration;
}
/*
解析 "/configuration"节点下的子节点信息，然后将解析的结果设置到Configuration对象中
*/
private void parseConfiguration(XNode root) {
try {
//1.首先处理properties 节点
propertiesElement(root.evalNode("properties"));
//issue #117 read properties first
//2.处理typeAliases
typeAliasesElement(root.evalNode("typeAliases"));
//3.处理插件
pluginElement(root.evalNode("plugins"));
//4.处理objectFactory
objectFactoryElement(root.evalNode("objectFactory"));
//5.objectWrapperFactory
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
//6.settings
settingsElement(root.evalNode("settings"));
//7.处理environments
environmentsElement(root.evalNode("environments"));
// read it after objectFactory and objectWrapperFactory issue #631
//8.database
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
//9. typeHandlers
typeHandlerElement(root.evalNode("typeHandlers"));
//10 mappers
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
注意：在上述代码中，还有一个非常重要的地方，就是解析XML配置文件子节点<mappers>的方法mapperElements(root.evalNode("mappers")), 它将解析我们配置的Mapper.xml配置文件，Mapper配置文件可以说是MyBatis的核心，MyBatis的特性和理念都体现在此Mapper的配置和设计上。
3.3.3 解析出来的值设置到Configuration对象中
解析子节点的过程这里就不一一介绍了，用户可以参照MyBatis源码仔细揣摩，我们就看上述的environmentsElement(root.evalNode("environments")); 方法是如何将environments的信息解析出来，设置到Configuration对象中的：
/*
解析environments节点，并将结果设置到Configuration对象中
注意：创建envronment时，如果SqlSessionFactoryBuilder指定了特定的环境（即数据源）；
则返回指定环境（数据源）的Environment对象，否则返回默认的Environment对象；
这种方式实现了MyBatis可以连接多数据源
*/
private void environmentsElement(XNode context) throws Exception
{
if (context != null)
{
if (environment == null)
{
environment = context.getStringAttribute("default");
}
for (XNode child : context.getChildren())
{
String id = child.getStringAttribute("id");
if (isSpecifiedEnvironment(id))
{
//1.创建事务工厂 TransactionFactory，继续深入子节点
TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
//2.创建数据源DataSource
DataSource dataSource = dsFactory.getDataSource();
//3. 构造Environment对象
Environment.Builder environmentBuilder = new Environment.Builder(id)
.transactionFactory(txFactory)
.dataSource(dataSource);
//4. 将创建的Envronment对象设置到configuration 对象中
configuration.setEnvironment(environmentBuilder.build());
}
}
}
}
private boolean isSpecifiedEnvironment(String id)
{
if (environment == null)
{
throw new BuilderException("No environment specified.");
}
else if (id == null)
{
throw new BuilderException("Environment requires an id attribute.");
}
else if (environment.equals(id))
{
return true;
}
return false;
}
3.3.4 返回Configuration对象
public Configuration parse()
{
if (parsed)
{
throw new BuilderException("Each XMLConfigBuilder can only be used once.");
}
parsed = true;
//源码中没有这一句，只有 parseConfiguration(parser.evalNode("/configuration"));
//为了让读者看得更明晰，源码拆分为以下两句
XNode configurationNode = parser.evalNode("/configuration");
parseConfiguration(configurationNode);
return configuration; // 完成后，返回configuration对象，返回给程序员
}
3.4 MyBatis初始化基本过程的序列图细化
3.4.1 MyBatis初始化基本过程的序列图组件
我们将上述的MyBatis初始化基本过程的序列图细化，这里包含了parse()方法将 mybatis-config.xml 解析成 Configuration对象的过程，如下图：
该时序图中涉及的类与接口：SqlSessionFactoryBuilder、XMLConfigBuilder、Configuration、XPathParser、XMLMapperEntityResolver
(1) SqlSessionFactoryBuilder ：是一个一个非抽象类， SqlSessionFactory的构造器，用于创建SqlSessionFactory，采用了Builder设计模式
(2) XMLConfigBuilder：使用inputStream/reader得到XMLConfigBuilder的类对象，引用名为parser，用来parse()得到Configuration对象，负责将mybatis-config.xml配置文件解析成Configuration对象，供SqlSessonFactoryBuilder使用，创建SqlSessionFactory
(3) Configuration ：是一个非抽象类，可以实例化对象，该对象是mybatis-config.xml文件中所有mybatis配置信息
(4) SqlSessionFactory：SqlSession工厂类，是一个接口，实现类是DefaultSqlSessionFactory，以工厂形式创建SqlSession对象，采用了Factory工厂设计模式
(5) Document：由XML配置文件的信息转换而来，最后被封装到XpathParser对象中。
(6) XMLMapperEntityResolver：由XML配置定义文件DTD转换而来，最后被封装到XpathParser对象中。
(7) XPathParser：XMLConfigBuilder会将XML配置文件的信息转换为Document对象，而XML配置定义文件DTD转换成XMLMapperEntityResolver对象，然后将二者封装到XpathParser对象。
parse()方法第一步：XMLConfigBuilder会将XML配置文件的信息转换为Document对象，而XML配置定义文件DTD转换成XMLMapperEntityResolver对象，然后将二者封装到XpathParser对象中，XpathParser的作用是提供根据Xpath表达式获取基本的DOM节点Node信息的操作
3.4.2 MyBatis初始化基本过程的序列图流程
MyBatis初始化基本过程的序列图对应的解释是：
mybatis初始化第一步，调用build()，就是第二步、第三步、第四步的总称
mybatis初始化第二步，手动创建XMLConfigBuilder
上图中的 1 XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null);
2.1 2.2 只是新建一个XMLMapperEntityResolver对象；
3.1 3.2 新建一个XPathParser对象；
4.1 4.2 新建一个Configuration对象；
mybatis初始化第三步，parse()方法构建configuration对象的过程
mybatis初始化第三步就是上图中 5 到 11 的解释，
5 是调用parse()方法
6.1、7.1、7.2、6.2 就是解析mybatis-config.xml中的configuration节点
然后子configuration节点中的子节点的循环，8.1 8.2 是解析子节点，9 是获取相应的值，10是设置值到configuration对象中
11 是返回configuration对象 Configuration configuration=parse();
parse()第一步：从XMLConfigBuilder到XPathParser
parse()第二步：解析configuration节点
parse()第三步：解析出来的值设置到Configuration对象中
parse()第四步：返回configuration对象
mybatis初始化第四步，得到了Configuration对象之后，使用Configuration对象创建SqlSessionFactory，即图中的
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
注意：上图中，4.1和4.2只是返回一个空的configuration对象，5—11才是返回一个构造好的configuration类对象，是不一样的。
3.5 手动加载XML配置文件创建Configuration对象完成初始化
我们可以使用XMLConfigBuilder手动解析XML配置文件来创建Configuration对象，创建并使用SqlSessionFactory对象，代码如下：
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
//手动创建XMLConfigBuilder，并解析创建Configuration对象
XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, null,null);
Configuration configuration=parse();
//使用Configuration对象创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
//使用MyBatis
SqlSession sqlSession = sqlSessionFactory.openSession();
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");
四、Mybatis初始化中涉及到的设计模式
初始化的过程涉及到创建各种对象，所以会使用一些创建型的设计模式。在初始化的过程中，Builder模式运用的比较多，至少涉及到两个Builder模式的使用：SqlSessionFactory的创建、数据库连接环境Environment对象的创建。
4.1 SqlSessionFactory的创建
对于创建SqlSessionFactory时，会根据情况提供不同的参数，其参数组合可以有以下几种：
由于构造时参数不定，可以为其创建一个构造器Builder，将SqlSessionFactory的构建过程和表示分开：
MyBatis将SqlSessionFactoryBuilder和SqlSessionFactory相互独立，先通过 builder() 方法得到一个SqlSessionFactoryBuilder 对象，然后再通过 SqlSessionFactoryBuilder 对象构建一个 SqlSessionFactory 对象，体现了构造器模式的应用。
4.2 数据库连接环境Environment对象的创建
在构建Configuration对象的过程中，XMLConfigParser解析 mybatis XML配置文件节点 <environment>节点时，会有以下相应的代码：
private void environmentsElement(XNode context) throws Exception {
if (context != null) {
if (environment == null) {
environment = context.getStringAttribute("default");
}
for (XNode child : context.getChildren()) {
String id = child.getStringAttribute("id");
//是和默认的环境相同时，解析之
if (isSpecifiedEnvironment(id)) {
TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
DataSource dataSource = dsFactory.getDataSource();
//使用了Environment内置的构造器Builder，传递id 事务工厂和数据源
Environment.Builder environmentBuilder = new Environment.Builder(id)
.transactionFactory(txFactory)
.dataSource(dataSource);
configuration.setEnvironment(environmentBuilder.build());
}
}
}
}
在Environment内部，定义了静态内部Builder类：
public final class Environment {
private final String id;
private final TransactionFactory transactionFactory;
private final DataSource dataSource;
public Environment(String id, TransactionFactory transactionFactory, DataSource dataSource) {
if (id == null) {
throw new IllegalArgumentException("Parameter 'id' must not be null");
}
if (transactionFactory == null) {
throw new IllegalArgumentException("Parameter 'transactionFactory' must not be null");
}
this.id = id;
if (dataSource == null) {
throw new IllegalArgumentException("Parameter 'dataSource' must not be null");
}
this.transactionFactory = transactionFactory;
this.dataSource = dataSource;
}
public static class Builder {
private String id;
private TransactionFactory transactionFactory;
private DataSource dataSource;
public Builder(String id) {
this.id = id;
}
public Builder transactionFactory(TransactionFactory transactionFactory) {
this.transactionFactory = transactionFactory;
return this;
}
public Builder dataSource(DataSource dataSource) {
this.dataSource = dataSource;
return this;
}
public String id() {
return this.id;
}
public Environment build() {
return new Environment(this.id, this.transactionFactory, this.dataSource);
}
}
public String getId() {
return this.id;
}
public TransactionFactory getTransactionFactory() {
return this.transactionFactory;
}
public DataSource getDataSource() {
return this.dataSource;
}
}
五、尾声
《利刃出鞘，Mybatis初始化》，完成了。
天天打码，天天进步！！！
来源：https://blog.csdn.net/qq_36963950/article/details/120644706
0
投稿猜你喜欢
- 1，添加依赖在project的build.gradle文件中添加dependencies { classpath 'co
- 最新开发新项目的时候，要做分享项目，要求分享有微信，微信朋友圈，QQ，QQ空间，新浪微博这五个，所分享内容包括，分享纯图片，纯文字，图文类型
本文实例为大家分享了Android自定义View之组合控件，仿电商app顶部栏的相关代码，供大家参考，具体内容如下效果图：分析:左右两边可以- 背景传说里玉皇大帝派龙王马上降雨到共光一带，龙王接到玉皇大帝命令，立马从海上调水，跑去共光施云布雨，但粗心又着急的龙王不小心把海里的鲸鱼随着
- 本文是一个 Spring 扩展支持 SPEL 的简单模式，方便第三方通过 Spring 提供额外功能。简化版方式这种方式可以在任何能获取Ap
- 在谈 Volatile 之前，我们先回顾下 Java 内存模型 的三要素：原子性、可见性、有序性，也就是大家常提到的并发编程三要素。并发编程
- Android之文件数据存储一、文件保存数据介绍Activity提供了openFileOutput()方法可以用于把数据输出到文件中，具体的
- 我object != null要避免很多NullPointerException。有什么替代方法：if (someobject != nul
- malloc的全称是memory allocation，中文叫动态内存分配，用于申请一块连续的指定大小的内存块区域以void*类型返回分配的
- 在谈 JVM 内存区域划分之前，我们先来看一下 Java 程序的具体执行过程，我画了一幅图。Java 源代码文件经过编译器编译后生成字节码文
- 参数和返回值得加密目的为了保证接口不被人拦截下来恶意请求，保证程序的稳定性，我们可以使用接口加密的方法来保证参数和返回值的保密性。具体实现方
- 1. 插入排序步骤：1.从第一个元素开始，该元素可以认为已经被排序2.取下一个元素tem，从已排序的元素序列从后往前扫描3.如果该元素大于t
- 新建一个集合List<Bill> billList = new ArrayList<>();将订单中所有物品的名称提
- 抽象方法与虚方法的区别先说两者最大的区别：抽象方法是需要子类去实现的。虚方法是已经实现了的，可以被子类覆盖，也可以不覆盖，取决于需求。因为抽
- springboot嵌套子类使用在实际项目里，我们会使用到一个User用户含有子类Address、这种嵌套子类在开发中会遇到很多问题，现在主
- SQLite是Android自带的关系型数据库，是一个基于文件的轻量级数据库。Android提供了3种操作数据的方式，SharedPrefe
- 这篇文章主要介绍了Java如何实现自定义异常类,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参
- 已经有很多关于 Flutter WebView 的文章了，为什么还要写一篇。两个原因：Flutter WebView 是 Flutter 开
- Rmb.javapublic class Rmb { /** *人民币的基本信息和操作 *@auth
- Handler是什么？Handler 是一个可以实现多线程间切换的类，通过 Handler 可以轻松地将一个任务切换到 Handler 所在
