mybatis中statementHandler的设计与实现

最新推荐文章于 2024-05-03 11:29:27 发布
最新推荐文章于 2024-05-03 11:29:27 发布
阅读量386 收藏 1
点赞数
分类专栏： mybatis 文章标签： mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiexingshishu/article/details/108956887
版权

1、StatementHandler

StatementHandler接口定义包含创建Statement, 绑定参数，批量执行，更新，查询，获取参数处理器

类结构图为

PreparedStatementHandler用于处理带有占位符的语句

SimpleStatementHandler处理不带占位符的

CallableStatementHandler处理存储过程调用语句

1.1、RoutingStatementHandler

起代理作用，根据不同的语句类型创建不同BaseStatementHandler子类。

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

    switch (ms.getStatementType()) {
      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());
    }

  }

1.2、BaseStatementHandler

是其它子类的基类，会创建ParameterHandler,ResultSetHandler。BaseStatementHandler依赖两个组件ParameterHandler和ResultSetHandler。

protected BaseStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    this.configuration = mappedStatement.getConfiguration();
    this.executor = executor;
    this.mappedStatement = mappedStatement;
    this.rowBounds = rowBounds;

    this.typeHandlerRegistry = configuration.getTypeHandlerRegistry();
    this.objectFactory = configuration.getObjectFactory();

    if (boundSql == null) { // issue #435, get the key before calculating the statement
      generateKeys(parameterObject);
      boundSql = mappedStatement.getBoundSql(parameterObject);
    }

    this.boundSql = boundSql;

    this.parameterHandler = configuration.newParameterHandler(mappedStatement, parameterObject, boundSql);
    this.resultSetHandler = configuration.newResultSetHandler(executor, mappedStatement, rowBounds, parameterHandler, resultHandler, boundSql);
  }

实现StatementHandlere接口中的prepare，首先调用instantiateStatement抽象方法初始化java.sql.Statement对象，配置超时时间和fetchSize。

public Statement prepare(Connection connection, Integer transactionTimeout) throws SQLException {
    ErrorContext.instance().sql(boundSql.getSql());
    Statement statement = null;
    try {
      statement = instantiateStatement(connection);
      setStatementTimeout(statement, transactionTimeout);
      setFetchSize(statement);
      return statement;
    } catch (SQLException e) {
      closeStatement(statement);
      throw e;
    } catch (Exception e) {
      closeStatement(statement);
      throw new ExecutorException("Error preparing statement.  Cause: " + e, e);
    }
  }

1.3、SimpleStatementHandler

继承BaseStatementHandler抽象类，sql语句中没有占位符，相应的parameterize方法为空实现。

instantiateStatement直接通过JDBC Connection创建Statemtn对象。

protected Statement instantiateStatement(Connection connection) throws SQLException {
    if (mappedStatement.getResultSetType() == ResultSetType.DEFAULT) {
      return connection.createStatement();
    } else {
      return connection.createStatement(mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
    }
  }

查询query 通过创建的Statement对象来完成数据库查询操作，结果通过ResultSetHandler将结果集映射成结果对象。

public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
    String sql = boundSql.getSql();
    statement.execute(sql);
    return resultSetHandler.handleResultSets(statement);
  }

queryCursor，batch方法与query方法类似。也是直接调用Statement对象的对应方法。

update方法执行insert、update或delete等sql语句，并且会根据配置的KeyGenerator获取数据库的主键。

public int update(Statement statement) throws SQLException {
    String sql = boundSql.getSql();
    Object parameterObject = boundSql.getParameterObject();
    KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();
    int rows;
    if (keyGenerator instanceof Jdbc3KeyGenerator) {
      statement.execute(sql, Statement.RETURN_GENERATED_KEYS);
      rows = statement.getUpdateCount();
      keyGenerator.processAfter(executor, mappedStatement, statement, parameterObject);
    } else if (keyGenerator instanceof SelectKeyGenerator) {
      statement.execute(sql);
      rows = statement.getUpdateCount();
      keyGenerator.processAfter(executor, mappedStatement, statement, parameterObject);
    } else {
      statement.execute(sql);
      rows = statement.getUpdateCount();
    }
    return rows;
  }

1.4、PreparedStatementHandler

依赖java.sql.PreparedStatement对象来完成数据库的相关操作。

