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

简介: 【图文并茂】Mybatis执行SQL的4大基础组件详解

image.png

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


1.1 Executor类图


51374d9496861a4fa307f29f0e16636d.jpg


  • 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 param, RowBounds b, BoundSql s)
    创建缓存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


1public Executor newExecutor(Transaction transaction) {
 2  return newExecutor(transaction, defaultExecutorType);   // @1
 3}
 4
 5
 6public Executor newExecutor(Transaction transaction, ExecutorType executorType) {
 7  executorType = executorType == null ? defaultExecutorType : executorType;
 8  executorType = executorType == null ? ExecutorType.SIMPLE : executorType;
 9  Executor executor;
10  if (ExecutorType.BATCH == executorType) {   // @2
11    executor = new BatchExecutor(this, transaction);
12  } else if (ExecutorType.REUSE == executorType) {
13    executor = new ReuseExecutor(this, transaction);
14  } else {
15    executor = new SimpleExecutor(this, transaction);
16  }
17  if (cacheEnabled) { // @3
18    executor = new CachingExecutor(executor);
19  }
20  executor = (Executor) interceptorChain.pluginAll(executor);  // @4
21  return executor;
22}

从上面的代码可以看出,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的拆件机制,将在该系列文章中详细介绍。

image.png

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


2.1 StatementHandler类图


789a12c3e6597e297ee8df0cfe7c7c2c.jpg

  • StatementHandler


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


  • Statement prepare(Connection c)
    创建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的抽象实现类。我们来一一看一下其示例变量:

  • 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路由器,我们看一下其构造方法后,就会对该类了然于胸。
1public RoutingStatementHandler(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
 2
 3  switch (ms.getStatementType()) { // @1
 4    case STATEMENT:
 5      delegate = new SimpleStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
 6      break;
 7    case PREPARED:
 8      delegate = new PreparedStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
 9      break;
10    case CALLABLE:
11      delegate = new CallableStatementHandler(executor, ms, parameter, rowBounds, resultHandler, boundSql);
12      break;
13    default:
14      throw new ExecutorException("Unknown statement type: " + ms.getStatementType());
15  }
16
17}

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


2.2 创建StatementHandler


Configuration#newStatementHandler


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

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


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


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

image.png


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


3.1 ParameterHandler类图



0a51a4ebd7ddf000939b9ad4a0607336.png

这个比较简单,就是处理PreparedStatemet接口的参数化处理,也可以顺便看一下其调用链(该部分会在下一篇中详细介绍)。

24a07170126fe9ebbf22589751a65f38.png


3.2 创建ParameterHandler


Configuration#newParameterHandler


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

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

image.png

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


4.1 ResultSetHandler类图


8aaca8e214e72fe7f6a9e2639d9d4dd6.png

处理Jdbc ResultSet的处理器。


4.2 ResultSetHandler创建


Configuration#newResultSetHandler


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

同样支持插件化机制,我们也稍微再看一下其调用链:


d11c39b773aab1289e685fd6ddf53cac.jpg

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


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

目录
打赏
0
0
0
0
231
分享
相关文章
|
6天前
|
九、MyBatis动态SQL
九、MyBatis动态SQL
21 2
|
2天前
|
六、MyBatis特殊的SQL:模糊查询、动态设置表名、校验名称唯一性
六、MyBatis特殊的SQL:模糊查询、动态设置表名、校验名称唯一性
15 0
3、Mybatis-Plus 自定义sql语句
这篇文章介绍了如何在Mybatis-Plus框架中使用自定义SQL语句进行数据库操作。内容包括文档结构、编写mapper文件、mapper.xml文件的解释说明、在mapper接口中定义方法、在mapper.xml文件中实现接口方法的SQL语句,以及如何在单元测试中测试自定义的SQL语句,并展示了测试结果。
3、Mybatis-Plus 自定义sql语句
【潜意识Java】MyBatis中的动态SQL灵活、高效的数据库查询以及深度总结
本文详细介绍了MyBatis中的动态SQL功能,涵盖其背景、应用场景及实现方式。
133 6
|
3月前
|
mybatis实现动态sql
MyBatis的动态SQL功能为开发人员提供了强大的工具来应对复杂的查询需求。通过使用 `<if>`、`<choose>`、`<foreach>`等标签,可以根据不同的条件动态生成SQL语句,从而提高代码的灵活性和可维护性。本文详细介绍了动态SQL的基本用法和实际应用示例,希望对您在实际项目中使用MyBatis有所帮助。
115 11
【详细实用のMyBatis教程】获取参数值和结果的各种情况、自定义映射、动态SQL、多级缓存、逆向工程、分页插件
本文详细介绍了MyBatis的各种常见用法MyBatis多级缓存、逆向工程、分页插件 包括获取参数值和结果的各种情况、自定义映射resultMap、动态SQL
【详细实用のMyBatis教程】获取参数值和结果的各种情况、自定义映射、动态SQL、多级缓存、逆向工程、分页插件
canal-starter 监听解析 storeValue 不一样,同样的sql 一个在mybatis执行 一个在数据库操作,导致解析不出正确对象
canal-starter 监听解析 storeValue 不一样,同样的sql 一个在mybatis执行 一个在数据库操作,导致解析不出正确对象
mybatis使用四:dao接口参数与mapper 接口中SQL的对应和对应方式的总结,MyBatis的parameterType传入参数类型
这篇文章是关于MyBatis中DAO接口参数与Mapper接口中SQL的对应关系,以及如何使用parameterType传入参数类型的详细总结。
95 10
mybatis复习03,动态SQL,if,choose,where,set,trim标签及foreach标签的用法
文章介绍了MyBatis中动态SQL的用法,包括if、choose、where、set和trim标签,以及foreach标签的详细使用。通过实际代码示例,展示了如何根据条件动态构建查询、更新和批量插入操作的SQL语句。
mybatis复习03,动态SQL,if,choose,where,set,trim标签及foreach标签的用法
Mybatis系列之 Error parsing SQL Mapper Configuration. Could not find resource com/zyz/mybatis/mapper/
文章讲述了在使用Mybatis时遇到的资源文件找不到的问题,并提供了通过修改Maven配置来解决资源文件编译到target目录下的方法。
Mybatis系列之 Error parsing SQL Mapper Configuration. Could not find resource com/zyz/mybatis/mapper/
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等