Mybatis执行SQL的4大基础组件详解(图文并茂)

Stella981
• 阅读 704

>温馨提示:本篇是源码分析Mybatis ShardingJdbc SQL语句执行的前置篇。

1、Executor

sql执行器,其对应的类全路径:org.apache.ibatis.executor.Executor。

1.1 Executor类图

Mybatis执行SQL的4大基础组件详解(图文并茂)

  • Executor

    执行器根据接口,定义update(更新或插入)、query(查询)、commit(提交事务)、rollback(回滚事务)。接下来简单介绍几个重要方法:

    • int update(MappedStatement ms, Object parameter) throws SQLException 更新或插入方法,其参数含义如下:

      1)MappedStatement ms:SQL映射语句(Mapper.xml文件每一个方法对应一个MappedStatement对象)

      2)Object parameter:参数,通常是List集合。

    • < E> List< E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler)

      查询方法,其参数含义如下:

      1)RowBounds:行边界,主要值分页参数limit、offset。

      2)ResultHandler resultHandler:结果处理器。

    • CacheKey createCacheKey(MappedStatement ms, Object parameterObj, RowBounds bounds, BoundSql bSql)

      创建缓存Key,Mybatis一二级缓存的缓存Key,可以看出Key由上述4个参数来决定。

      1)BoundSql boundSql:可以通过该对象获取SQL语句。

  • CachingExecutor 支持结果缓存的SQL执行器,注意其设计模式的应用,该类中,会持有Executor的一个委托对象,CachingExecutor关注与缓存特定的逻辑,其最终的SQL执行由其委托对象来实现,即其内部的委托对象为BaseExecutor的实现类。

  • BaseExecutor Executor的基础实现类,该类为抽象类,关于查询、更新具体的实现由其子类来实现,下面4个都是其子类。

  • SimpleExecutor 简单的Executor执行器。

  • BatchExecutor 支持批量执行的Executor执行器。

  • ClosedExecutor 表示一个已关闭的Executor。

  • ReuseExecutor 支持重复使用Statement,以SQL为键,缓存Statement对象。

1.2 创建Executor

在Mybatis中,Executor的创建由Configuration对象来创建,具体的代码如下:

Configuration#newExecitor

public Executor newExecutor(Transaction transaction) {
  return newExecutor(transaction, defaultExecutorType);   // [@1](https://my.oschina.net/u/1198)
}


public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
  executorType = executorType == null ? defaultExecutorType : executorType;
  executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
  Executor executor;
  if (ExecutorType.BATCH == executorType) {   // @2
    executor = new BatchExecutor(this, transaction);
  } else if (ExecutorType.REUSE == executorType) {
    executor = new ReuseExecutor(this, transaction);
  } else {
    executor = new SimpleExecutor(this, transaction);
  }
  if (cacheEnabled) { // [@3](https://my.oschina.net/u/2648711)
    executor = new CachingExecutor(executor);
  }
  executor = (Executor) interceptorChain.pluginAll(executor);  // @4
  return executor;
}

从上面的代码可以看出,Executor的创建由如下三个关键点:

代码@1:默认的ExecutorType为ExecutorType.SIMPLE,即默认创建的Executory为SimpleExecutor。

代码@2:根据executorType的值创建对应的Executory。

代码@3:如果cacheEnabled为true,则创建CachingExecutory,然后在其内部持有上面创建的Executor,cacheEnabled默认为true,则默认创建的Executor为CachingExecutor,并且其内部包裹着SimpleExecutor。

代码@4:使用InterceptorChain.pluginAll为executor创建代理对象,即Mybatis的拆件机制,将在该系列文章中详细介绍。

2、StatementHandler

在学习StatementHandler之前,我们先来回顾一下JDBC相关的知识。JDBC与语句执行的两大主流对象:java.sql.Statement、java.sql.PrepareStatement对象大家应该不会陌生,该对象的execute方法就是执行SQL语句的入口,通过java.sql.Connection对象创建Statement对象。Mybatis的StatementHandler,是Mybatis创建Statement对象的处理器,即StatementHandler会接管Statement对象的创建。

2.1 StatementHandler类图