parameterize方法会调用ParameterHandler.setParameters完成sql语句的参数绑定。

instantiateStatement方法会直接调用JDBC Connection的prepareStatement方法创建PreparedStatement对象。

protected Statement instantiateStatement(Connection connection) throws SQLException {
    String sql = boundSql.getSql();
    if (mappedStatement.getKeyGenerator() instanceof Jdbc3KeyGenerator) {
      String[] keyColumnNames = mappedStatement.getKeyColumns();
      if (keyColumnNames == null) {
        return connection.prepareStatement(sql, PreparedStatement.RETURN_GENERATED_KEYS);
      } else {
        return connection.prepareStatement(sql, keyColumnNames);
      }
    } else if (mappedStatement.getResultSetType() == ResultSetType.DEFAULT) {
      return connection.prepareStatement(sql);
    } else {
      return connection.prepareStatement(sql, mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
    }
  }

1.5、CallableStatementHandler

依赖于java.sql.CallableStatement调用指定的存储过程，其parameterize方法会调用ParameterHandler.setParameter方法完成sql语句的参数绑定，并指定输出参数的索引位置和JDBC类型。

public void parameterize(Statement statement) throws SQLException {
    registerOutputParameters((CallableStatement) statement);
    parameterHandler.setParameters((CallableStatement) statement);
  }

private void registerOutputParameters(CallableStatement cs) throws SQLException {
    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
    for (int i = 0, n = parameterMappings.size(); i < n; i++) {
      ParameterMapping parameterMapping = parameterMappings.get(i);
      if (parameterMapping.getMode() == ParameterMode.OUT || parameterMapping.getMode() == ParameterMode.INOUT) {
        if (null == parameterMapping.getJdbcType()) {
          throw new ExecutorException("The JDBC Type must be specified for output parameter.  Parameter: " + parameterMapping.getProperty());
        } else {
          if (parameterMapping.getNumericScale() != null && (parameterMapping.getJdbcType() == JdbcType.NUMERIC || parameterMapping.getJdbcType() == JdbcType.DECIMAL)) {
            cs.registerOutParameter(i + 1, parameterMapping.getJdbcType().TYPE_CODE, parameterMapping.getNumericScale());
          } else {
            if (parameterMapping.getJdbcTypeName() == null) {
              cs.registerOutParameter(i + 1, parameterMapping.getJdbcType().TYPE_CODE);
            } else {
              cs.registerOutParameter(i + 1, parameterMapping.getJdbcType().TYPE_CODE, parameterMapping.getJdbcTypeName());
            }
          }
        }
      }
    }
  }

instantiateStatement直接调用JDBC Connection的prepareCall创建CallableStatement对象。

protected Statement instantiateStatement(Connection connection) throws SQLException {
    String sql = boundSql.getSql();
    if (mappedStatement.getResultSetType() == ResultSetType.DEFAULT) {
      return connection.prepareCall(sql);
    } else {
      return connection.prepareCall(sql, mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
    }
  }

其它方法与以上有一些差异，就是会调用ResultSetHandler的handleOutputParameters处理输出参数

public int update(Statement statement) throws SQLException {
    CallableStatement cs = (CallableStatement) statement;
    cs.execute();
    int rows = cs.getUpdateCount();
    Object parameterObject = boundSql.getParameterObject();
    KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();
    keyGenerator.processAfter(executor, mappedStatement, cs, parameterObject);
    resultSetHandler.handleOutputParameters(cs);
    return rows;
  }

public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
    CallableStatement cs = (CallableStatement) statement;
    cs.execute();
    List<E> resultList = resultSetHandler.handleResultSets(cs);
    resultSetHandler.handleOutputParameters(cs);
    return resultList;
  }

public <E> Cursor<E> queryCursor(Statement statement) throws SQLException {
    CallableStatement cs = (CallableStatement) statement;
    cs.execute();
    Cursor<E> resultList = resultSetHandler.handleCursorResultSets(cs);
    resultSetHandler.handleOutputParameters(cs);
    return resultList;
  }

2、ParameterHandler

主要包含绑定参数，及获取参数对象。

DefaultParameterHandler是唯一实现。

绑定参数时，遍历boundSql中的参数映射，忽略输出类型参数。提取值基于以下规则 

  1. 属性名是否在boundSql中的附加参数中，如果有，则直接从map中取值。
  2. 参数对象为空时，值设置为null
  3. TypeHandlerRegistry中是否参参数对象所必类型的处理器，有则直接取参数对象(说明是基础类型)
  4. 基于MetaObject获取属性值。

使用TypeHandler来设置PreparementStatement对应的值。

public void setParameters(PreparedStatement ps) {
    ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());
    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
    if (parameterMappings != null) {
      for (int i = 0; i < parameterMappings.size(); i++) {
        ParameterMapping parameterMapping = parameterMappings.get(i);
        if (parameterMapping.getMode() != ParameterMode.OUT) {
          Object value;
          String propertyName = parameterMapping.getProperty();
          if (boundSql.hasAdditionalParameter(propertyName)) { // issue #448 ask first for additional params
            value = boundSql.getAdditionalParameter(propertyName);
          } else if (parameterObject == null) {
            value = null;
          } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
            value = parameterObject;
          } else {
            MetaObject metaObject = configuration.newMetaObject(parameterObject);
            value = metaObject.getValue(propertyName);
          }
          TypeHandler typeHandler = parameterMapping.getTypeHandler();
          JdbcType jdbcType = parameterMapping.getJdbcType();
          if (value == null && jdbcType == null) {
            jdbcType = configuration.getJdbcTypeForNull();
          }
          try {
            typeHandler.setParameter(ps, i + 1, value, jdbcType);
          } catch (TypeException | SQLException e) {
            throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);
          }
        }
      }
    }
  }

