Mybatis源码阅读（四）：核心接口4.1——StatementHandler

最新推荐文章于 2023-09-02 20:16:21 发布
最新推荐文章于 2023-09-02 20:16:21 发布
阅读量103 收藏
点赞数
分类专栏： 随手笔记 文章标签： 数据库 java mysql mybatis 大数据
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41530937/article/details/111047937
版权

*************************************优雅的分割线 **********************************

分享一波:程序员赚外快-必看的巅峰干货

如果以上内容对你觉得有用,并想获取更多的赚钱方式和免费的技术教程

请关注微信公众号:HB荷包
在这里插入图片描述
一个能让你学习技术和赚钱方法的公众号,持续更新
*************************************优雅的分割线 **********************************
前言

难得复工了，公司百业待兴，有一大堆接口需要对接，忙的不行。回过神来发现自己快一个月没写博客了，赶紧抽时间写一写，不能断更。

截止上一篇博客，我们已经把结果集映射的内容介绍完毕，接下来就是对Mybatis中的核心接口进行介绍，通过介绍这些核心接口，使读者们更深刻地理解Mybatis的运行机制以及原理。
StatementHandler

StatementHandler接口是Mybatis的核心接口之一，它完成了Mybatis中最核心的工作，也是Executor接口实现的基础。

StatementHandler接口中功能有很多，如创建Statement对象、执行SQL语句、批量执行SQL语句等。StatementHandler接口定义如下。

/**

  • Mybatis核心接口之一，完成了Mybatis中最核心的工作，也是Executor接口实现的基础。

  • @author Clinton Begin
    */
    public interface StatementHandler {

    /**

    • 从数据库连接中获取一个Statement
    • @param connection
    • @param transactionTimeout
    • @return
    • @throws SQLException
      */
      Statement prepare(Connection connection, Integer transactionTimeout)
      throws SQLException;

    /**

    • 绑定statement执行时所需的实参
    • @param statement
    • @throws SQLException
      */
      void parameterize(Statement statement)
      throws SQLException;

    /**

    • 批量执行sql语句
    • @param statement
    • @throws SQLException
      */
      void batch(Statement statement)
      throws SQLException;

    /**

    • 执行 update/insert/delete语句
    • @param statement
    • @return
    • @throws SQLException
      */
      int update(Statement statement)
      throws SQLException;

    /**

    • 执行select语句
    • @param statement
    • @param resultHandler
    • @param
    • @return
    • @throws SQLException
      */
      List query(Statement statement, ResultHandler resultHandler)
      throws SQLException;

    /**

    • 查询游标
    • @param statement
    • @param
    • @return
    • @throws SQLException
      */
      Cursor queryCursor(Statement statement)
      throws SQLException;

    /**

    • 获取BoundSql
    • @return
      */
      BoundSql getBoundSql();

    /**

    • 获取ParameterHandler
    • @return
      */
      ParameterHandler getParameterHandler();

}

该接口的继承关系如下。其中，CallableStatementHandler用于调用存储过程，而mysql的存储过程在大多数公司都很少使用甚至禁止使用，这里就不对其进行介绍了，有兴趣的朋友可以自己参考源码阅读

RoutingStatementHandler

RoutingStatementHandler使用策略模式，根据MappedStatement中指定的statementType字段，创建对应的StatementHandler接口实现。由于其这种思路，还有人认为这是个路由。RoutingStatementHandler核心代码如下。

public class RoutingStatementHandler implements StatementHandler {

/**
 * 底层封装的真正的StatementHandler对象
 * 这里的delegate在写框架的过程中使用较多
 */
private final StatementHandler delegate;

public RoutingStatementHandler(Executor executor, MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
    // RoutingStatementHandler的主要功能是根据MappedStatement的配置，生成对应的StatementHandler对象
    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());
    }

}

}

BaseStatementHandler

BaseStatementHandler是一个抽象类，实现了StatementHandler接口。它只提供了一些参数绑定相关的方法，对数据库不进行任何操作。该类的字段如下。

protected final Configuration configuration;
protected final ObjectFactory objectFactory;
protected final TypeHandlerRegistry typeHandlerRegistry;

/**
 * 记录结果集映射对象
 */
protected final ResultSetHandler resultSetHandler;

/**
 * 记录使用的参数处理器对象。ParameterHandler的主要功能是为SQL绑定实参
 * 也就是使用传入的实参替换SQL语句中的 ? 占位符
 */
protected final ParameterHandler parameterHandler;

