Mybatis 工作原理详解

Posted 九块六

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Mybatis 工作原理详解相关的知识,希望对你有一定的参考价值。

目录

Mybatis持久层框架

结果集进行ORM映射

步骤解析

1、获取结果集及结果映射入口 

2、开始ORM映射接口

3、数据库结果集解析,完成ORM映射

4、保存并获取ORM映射后的结果集

参数传递方式

顺序传参法

@Param注解传参法

Map传参法

Java Bean传参法

mybatis # 和 $ 防止SQL注入(# 占位符,$ 拼接符)

$可以使用的情况

#推荐使用情况

mybatis缓存 


Mybatis持久层框架

mybatis是一个用Java编写的持久层框架,它使用ORM实现了结果集的封装。

跟hibernate一样,也是需要拥有两个配置文件,全局配置文件 和 映射文件,在编写这两个映射文件之前,必须创建mybatis环境(引入jar包或者maven工程导入坐标)

        ORM是Object Relational Mapping 对象关系映射。简单来说,就是把数据库表和实体类及实体类的属性对应起来,让开发者操作实体类就实现操作数据库表。
它封装了jdbc操作的很多细节,使开发者只需要关注sql语句本身,而无需关注注册驱动,创建连接等烦杂过程

结果集进行ORM映射

通过 Mapper 执行 Statement 已经从数据库中获取到数据的基本值,但是并没有和 Java pojo 进行映射,本篇讲继续解析 MyBatis 中的属性映射

步骤解析

1、获取结果集及结果映射入口 

* PreparedStatementHandler

public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException 
    // 转换Statement为JDBC原生的PreparedStatement
    PreparedStatement ps = (PreparedStatement) statement;
    // 通过JDBC底层执行, 并将执行结果封装到PreparedStatement中
    ps.execute();
    // resultSetHandler:结果集处理器, 对查询结果进行ORM映射
    return resultSetHandler.<E> handleResultSets(ps);

2、开始ORM映射接口

* DefaultResultSetHandler:通过 handleResultSets() 方法开始映射

public List<Object> handleResultSets(Statement stmt) throws SQLException 
    ErrorContext.instance().activity("handling results").object(mappedStatement.getId());
 
    final List<Object> multipleResults = new ArrayList<Object>();
 
    int resultSetCount = 0;
    // 获取执行结果集, 并封装为ResultSetWrapper
    ResultSetWrapper rsw = getFirstResultSet(stmt);
    // 获取Statement的结果映射, 后台会自动将resultType解析为一个ResultMap
    List<ResultMap> resultMaps = mappedStatement.getResultMaps();
    int resultMapCount = resultMaps.size();
    validateResultMapsCount(rsw, resultMapCount);
    while (rsw != null && resultMapCount > resultSetCount) 
      // 逐个resultMap, 进行结果集解析
      ResultMap resultMap = resultMaps.get(resultSetCount);
      // 处理结果集, 映射数据库查询数据到reslutMap指定VO中
      handleResultSet(rsw, resultMap, multipleResults, null);
      rsw = getNextResultSet(stmt);
      cleanUpAfterHandlingResultSet();
      resultSetCount++;
    
 
    String[] resultSets = mappedStatement.getResultSets();
    if (resultSets != null) 
      while (rsw != null && resultSetCount < resultSets.length) 
        ResultMapping parentMapping = nextResultMaps.get(resultSets[resultSetCount]);
        if (parentMapping != null) 
          String nestedResultMapId = parentMapping.getNestedResultMapId();
          ResultMap resultMap = configuration.getResultMap(nestedResultMapId);
          handleResultSet(rsw, resultMap, null, parentMapping);
        
        rsw = getNextResultSet(stmt);
        cleanUpAfterHandlingResultSet();
        resultSetCount++;
      
    
    // 返回处理结果集
    return collapseSingleResultList(multipleResults);

 * DefaultResultSetHandler:通过 getFirstResultSet(),获取数据库返回的结果集,并封装为 ResultSetWrapper

private ResultSetWrapper getFirstResultSet(Statement stmt) throws SQLException 
    ResultSet rs = stmt.getResultSet();
    while (rs == null) 
      // move forward to get the first resultset in case the driver
      // doesn't return the resultset as the first result (HSQLDB 2.1)
      if (stmt.getMoreResults()) 
        rs = stmt.getResultSet();
       else 
        if (stmt.getUpdateCount() == -1) 
          // no more results. Must be no resultset
          break;
        
      
    

    return rs != null ? new ResultSetWrapper(rs, configuration) : null;