kgduu
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
手撕Mybatis源码，自己动手实现Mybatis
11-14
要动手实现一个类似Mybatis的框架，首先需要设计和实现上述组件。理解每个组件的功能和它们之间的协作关系至关重要。你可以从以下几个步骤开始： 1. 设计并实现基础架构，包括SqlSessionFactory、Configuration、...
88丨开源实战五（中）：如何利用职责链与代理模式实现MyBatisPlugin？1
08-03
在本文中，我们将探讨如何利用职责链模式和代理模式实现MyBatisPlugin，这是一种在MyBatis框架中用于扩展和拦截SQL执行过程的方法。首先，我们要理解职责链模式的基本概念，它通常由处理器（Handler）和处理器链...
第六章-Mybatis源码解析-StatementHandler语句处理和执行（一）
zhang527294844的博客
03-06 594
第五章-Mybatis源码解析-StatementHandler语句处理和执行
Mybatis源码之Statement处理器SimpleStatementHandler（四）
井底之蛙
09-24 1969
SimpleStatementHandler就是使用基本的Statement来执行query、batch、update等操作，其实现还是比较简单的，当然在执行过程中会涉及keyGenerator和ResultHandler操作，这些我们会在接下来的博客中进行详解。SimpleStatementHandler用于执行简单的sql语句，这里简单的sql语句是指sql语句中没有变量，不会通过外部进行参数
MyBatis(三)：StatementHandler
最新发布
2401_84150206的博客
05-03 921
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！一个SqlSession只有一个Executor，而StatementHandler则是根据执行的Sql数量决定，并且是要查询数据库才会有StatementHandler，如果走了缓存是不会生成StatementHandler的下面就来看一下这个StatementHandlerStatementHandlerStatementHandler为JDBC处理器，底层实现就是JDBC，使用JDBC来构建Statem
Mybatis 处理器Handler分类及介绍
landywu1985的博客
06-22 3213
Handler分类及介绍处理器定位ParameterHandlerResultSetHandlerStatementHandler二级目录三级目录 处理器定位 前面我们分析过Mybatis的Executor，其实执行器还是调用StatementHandler来执行数据库操作。Mybatis中有3种类型的hanlder，分别为StatementHandler、ParameterHandler、ResultSetHandler。ParameterHandler主要解析参数，为Statement设置参数，Resu
MyBatis（技术NeiMu）：核心处理层（StatementHandler）
GDUT_Trim的博客
12-12 953
回顾StatementHandlerRoutingStatementHandlerBaseStatementHandlerParameterHandlerDefaultParameterHandlerSimpleStatementHandler创建Statement执行查询执行修改PrepareStatementHandler创建Statement执行查询执行修改绑定实参CallableStatementHandler 回顾 StatementHandler StatementHandler接口是MyBa.
MyBatis实现物理分页的实例
08-31
MyBatis 的原始设计并没有直接支持物理分页，但可以通过自定义插件（Plugin）来实现。插件是 MyBatis 提供的一种扩展机制，允许用户在特定的执行点插入自定义的行为。 **PaginationInterceptor 插件** 在给定的代码...
Mybatis 架构设计分享.pdf
10-24
Mybatis的主要目标是简化数据持久层操作，它将SQL语句与Java代码分离，通过XML或注解方式定义SQL语句，实现了SQL与Java对象的映射，使得数据库操作更为便捷。 **Mybatis与JDBC的关系**： Mybatis是对JDBC的封装和...
简单了解mybatis拦截器实现原理及实例
08-25
MyBatis拦截器设计的一个初衷是为了供用户在某些时候可以实现自己的逻辑而不必去动MyBatis固有的逻辑。 三、自定义拦截器 要实现自定义拦截器，需要三步骤： 1. 实现Interceptor接口 自定义拦截器需要实现...
MyBatis源码学习三——StatementHandler与拦截器原理
yx444535180的专栏
03-31 2896
文章目录一、StatementHandler1.1 RoutingStatementHandler1.2 PreparedStatementHandler二、拦截器2.1 InterceptorChain2.2 Intercepts注解三、PaginationInterceptor 一、StatementHandler 执行器Executer与缓存 上篇讲到一级缓存在BaseExecuter的queryFromDatabase()方法，当没有命中缓存时，从数据库中查询 doQuery(ms, parame
切面编程(4)：mybatis拦截器
sjzwangxufeng的专栏
06-01 689
web过滤器、spring拦截器，可对http请求进行拦截处理，mybatis也同样支持对sql语句执行的拦截处理。
mybatis3源码核心类5--SimpleStatementHandler
ahua186186的专栏
02-02 167
SimpleStatementHandler ： 真正做业务处理的类。 如果想从ORM层实现分库分表，StatementHandler接口是最佳切入点。 （1）通过MappedStatement，DynamicSqlSource，DynamicContext进行SQL解析，路由，插件增强等。 （2）执行JDBC操作，如果是查询则需要转换ResultSet为配置文件中的配置的resultMap属...
mybatis源码之SimpleStatementHandler
井底之蛙
01-07 1181
/** * @author Clinton Begin */ public class SimpleStatementHandler extends BaseStatementHandler { public SimpleStatementHandler(Executor executor, MappedStatement mappedStatement, Object paramete
StatementHandler
kongkong的专栏
09-22 540
类图 RoutingStatementHandler StatementHandler的路由类 处理具体的业务的都是delegate public class RoutingStatementHandler implements StatementHandler { private final StatementHandler delegate; public RoutingStatementHandler(Executor executor, MappedStatemen.
Mybatis 错误笔记
my博客
07-12 1791
bad SQL grammar [] ### Cause: java.sql.SQLException: ORA-00911: 无效字符 ; bad SQL grammar []; nested exception is java.sql.SQLException: ORA-00911: 无效字符 ] with root cause 语句在数据库中可以正常执行，在配置文件中出错，检查是否在sq...
Mybatis调用MySQL存储过程图文教程
hy565319583的博客
08-16 396
存储过程，一个在笔者看来“很难用”的东西（主要还是菜），工作中碰见的也很少，逻辑简单的还好，逻辑一旦复杂了，这个东西看起来并没有代码这么直观，一旦注释没写好，或者同事离职了，后面维护的人简直痛不欲生。 最近的接手的一个项目中，DAO层使用的是mybatis，各种功能的实现都是自己写sql，今天碰到一个统计功能，是由别人写好的存储过程，需要我用Mybatis来调用，本来以为很简单的东西，可硬是来来...
【MyBatis】MyBatis 核心配置综述之StatementHandler
九师兄
05-14 1799
1.概述 转载：核心配置综述之StatementHandler 2.MyBatis 四大组件之StatementHandler StatementHandler 是四大组件中最重要的一个对象，负责操作 Statement 对象与数据库进行交流，在工作时还会使用 ParameterHandler 和 ResultSetHandler 对参数进行映射，对结果进行实体类的绑定 我们在搭建原生JDBC的时候，会有这样一行代码 Statement stmt = conn.createStatement(); //也可

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

kgduu

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值