protected final Executor executor;

/**
 * 记录SQL语句对应的MappedStatement
 */
protected final MappedStatement mappedStatement;

/**
 * 记录用户设置的offset和limit，用于在结果集中定位映射的起始位置和结束位置
 */
protected final RowBounds rowBounds;

protected BoundSql boundSql;

在BaseStatementHandler的构造方法中，除对上面的字段进行初始化之外，还会调用KeyGenerator.processBefore()方法初始化SQL的主键，具体实现如下。

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) {
        // 调用KeyGenerator.processBefore 方法获取主键
        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);
}

protected void generateKeys(Object parameter) {
    KeyGenerator keyGenerator = mappedStatement.getKeyGenerator();
    ErrorContext.instance().store();
    keyGenerator.processBefore(executor, mappedStatement, null, parameter);
    ErrorContext.instance().recall();
}

BaseStatementHandler实现了StatementHandler的prepare方法，该方法用来初始化Statement对象，然后为其分配超时时间等属性。其中，初始化StatementHandler的方法是个抽象方法instantiateStatement，是一个抽象方法，需要由子类去实现，代码如下。

@Override
public Statement prepare(Connection connection, Integer transactionTimeout) throws SQLException {
    ErrorContext.instance().sql(boundSql.getSql());
    Statement statement = null;
    try {
        // 初始化statement对象，交给子类去实现
        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);
    }
}

BaseStatementHandler依赖两个重要的组件，分别是ParameterHandler和ResultSetHandler。后者在前面的文章中已经介绍，不在重复。
ParameterHandler

通过前面介绍动态SQL可知，在BoundSql中记录的SQL语句可能包含?占位符，每个?占位符都对应了BoundSql.parameterMapings集合中的一个元素。在ParameterHandler中只定义了一个setParameter方法，该方法用于为SQL语句绑定实参。ParameterHandler接口只有唯一一个实现类 DefaultParameterHandler，核心字段如下。

/**
 * 管理Mybatis中的全部TypeHandler对象
 */
private final TypeHandlerRegistry typeHandlerRegistry;

/**
 * SQL节点
 */
private final MappedStatement mappedStatement;

/**
 * 用户传入的实参对象
 */
private final Object parameterObject;
private final BoundSql boundSql;
private final Configuration configuration;

DefaultParameterHandler的setParameters方法中会遍历parameterMappings集合中记录的ParameterMapping对象，并根据其中记录的参数名称找到对应的实参，再与SQL绑定。setParameters方法如下。

/**
 * 设置参数
 * @param ps
 */
@Override
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);
            // OUT是存储过程中的输出参数，这里需要过滤掉这些参数
            if (parameterMapping.getMode() != ParameterMode.OUT) {
                Object value;
                // 获取参数名称
                String propertyName = parameterMapping.getProperty();
                // 获取对应的实参值
                if (boundSql.hasAdditionalParameter(propertyName)) {
                    value = boundSql.getAdditionalParameter(propertyName);
                } else if (parameterObject == null) {
                    value = null;
                } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
                    // 实参可以直接通过TypeHandler转换成jdbcType
                    value = parameterObject;
                } else {
                    MetaObject metaObject = configuration.newMetaObject(parameterObject);
                    value = metaObject.getValue(propertyName);
                }
                // 获取parameterMapping中设置的TypeHandler对象
                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);
                }
            }
        }
    }
}

对SQL语句绑定完实参后，就可以调用Statement对象的execute方法执行SQL了。
SimpleStatementHandler

SimpleStatementHandler是BaseStatementHandler的子类，底层使用了Statement对象完成数据库的相关操作，所以SQL语句中不能存在占位符，因此parameterize方法是空实现。

SimpleStatementHandler的instantiateStatement方法直接通过JDBC Connection创建Statement，代码如下。

/**
 * 创建statement对象
 * @param connection
 * @return
 * @throws SQLException
 */
@Override
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方法完成了数据库查询的操作，并通过ResultSetHandler将结果集映射成结果对象，代码如下。

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

update方法负责执行insert、update、delete的SQL语句，并根据配置的KeyGenerator获取数据库生成的主键，具体实现如下。

/**
 * 负责执行insert、update、delete语句
 * @param statement
 * @return
 * @throws SQLException
 */
@Override
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;
}

PreparedStatementHandler

该类底层依赖于PrepareStatement对象完成数据库的操作，instantiateStatement方法直接调用Connection的prepareStatement方法创建PrepareStatement对象，代码如下。