public ResultSetWrapper(ResultSet rs, Configuration configuration) throws SQLException 
    super();
    // 获取类型映射注册信息
    this.typeHandlerRegistry = configuration.getTypeHandlerRegistry();
    // 获取结果集
    this.resultSet = rs;
    // 获取数据库元数据列
    final ResultSetMetaData metaData = rs.getMetaData();
    final int columnCount = metaData.getColumnCount();
    // 逐行解析元数据列, 获取元数据列基本信息
    for (int i = 1; i <= columnCount; i++) 
      // 数据库列名, 支持别名
      columnNames.add(configuration.isUseColumnLabel() ? metaData.getColumnLabel(i) : metaData.getColumnName(i));
      // 数据库列字段类型
      jdbcTypes.add(JdbcType.forCode(metaData.getColumnType(i)));
      // 数据库列字段类型映射的Java数据类型
      classNames.add(metaData.getColumnClassName(i));
    

3、数据库结果集解析,完成ORM映射

* DefaultResultSetHandler:调用 handleResultSet() 处理结果集

private void handleResultSet(ResultSetWrapper rsw, ResultMap resultMap, List<Object> multipleResults, ResultMapping parentMapping) throws SQLException 
    try 
      // parentMapping 方法传参为null
      if (parentMapping != null) 
        handleRowValues(rsw, resultMap, null, RowBounds.DEFAULT, parentMapping);
       else 
        // DefaultSqlSession.selectList方法中, 初始化resultHandler时为null
        if (resultHandler == null) 
          DefaultResultHandler defaultResultHandler = new DefaultResultHandler(objectFactory);
          // 映射查询数据到VO中, 并添加最终VO到结果集中
          handleRowValues(rsw, resultMap, defaultResultHandler, rowBounds, null);
          // multipleResults结果集添加ORM映射后的数据
          multipleResults.add(defaultResultHandler.getResultList());
         else 
          handleRowValues(rsw, resultMap, resultHandler, rowBounds, null);
        
      
     finally 
      // issue #228 (close resultsets)
      closeResultSet(rsw.getResultSet());
    

* DefaultResultSetHandler:handleRowValues() 处理所有数据行

public void handleRowValues(ResultSetWrapper rsw, ResultMap resultMap, ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping) throws SQLException 
    if (resultMap.hasNestedResultMaps()) 
      ensureNoRowBounds();
      checkResultHandler();
      handleRowValuesForNestedResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
     else 
      // 不存在嵌套的单条数据查询, 走此方法
      handleRowValuesForSimpleResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
    
private void handleRowValuesForSimpleResultMap(ResultSetWrapper rsw, ResultMap resultMap, ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping)
      throws SQLException 
    DefaultResultContext<Object> resultContext = new DefaultResultContext<Object>();
    // 此处基于分页处理, 当前不涉及
    skipRows(rsw.getResultSet(), rowBounds);
    // 遍历每一个数据库查询对象, 进行数据ORM映射
    while (shouldProcessMoreRows(resultContext, rowBounds) && rsw.getResultSet().next()) 
      // 此处应该意为区分不同的resultMap, 当前只存在一个resultMap, 暂时忽略
      // 此时resultMap只存在一个有效属性, 即type为resultType对应的VO
      ResultMap discriminatedResultMap = resolveDiscriminatedResultMap(rsw.getResultSet(), resultMap, null);
      // 映射当前数据库数据到JavaBean, 此行结束后, 返回结果即为JavaBean对象
      Object rowValue = getRowValue(rsw, discriminatedResultMap);
      // 保存结果集到DefaultResultHandler中, 外部通过该对象获取结果集
      storeObject(resultHandler, resultContext, rowValue, parentMapping, rsw.getResultSet());
    

* DefaultResultSetHandler:处理每一行数据映射 getRowValue()