Mybatis执行SQL的4大基础组件详解(图文并茂)

  • StatementHandler 根接口,我们重点关注一下其定义的方法:

    • Statement prepare(Connection connection) 创建Statement对象,即该方法会通过Connection对象创建Statement对象。
    • void parameterize(Statement statement) 对Statement对象参数化,特别是PreapreStatement对象。
    • void batch(Statement statement) 批量执行SQL。
    • int update(Statement statement) 更新操作。
    • < E> List< E> query(Statement statement, ResultHandler resultHandler) 查询操作。
    • BoundSql getBoundSql() 获取SQL语句。
    • ParameterHandler getParameterHandler() 获取对应的参数处理器。
  • BaseStatementHandler StatementHandler的抽象实现类,SimpleStatementHandler、PrepareStatementHandler、CallableStatementHandler是其子类。 我们来一一看一下其示例变量:

    • Configuration configuration Mybatis全局配置对象。
    • ObjectFactory objectFactory 对象工厂。
    • TypeHandlerRegistry typeHandlerRegistry 类型注册器。
    • ResultSetHandler resultSetHandler 结果集Handler。
    • ParameterHandler parameterHandler 参数处理器Handler。
    • Executor executor SQL执行器。
    • MappedStatement mappedStatement SQL映射语句(Mapper.xml文件每一个方法对应一个MappedStatement对象)
    • RowBounds rowBounds 行边界,主要值分页参数limit、offset。
    • BoundSql boundSql 可以通过该对象获取SQL语句。
  • SimpleStatementHandler 具体的StatementHandler实现器,java.sql.Statement对象创建处理器。

  • PrepareStatementHandler java.sql.PrepareStatement对象的创建处理器。

  • CallableStatementHandler java.sql.CallableStatement对象的创建处理器,可用来执行存储过程调用的Statement。

  • RoutingStatementHandler StatementHandler路由器,我们看一下其构造方法后,就会对该类了然于胸。

    public RoutingStatementHandler(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {

    switch (ms.getStatementType()) { // @1 case STATEMENT: delegate = new SimpleStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql); break; case PREPARED: delegate = new PreparedStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql); break; case CALLABLE: delegate = new CallableStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql); break; default: throw new ExecutorException("Unknown statement type: " + ms.getStatementType()); }

    }

原来是会根据MappedStatement对象的statementType创建对应的StatementHandler。

2.2 创建StatementHandler

Configuration#newStatementHandler

public StatementHandler newStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
  StatementHandler statementHandler = new RoutingStatementHandler(executor, mappedStatement, parameterObject, rowBounds, resultHandler, boundSql); // @1
  statementHandler = (StatementHandler) interceptorChain.pluginAll(statementHandler); // @2
  return statementHandler;
}

该方法的两个关键点如下:

代码@1:创建RoutingStatementHandler对象,在其内部再根据SQL语句的类型,创建对应的StatementHandler对象。

代码@2:对StatementHandler引入拆件机制,该部分将在该专题的后续文章中会详细介绍,这里暂时跳过。

3、ParameterHandler

参数处理器。同样我们先来看一下其类图。

3.1 ParameterHandler类图

Mybatis执行SQL的4大基础组件详解(图文并茂)

这个比较简单,就是处理PreparedStatemet接口的参数化处理,也可以顺便看一下其调用链(该部分会在下一篇中详细介绍)。 Mybatis执行SQL的4大基础组件详解(图文并茂)

3.2 创建ParameterHandler

Configuration#newParameterHandler

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
  ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
  parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);  // @1
  return parameterHandler;
}

同样该接口也支持插件化机制。

4、ResultSetHandler

处理结果的Handler。我们同样看一下其类图。

4.1 ResultSetHandler类图

Mybatis执行SQL的4大基础组件详解(图文并茂)

处理Jdbc ResultSet的处理器。

4.2 ResultSetHandler创建

Configuration#newResultSetHandler

public ResultSetHandler newResultSetHandler(Executor executor, MappedStatement mappedStatement, RowBounds rowBounds, ParameterHandler parameterHandler,
    ResultHandler resultHandler, BoundSql boundSql) {
  ResultSetHandler resultSetHandler = new DefaultResultSetHandler(executor, mappedStatement, parameterHandler, resultHandler, boundSql, rowBounds);
  resultSetHandler = (ResultSetHandler) interceptorChain.pluginAll(resultSetHandler);
  return resultSetHandler;
}

同样支持插件化机制,我们也稍微再看一下其调用链: Mybatis执行SQL的4大基础组件详解(图文并茂)

可以看出其调用的入口为SQL执行时。

本文作为下一篇《源码分析Mybatis整合ShardingJdbc SQL执行流程》的前置篇,重点介绍Executor、StatementHandler、ParameterHandler、ResultSetHandler的具体职责,以类图为基础并详细介绍其核心方法的作用,然后详细介绍了这些对象是如何创建,并引出Mybatis拆件机制。


作者介绍:丁威,《RocketMQ技术内幕》作者,RocketMQ 社区布道师,公众号:中间件兴趣圈 维护者,目前已陆续发表源码分析Java集合、Java 并发包(JUC)、Netty、Mycat、Dubbo、RocketMQ、Mybatis等源码专栏。

Mybatis执行SQL的4大基础组件详解(图文并茂)

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
10个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这