【图文并茂】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拆件机制。

相关文章
|
5月前
|
SQL XML Java
通过MyBatis的XML配置实现灵活的动态SQL查询
总结而言,通过MyBatis的XML配置实现灵活的动态SQL查询,可以让开发者以声明式的方式构建SQL语句,既保证了SQL操作的灵活性,又简化了代码的复杂度。这种方式可以显著提高数据库操作的效率和代码的可维护性。
332 18
|
10月前
|
SQL Java 数据库连接
【YashanDB知识库】解决mybatis的mapper文件sql语句结尾加分号";"报错
【YashanDB知识库】解决mybatis的mapper文件sql语句结尾加分号";"报错
|
9月前
|
SQL Java 数据库连接
MyBatis动态SQL字符串空值判断,这个细节99%的程序员都踩过坑!
本文深入探讨了MyBatis动态SQL中字符串参数判空的常见问题。通过具体案例分析,对比了`name != null and name != &#39;&#39;`与`name != null and name != &#39; &#39;`两种写法的差异,指出后者可能引发逻辑混乱。为避免此类问题,建议在后端对参数进行预处理(如trim去空格),简化MyBatis判断逻辑,提升代码健壮性与可维护性。细节决定成败,严谨处理参数判空是写出高质量代码的关键。
1186 0
|
5月前
|
SQL Java 数据库连接
SSM相关问题-1--#{}和${}有什么区别吗?--Mybatis都有哪些动态sql?能简述一下动 态sql的执行原理吗?--Spring支持的几种bean的作用域 Scope
在MyBatis中,`#{}`是预处理占位符,可防止SQL注入,适用于大多数参数传递场景;而`${}`是直接字符串替换,不安全,仅用于动态表名、列名等特殊场景。二者在安全性、性能及使用场景上有显著区别。
94 0
|
8月前
|
SQL XML Java
菜鸟之路Day35一一Mybatis之XML映射与动态SQL
本文介绍了MyBatis框架中XML映射与动态SQL的使用方法,作者通过实例详细解析了XML映射文件的配置规范,包括namespace、id和resultType的设置。文章还对比了注解与XML映射的优缺点,强调复杂SQL更适合XML方式。在动态SQL部分,重点讲解了`&lt;if&gt;`、`&lt;where&gt;`、`&lt;set&gt;`、`&lt;foreach&gt;`等标签的应用场景,如条件查询、动态更新和批量删除,并通过代码示例展示了其灵活性与实用性。最后,通过`&lt;sql&gt;`和`&lt;include&gt;`实现代码复用,优化维护效率。
752 5
|
10月前
|
SQL Java 数据库连接
【YashanDB 知识库】解决 mybatis 的 mapper 文件 sql 语句结尾加分号";"报错
【YashanDB 知识库】解决 mybatis 的 mapper 文件 sql 语句结尾加分号";"报错
|
10月前
|
SQL 缓存 Java
框架源码私享笔记(02)Mybatis核心框架原理 | 一条SQL透析核心组件功能特性
本文详细解构了MyBatis的工作机制,包括解析配置、创建连接、执行SQL、结果封装和关闭连接等步骤。文章还介绍了MyBatis的五大核心功能特性:支持动态SQL、缓存机制(一级和二级缓存)、插件扩展、延迟加载和SQL注解,帮助读者深入了解其高效灵活的设计理念。
|
7月前
|
Java 数据库连接 数据库
Spring boot 使用mybatis generator 自动生成代码插件
本文介绍了在Spring Boot项目中使用MyBatis Generator插件自动生成代码的详细步骤。首先创建一个新的Spring Boot项目,接着引入MyBatis Generator插件并配置`pom.xml`文件。然后删除默认的`application.properties`文件,创建`application.yml`进行相关配置,如设置Mapper路径和实体类包名。重点在于配置`generatorConfig.xml`文件,包括数据库驱动、连接信息、生成模型、映射文件及DAO的包名和位置。最后通过IDE配置运行插件生成代码,并在主类添加`@MapperScan`注解完成整合
1243 1
Spring boot 使用mybatis generator 自动生成代码插件
|
10月前
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式:基于XML和注解的形式。重点讲解了注解方式,包括@Select、@Insert、@Update、@Delete等常用注解的使用方法,以及多参数时@Param注解的应用。同时,针对字段映射不一致的问题,提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点,灵活使用两者以提高开发效率,并附带课程源码供下载学习。
791 0
|
12月前
|
前端开发 Java 数据库连接
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤,涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括: 1. **数据库准备**:创建数据库和表。 2. **查询数据库**:验证数据库是否可用。 3. **IDEA代码配置**:构建实体类并配置数据库连接。 4. **测试类编写**:编写并运行测试类以确保一切正常。
572 2