private Object getRowValue(ResultSetWrapper rsw, ResultMap resultMap) throws SQLException 
    final ResultLoaderMap lazyLoader = new ResultLoaderMap();
    // 初始化JavaBean对象, 初始化为零值, 此时未进行数据赋值
    Object rowValue = createResultObject(rsw, resultMap, lazyLoader, null);
    // hasTypeHandlerForResultObject : 判断当前结果集在JDBC->java的默认集合中是否存在
    if (rowValue != null && !hasTypeHandlerForResultObject(rsw, resultMap.getType())) 
      final MetaObject metaObject = configuration.newMetaObject(rowValue);
      boolean foundValues = this.useConstructorMappings;
      // 判断是否需要自动映射
      if (shouldApplyAutomaticMappings(resultMap, false)) 
        // 进行自动映射
        foundValues = applyAutomaticMappings(rsw, resultMap, metaObject, null) || foundValues;
      
      // 涉及ResultMap映射处理
      foundValues = applyPropertyMappings(rsw, resultMap, metaObject, lazyLoader, null) || foundValues;
      foundValues = lazyLoader.size() > 0 || foundValues;
      // 返回结果集
      rowValue = foundValues || configuration.isReturnInstanceForEmptyRow() ? rowValue : null;
    
    return rowValue;
private boolean applyAutomaticMappings(ResultSetWrapper rsw, ResultMap resultMap, MetaObject metaObject, String columnPrefix) throws SQLException 
    // 获取还没有建立属性映射的数据库字段
    List<UnMappedColumnAutoMapping> autoMapping = createAutomaticMappings(rsw, resultMap, metaObject, columnPrefix);
    boolean foundValues = false;
    if (!autoMapping.isEmpty()) 
      // 未建立映射字段不为空, 为当前属性分别set值
      for (UnMappedColumnAutoMapping mapping : autoMapping) 
        final Object value = mapping.typeHandler.getResult(rsw.getResultSet(), mapping.column);
        if (value != null) 
          foundValues = true;
        
        if (value != null || (configuration.isCallSettersOnNulls() && !mapping.primitive)) 
          // gcode issue #377, call setter on nulls (value is not 'found')
          metaObject.setValue(mapping.property, value);
        
      
    
    return foundValues;

* 如果存在自定义 Property 映射,会执行下面方法

private boolean applyPropertyMappings(ResultSetWrapper rsw, ResultMap resultMap, MetaObject metaObject, ResultLoaderMap lazyLoader, String columnPrefix)
      throws SQLException 
    final List<String> mappedColumnNames = rsw.getMappedColumnNames(resultMap, columnPrefix);
    boolean foundValues = false;
    final List<ResultMapping> propertyMappings = resultMap.getPropertyResultMappings();
    for (ResultMapping propertyMapping : propertyMappings) 
      String column = prependPrefix(propertyMapping.getColumn(), columnPrefix);
      if (propertyMapping.getNestedResultMapId() != null) 
        // the user added a column attribute to a nested result map, ignore it
        column = null;
      
      if (propertyMapping.isCompositeResult()
          || (column != null && mappedColumnNames.contains(column.toUpperCase(Locale.ENGLISH)))
          || propertyMapping.getResultSet() != null) 
        Object value = getPropertyMappingValue(rsw.getResultSet(), metaObject, propertyMapping, lazyLoader, columnPrefix);
        // issue #541 make property optional
        final String property = propertyMapping.getProperty();
        if (property == null) 
          continue;
         else if (value == DEFERED) 
          foundValues = true;
          continue;
        
        if (value != null) 
          foundValues = true;
        
        if (value != null || (configuration.isCallSettersOnNulls() && !metaObject.getSetterType(property).isPrimitive())) 
          // gcode issue #377, call setter on nulls (value is not 'found')
          metaObject.setValue(property, value);
        
      
    
    return foundValues;

最终返回ORM映射后的 Java POJO

4、保存并获取ORM映射后的结果集

 * 保存结果集:映射完成后,会调用 DefaultResultSetHandler.storeObject() 方法,保存结果到 DefaultResultHandler.list属性中

// 保存结果集到DefaultResultHandler中, 外部通过该对象获取结果集
// org.apache.ibatis.executor.resultset.DefaultResultSetHandler#handleRowValuesForSimpleResultMap
      storeObject(resultHandler, resultContext, rowValue, parentMapping, rsw.getResultSet());
private void storeObject(ResultHandler<?> resultHandler, DefaultResultContext<Object> resultContext, Object rowValue, ResultMapping parentMapping, ResultSet rs) throws SQLException 
    // parentMapping传递为空
    if (parentMapping != null) 
      linkToParents(rs, parentMapping, rowValue);
     else 
      callResultHandler(resultHandler, resultContext, rowValue);
    
private void callResultHandler(ResultHandler<?> resultHandler, DefaultResultContext<Object> resultContext, Object rowValue) 
    resultContext.nextResultObject(rowValue);
    ((ResultHandler<Object>) resultHandler).handleResult(resultContext);
  public void handleResult(ResultContext<? extends Object> context) 
    list.add(context.getResultObject());
  