/**
 * 直接调用Connection的prepareStatement方法创建PrepareStatement对象
 * @param connection
 * @return
 * @throws SQLException
 */
@Override
protected Statement instantiateStatement(Connection connection) throws SQLException {
    // 获取待执行的sql
    String sql = boundSql.getSql();
    // 根据keyGenerator的值创建PrepareStatement对象
    if (mappedStatement.getKeyGenerator() instanceof Jdbc3KeyGenerator) {
        String[] keyColumnNames = mappedStatement.getKeyColumns();
        if (keyColumnNames == null) {
            // 返回数据库生成的主键
            return connection.prepareStatement(sql, PreparedStatement.RETURN_GENERATED_KEYS);
        } else {
            // 在insert语句执行完成之后，将keyColumnNames指定的列返回
            return connection.prepareStatement(sql, keyColumnNames);
        }
    } else if (mappedStatement.getResultSetType() == ResultSetType.DEFAULT) {
        // 设置结果集是否可以滚动以及游标是否可以上下移动，设置结果集是否可更新
        return connection.prepareStatement(sql);
    } else {
        // 创建普通的PrepareStatement对象
        return connection.prepareStatement(sql, mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
    }
}

PrepareStatement的其他方法的实现与SimpleStatementHandler对应的方法实现类型，这里就不赘述了。

*************************************优雅的分割线 **********************************

分享一波:程序员赚外快-必看的巅峰干货

如果以上内容对你觉得有用,并想获取更多的赚钱方式和免费的技术教程

请关注微信公众号:HB荷包
在这里插入图片描述
一个能让你学习技术和赚钱方法的公众号,持续更新
*************************************优雅的分割线 **********************************

HB荷包
关注
专栏目录
MyBatis-Executor源码全面分析
Javaer
08-14 312
全面分析MyBatis执行器相关源码，细节到每一个类！！！！
MyBatis从前世到今生一网打尽（全网最全，建议收藏）
weixin_57907028的博客
07-27 362
一、框架概述 1.1 软件开发常用结构 1.1.1、三层架构 ​ 三层架构包含的三层： 界面层（User Interface layer） 业务逻辑层（Business Logic Layer） 数据访问层（Data access layer） ​ 三层架构分别的职责是： 界面层（表示层，视图层）：主要功能是接受用户的数据，显示请求的处理结果。使用 web 页面和 用户交互，手机 app 也就是表示层的，用户在 app 中操作，业务逻辑在服务器端处理。 业务逻辑层：接收表示传
mybatis之StatementHandler
a1047003619的博客
06-14 1025
StatementHandler接口是MyBatis核心接口之一，它完成了MyBatis最核心的工作。 StatementHandler接口中的功能很多，例如创建Statement对象，为SQL语句绑定实参，执行select、insert、update、delete等多种类型的SQL语句，批量执行SQL语句，将结果集映射成结果对象。 StatementHandler接口的定义如下： public interface StatementHandler { // 从连接中获取一个Statement S
第二篇：mybatis核心接口
zxc_user的博客
07-05 553
mybatis源码
Mybatis源码学习（五）Executor和StatementHandler详解
K_Tang的博客
09-13 1899
Mybatis源码学习（一）初探执行流程前言1. 寻觅官网demo, quick start2. 根据demo画出调用流程图3. Learn With Questions文章链接 前言 作为业界使用最广的ORM层框架,没有之一.想要翻身码农把歌唱,怎么能不去学习他的源码呢!!! Let’s do it! 注: Mybatis版本3.5.5, 数据库为Mysql 所有后续的mybatis源码学习都是基于上述版本 1. 寻觅官网demo, quick start 窃以为熟悉一个框架的最好方式就是官网下载demo
Mybatis核心接口和类
小白成长记录
05-31 4341
Mybatis核心接口和类SqlSessionFactoryBuilder读取核心配置文件生成会话工厂的类，初始化Configuration对象。SqlSessionFactory新建和管理会话的工厂类SqlSession会话对象类(程序最常打交道的对象)Configuration对应mybatis-config配置文件的一个对象,里面包含了mybatis配置信息和映射器配置文件信息MappedSt
MyBatis源码通~SQL语句执行
一只打杂的码农
05-18 2138
SQL语句执行 SQL执行过程包括但不限于 Mapper 接口代理类的生成、接口方法的解析、SQL 语句的解析、运行时参数的绑定、查询结果自动映射、延迟加载等。 1、涉及技术点 为 Mapper 接口生成实现类（其实对应的就是代理类） 根据配置信息生成 SQL，并将运行时参数设置到 SQL 中 一二级缓存的实现 插件机制 数据库连接的获取与管理 查询结果的处理，以及延迟加载等 2、主要涉及类或...
Mybatis源码学习第十一课---插件开发原理
qq_36697880的博客
03-19 261
一.插件开发原理 插件是用来改变或者扩展mybatis的原有功能，mybatis的插件就是通过继承Interceptor拦截器实现的，在没有完全理解插件之前禁止使用插件对mybatis进行扩展，否则可能会导致严重问题。 mybatis中能使用插件进行拦截的接口和方法如下： Executor（update query flushStatement commit rollback getTran...
Java 源码解析最全合集
热门推荐
芋艿V
01-08 1万+
个人博客
SqlSession对象之StatementHandler
12-07 261
上一篇讲了SqlSession对象中的Executor，接下来将对SqlSession的另一个对象StatementHandler进行讲解。 一、StatementHandler介绍 StatementHandler是Mybatis中最重要的一个对象，它负责操作Statement与数据库进行交流，在此过程中还会调用ParameterHandler进行参数配置，使用ResultHandle...
StatementHandler
BryantLmm的博客
11-26 1980
我们接着看四大组件的StatementHandler。首先还是来看代码接上一篇末尾SimpleExecutor的doQuery public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) th
MyBatis 核心配置综述之StatementHandler
最新发布
白话机器学习
09-02 412
StatementHandler 对象是在 SqlSession 对象接收到命令操作时，由 Configuration 对象中的newStatementHandler 负责调用的，也就是说 Configuration 中的 newStatementHandler 是由执行器中的查询、更新(插入、更新、删除)方法来提供的，StatementHandler 其实就是由 Executor 负责管理和创建的。我们可以看到，为参数赋值的工作是由一个叫做 parameterHandler 对象完成的，都是这样的吗？
MyBatis原理第四篇——statementHandler对象（sqlSession内部核心实现，插件的基础）
ykzhen2015的专栏
01-28 1万+
这里MyBatis下SqlSession运行的核心内容。
Mybatis核心处理层源码阅读分析（StatementHandler系列组件）
Nicholas.S的博客
12-29 236
StatementHandler接口是MyBatis的核心接口之一，它完成了MyBatis中最核心的工作，也是Executor 接口实现的基础。 StatementHandler接口中的功能很多，例如创建Statement对象，为SQL语句绑定实参，执行select、insert、update、delete等多种类型的SQL语句，批量执行SQL语句，将结果集映射成结果对象。 public inte...
MyBatis：核心API及其作用域、配置文件详解
燕双嘤
04-16 809
1，MyBatis的核心API及作用域 在实现Mapper组件之后，主程序要用到SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession等核心API。 1.1，SqlSessionFactoryBuilder的作用域 SqlSessionFactoryBuilder甚至算不上核心API，从它源码来看，它甚至没有专门定义构造器（Java会提供默认的、无参构造器），它主要提供了如下方法： //该方法有多个重载版本 public SqlSessio
MyBatis(三)：StatementHandler
GDUT_Trim的博客
09-09 729
回顾三部分对应关系StatementHandlerStatementHandler结构PrepareStatementHandler执行流程构建StatementHandlerquery方法实现parameter方法实现 回顾 MyBatis的执行流程 Sqlsession （会话层面，门面模式）-》 Executor（执行器，模板方法，doQuery和query）-》 StatementHandler（JDBC处理器） JDBC分为三部分 获取Statement，声明Statement 设置Sql参.
Mybatis源码笔记之浅析StatementHandler
增量星球
06-01 4795
目录概述职责类图源码 概述 职责 首先了解一下statementHandler职责：主要负责处理MyBatis与JDBC之间Statement的交互，通俗而言就是负责操作Statement对象与数据库之间的交互。其执行过程中主要依赖ParameterHandler和ResultSetHandler进行参数绑定和结果实体类绑定。 类图 BaseStatementHandler：StatementHandler接口的抽象实现类，主要用于简化StatementHandler接口的实现难度，适配 器设计模式的体
Mybatis源码深度剖析：SqlSessionFactory与关键组件详解
在Mybatis的源码分析中，主要关注的核心概念有以下几点： 1. Configuration：这是Mybatis的全局配置管理器，它负责解析MySQL-config.xml文件中的配置信息。`XMLConfigBuilder`类中的`parseConfigurationProperties`...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值