《深刻理解mybatis原理》 Mybatis初始化机制详解

时间  2019-11-08
标签 深刻理解mybatis原理 mybatis 初始化 机制 详解 栏目 MyBatis 繁體版
原文   原文链接

对于任何框架而言，在使用前都要进行一系列的初始化，MyBatis也不例外。本章将经过如下几点详细介绍MyBatis的初始化过程。java

    1.MyBatis的初始化作了什么mysql

    2. MyBatis基于XML配置文件建立Configuration对象的过程sql

    3. 手动加载XML配置文件建立Configuration对象完成初始化，建立并使用SqlSessionFactory对象数据库

    4. 涉及到的设计模式apache

1、 MyBatis的初始化作了什么

    任何框架的初始化，无非是加载本身运行时所须要的配置信息。MyBatis的配置信息，大概包含如下信息，其高层级结构以下：设计模式

    × configuration 配置数组

        × properties 属性
        × settings 设置
        × typeAliases 类型命名
        × typeHandlers 类型处理器
        × objectFactory 对象工厂
        × plugins 插件
        × environments 环境
        ×environment 环境变量
        × transactionManager 事务管理器
        ×dataSource 数据源
    ×映射器session

    MyBatis的上述配置信息会配置在XML配置文件中，那么，这些信息被加载进入MyBatis内部，MyBatis是怎样维护的呢？mybatis

    MyBatis采用了一个很是直白和简单的方式---使用 org.apache.ibatis.session.Configuration 对象做为一个全部配置信息的容器，Configuration对象的组织结构和XML配置文件的组织结构几乎彻底同样（固然，Configuration对象的功能并不限于此，它还负责建立一些MyBatis内部使用的对象，如Executor等，这将在后续的文章中讨论）。以下图所示：app

    MyBatis根据初始化好Configuration信息，这时候用户就可使用MyBatis进行数据库操做了。

    能够这么说，MyBatis初始化的过程，就是建立 Configuration对象的过程。

    MyBatis的初始化能够有两种方式：

  • 基于XML配置文件：基于XML配置文件的方式是将MyBatis的全部配置信息放在XML文件中，MyBatis经过加载并XML配置文件，将配置文信息组装成内部的Configuration对象
  • 基于Java API：这种方式不使用XML配置文件，须要MyBatis使用者在Java代码中，手动建立Configuration对象，而后将配置参数set 进入Configuration对象中

    （PS:  MyBatis具体配置信息有哪些，又分别表示什么意思，不在本文的叙述范围，读者能够参考个人《Java Persistence withMyBatis 3 (中文版)》 的第二章 引导MyBatis中有详细的描述）

    接下来咱们将经过 基于XML配置文件方式的MyBatis初始化，深刻探讨MyBatis是如何经过配置文件构建Configuration对象，并使用它的。

    

2、MyBatis基于XML配置文件建立Configuration对象的过程

    如今就从使用MyBatis的简单例子入手，深刻分析一下MyBatis是怎样完成初始化的，都初始化了什么。看如下代码：   

String resource = "mybatis-config.xml";  
InputStream inputStream = Resources.getResourceAsStream(resource);  
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);  
SqlSession sqlSession = sqlSessionFactory.openSession();  
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);  如今就让咱们看看第三句到底发生了什么。

MyBatis初始化基本过程：

    SqlSessionFactoryBuilder根据传入的数据流生成Configuration对象，而后根据Configuration对象建立默认的SqlSessionFactory实例。

    初始化的基本过程以下序列图所示：

由上图所示，mybatis初始化要通过简单的如下几步：

    1. 调用SqlSessionFactoryBuilder对象的build(inputStream)方法；

    2. SqlSessionFactoryBuilder会根据输入流inputStream等信息建立XMLConfigBuilder对象;

    3. SqlSessionFactoryBuilder调用XMLConfigBuilder对象的parse()方法；

    4. XMLConfigBuilder对象返回Configuration对象；

    5. SqlSessionFactoryBuilder根据Configuration对象建立一个DefaultSessionFactory对象；

    6. SqlSessionFactoryBuilder返回 DefaultSessionFactory对象给Client，供Client使用。

SqlSessionFactoryBuilder相关的代码以下所示：

public SqlSessionFactory build(InputStream 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);  
}

上述的初始化过程当中，涉及到了如下几个对象：

  • SqlSessionFactoryBuilder ： SqlSessionFactory的构造器，用于建立SqlSessionFactory，采用了Builder设计模式
  • Configuration ：该对象是mybatis-config.xml文件中全部mybatis配置信息
  • SqlSessionFactory：SqlSession工厂类，以工厂形式建立SqlSession对象，采用了Factory工厂设计模式
  • XmlConfigParser ：负责将mybatis-config.xml配置文件解析成Configuration对象，共SqlSessonFactoryBuilder使用，建立SqlSessionFactory

 建立Configuration对象的过程

    接着上述的 MyBatis初始化基本过程讨论，当SqlSessionFactoryBuilder执行build()方法，调用了XMLConfigBuilder的parse()方法，而后返回了Configuration对象。那么parse()方法是如何处理XML文件，生成Configuration对象的呢？

    1. XMLConfigBuilder会将XML配置文件的信息转换为Document对象，而XML配置定义文件DTD转换成XMLMapperEntityResolver对象，而后将两者封装到XpathParser对象中，XpathParser的做用是提供根据Xpath表达式获取基本的DOM节点Node信息的操做。以下图所示：

    2.  以后XMLConfigBuilder调用parse()方法：会从XPathParser中取出 <configuration>节点对应的Node对象，而后解析此Node节点的子Node：properties, settings, typeAliases,typeHandlers, objectFactory, objectWrapperFactory, plugins, environments,databaseIdProvider, mappers

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.  而后将这些值解析出来设置到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;

  4.  返回Configuration对象 

    咱们将上述的MyBatis初始化基本过程的序列图细化，

 

3、手动加载XML配置文件建立Configuration对象完成初始化，建立并使用SqlSessionFactory对象

            咱们可使用XMLConfigBuilder手动解析XML配置文件来建立Configuration对象，代码以下：

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);  

 

4、涉及到的设计模式

    初始化的过程涉及到建立各类对象，因此会使用一些建立型的设计模式。在初始化的过程当中，Builder模式运用的比较多。

    Builder模式应用1： SqlSessionFactory的建立

     对于建立SqlSessionFactory时，会根据状况提供不一样的参数，其参数组合能够有如下几种：

因为构造时参数不定，能够为其建立一个构造器Builder，将SqlSessionFactory的构建过程和表示分开：

    MyBatis将SqlSessionFactoryBuilder和SqlSessionFactory相互独立。

    Builder模式应用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原理》 Mybatis初始化机制详解 的所有内容，但愿对你们有所帮助！上述内容若有不妥之处，还请读者指出，共同探讨，共同进步！

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程