* 获取结果集:映射完成后,会从 DefaultResultHandler.list中获取有效结果集

// org.apache.ibatis.executor.resultset.DefaultResultSetHandler#handleResultSet
multipleResults.add(defaultResultHandler.getResultList());
    // org.apache.ibatis.executor.result.DefaultResultHandler#getResultList
  public List<Object> getResultList() 
    return list;
  

参数传递方式

在mapper中传递多个参数的方式有四种:
顺序传递法
@Param注解传参法
Map传参法
Java Bean传参法;

顺序传参法

xxMapper.java
public User selectUser(String name, int deptId);

xxMapper.xml
<select id="selectUser" resultMap="UserResultMap">
    select * from user
    where user_name = #0 and dept_id = #1
</select>

#里面的数字代表传入参数的顺序。这种方法不建议使用,sql层表达不直观,且一旦顺序调整容易出错。

@Param注解传参法

public User selectUser(@Param("userName") String name, int @Param("deptId") deptId);

<select id="selectUser" resultMap="UserResultMap">
    select * from user
    where user_name = #userName and dept_id = #deptId
</select>

#里面的名称对应的是注解@Param括号里面修饰的名称。这种方法在参数不多的情况还是比较直观的,(推荐使用)。

Map传参法

public User selectUser(Map<String, Object> params);

<select id="selectUser" parameterType="java.util.Map" resultMap="UserResultMap">
    select * from user
    where user_name = #userName and dept_id = #deptId
</select>

 #里面的名称对应的是Map里面的key名称。这种方法适合传递多个参数,且参数易变能灵活传递的情况。

Java Bean传参法

public User selectUser(User user);

<select id="selectUser" parameterType="com.jourwon.pojo.User" resultMap="UserResultMap">
    select * from user
    where user_name = #userName and dept_id = #deptId
</select>

 #里面的名称对应的是User类里面的成员属性。这种方法直观,需要建一个实体类,扩展不容易,需要加属性,但代码可读性强,业务逻辑处理方便,推荐使用。(推荐使用)。

 parameterType(输入类型)

简单类型

pojo对象类型

pojo包装对象

resultType(输出类型) 

一般数据类型(单条)

JavaBean 类型(单条)

List类型(多条)

Map类型

mybatis # 和 $ 防止SQL注入(# 占位符,$ 拼接符)

#占位符对应的SQL是占位作用的,也就是形成的SQL对应的位置会用引号括起来,对于SQL来说就是一个参数而已。

$它是拼接符号,不是引号括起来的,它对应一串字符是可以与SQL拼在一起的,相当于成为SQL的一部分,这就很危险了,你拼接的东西可以破坏原有的SQL执行逻辑。

比如说你有一个根据id查询信息的SQL,这时候有个坏人想查看你全部的信息,他会怎么做?

他肯定不会去找id一个去一个的试,最简单的方式是SQL注入写一串有问题的参数传过去。

例如:

dao 接口

public String findById(@param("userId")String userId);

1、假设mapper.xml文件中sql查询语句为: 

<select id="findById" resultType="String">
    select name from user where id = #userid;
</select>

 当传入的参数为 3;drop table user; 当我们执行时可以看见打印的sql语句为:sql编译结果如下

select name from usre where id = "3;drop table user;";

不管输入何种参数时,都可以防止sql注入,因为mybatis底层实现了预编译,底层通过prepareStatement预编译实现类对当前传入的sql进行了预编译,预先编译好SQL,然后把#userId 站位替换引号引起了"3;drop table user;" 作为一个整体条件,这样就可以防止sql注入了。 

 2、假设mapper.xml文件中sql查询语句为: 

<select id="findById" resultType="String">
    select name from user where id = $userid;
</select>

 当传入的参数为 3;drop table user; 当我们执行时可以看见打印的sql语句为:

select name from user where id = 3;drop table user ;

没有进行预编译语句,它先进行了字符串拼接,然后进行了预编译。这个过程就是sql注入生效的过程。 

$可以使用的情况

Order by 传递参数可能要用$算是一种特殊情况外

一般来说$通常我们写linux脚本传递参数的时候会用到,这个一定不能是用户来接触使用的

内部写定好的参数,比如说数据库,表名什么的可以使用$,

#推荐使用情况

外界客户端传递参数查询的推荐使用#

        1、预编译语句在执行时会把"select name from user where id= ?"语句事先编译好,这样当执行时仅仅需要用传入的参数替换掉?占位符即可。而对于第一种不符合规范的情况,程序会先生成sql语句,然后带着用户传入的内容去编译,这恰恰是问题所在。

        2、第二种避免SQL注入攻击的方式:存储过程。存储过程(Stored Procedure)是一组完成特定功能的SQL语句集,经编译后存储在数据库中,用户通过调用存储过程并给定参数(如果该存储过程带有参数)就可以执行它,也可以避免SQL注入攻击

mybatis缓存 

须知
	缓存
		1.存在内存中的临时数据
		2.将用户经常查询的数据放在缓存(内存)中,用户去查询数据就不用从磁盘上(关系型数据库数据文件)
		  查询,从缓存中查询,从而提高查询效率,解决了高并发系统的性能问题
	优点
		减少和数据库的交互次数,减少系统开销,提高系统效率
	使用前提
		经常查询并且不经常改变的数据
	mybatis缓存
		mybatis包含一个非常强大的查询缓存特性,它可以非常方便地定制和配置缓存。缓存可以极大的提升
		查询效率。
		mybatis系统中默认定义了两级缓存:一级缓存和二级缓存。
		-默认情况下,只有一级缓存开启(sqlSession级别的缓存,也称为本地缓存)
		-二级缓存需要手动开启和配置,它是基于namespace级别的缓存。
		-为了提高扩展性,Mybatis定义了缓存接口Cache。操作者可以通过实现Cache接口来自定义二级缓存
	
一级缓存
		含义
			一级缓存也叫本地缓存:
		内容
			与数据库同一次会话期间查询到的数据会放在本地缓存中
			以后如果需要获取相同的数据,直接从换缓存中拿,没必须再去查询数据库		

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

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

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

1.MyBatis的初始化做了什么
?
2. MyBatis基于XML配置文件创建Configuration对象的过程
?
3. 手动加载XML配置文件创建Configuration对象完成初始化,创建并使用SqlSessionFactory对象
?
4. 涉及到的设计模式

一、 MyBatis的初始化做了什么

任何框架的初始化,无非是加载自己运行时所需要的配置信息。MyBatis的配置信息,大概包含以下信息,其高层级结构如下:

 

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

 

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

MyBatis采用了一个非常直白和简单的方式---使用 org.apache.ibatis.session.Configuration 对象作为一个所有配置信息的容器,Configuration对象的组织结构和XML配置文件的组织结构几乎完全一样(当然,Configuration对象的功能并不限于此,它还负责创建一些MyBatis内部使用的对象,如Executor等,这将在后续的文章中讨论)。如下图所示:

 

技术图片

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

可以这么说,MyBatis初始化的过程,就是创建 Configuration对象的过程。

MyBatis的初始化可以有两种方式:

(1 基于XML配置文件:基于XML配置文件的方式是将MyBatis的所有配置信息放在XML文件中,MyBatis通过加载XML配置文件,将配置文信息组装成内部的Configuration对象
?
(2基于Java API:这种方式不使用XML配置文件,需要MyBatis使用者在Java代码中,手动创建Configuration对象,然后将配置参数set 进入Configuration对象中
?

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

 

二、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信息的操作。如下图所示:

技术图片

技术图片

  1. 之后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的配置和设计上,我们将在后续的文章中讨论它,敬请期待~

  1. 然后将这些值解析出来设置到Configuration对象中。

解析子节点的过程这里就不一一介绍了,用户可以参照MyBatis源码仔细揣摩,我们就看上述的environmentsElement(root.evalNode("environments")); 方法是如何将environments的信息解析出来,设置到Configuration对象中的:

/*
   解析environments节点,并将结果设置到Configuration对象中
   注意:创建environment时,如果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;
}

  1. 返回Configuration对象 我们将上述的MyBatis初始化基本过程的序列图细化,

技术图片

三、手动加载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);
//使用MyBatis
SqlSession sqlSession = sqlSessionFactory.openSession();
List list = sqlSession.selectList("com.foo.bean.BlogMapper.queryAllBlogInfo");

四、涉及到的设计模式

初始化的过程涉及到创建各种对象,所以会使用一些创建型的设计模式。在初始化的过程中,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原理6》 MyBatis的一级缓存实现详解 及使用注意事项

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

深入详解Mybatis的架构原理与6大核心流程

Mybatis学习之核心原理代码详解

mybatis拦截处理

02-Mybatis工作原理