查看原文
其他

MyBatis 核心配置综述之 ParameterHandlers

cxuan Java极客技术 2019-12-19

大家好,我是本周的值班编辑 江南一点雨 ,本周将由我为大家排版并送出技术干货,大家可以在公众号后台回复“springboot”,获取最新版 Spring Boot2.1.6 视频教程试看。



MyBatis 四大核心组件我们已经了解到了两种,一个是 Executor ,它是MyBatis 解析SQL请求首先会经过的第一道关卡,它的主要作用在于创建缓存,管理 StatementHandler 的调用,为 StatementHandler 提供 Configuration 环境等。

StatementHandler 组件最主要的作用在于创建 Statement 对象与数据库进行交流,还会使用 ParameterHandler 进行参数配置,使用 ResultSetHandler 把查询结果与实体类进行绑定。那么本篇就来了解一下第三个组件 ParameterHandler。

ParameterHandler 简介

ParameterHandler 相比于其他的组件就简单很多了,ParameterHandler 译为参数处理器,负责为 PreparedStatement 的 sql 语句参数动态赋值,这个接口很简单只有两个方法

  1. /**

  2. * A parameter handler sets the parameters of the {@code PreparedStatement}

  3. * 参数处理器为 PreparedStatement 设置参数

  4. */

  5. public interface ParameterHandler {


  6. Object getParameterObject();


  7. void setParameters(PreparedStatement ps)

  8. throws SQLException;


  9. }

ParameterHandler 只有一个实现类 DefaultParameterHandler , 它实现了这两个方法。

  • getParameterObject:用于读取参数

  • setParameters: 用于对 PreparedStatement 的参数赋值

ParameterHandler 创建

参数处理器对象是在创建 StatementHandler 对象的同时被创建的,由 Configuration 对象负责创建

BaseStatementHandler.java

  1. protected BaseStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {

  2. this.configuration = mappedStatement.getConfiguration();

  3. this.executor = executor;

  4. this.mappedStatement = mappedStatement;

  5. this.rowBounds = rowBounds;


  6. this.typeHandlerRegistry = configuration.getTypeHandlerRegistry();

  7. this.objectFactory = configuration.getObjectFactory();


  8. if (boundSql == null) { // issue #435, get the key before calculating the statement

  9. generateKeys(parameterObject);

  10. boundSql = mappedStatement.getBoundSql(parameterObject);

  11. }


  12. this.boundSql = boundSql;


  13. // 创建参数处理器

  14. this.parameterHandler = configuration.newParameterHandler(mappedStatement, parameterObject, boundSql);

  15. // 创建结果映射器

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

  17. }

在创建 ParameterHandler 时,需要传入SQL的mappedStatement 对象,读取的参数和SQL语句

注意:一个 BoundSql 对象,就代表了一次sql语句的实际执行,而 SqlSource 对象的责任,就是根据传入的参数对象,动态计算这个 BoundSql, 也就是 Mapper 文件中节点的计算,是由 SqlSource 完成的,SqlSource 最常用的实现类是 DynamicSqlSource

Configuration.java

  1. public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {

  2. // 创建ParameterHandler

  3. ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);

  4. parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);

  5. return parameterHandler;

  6. }

上面是 Configuration 创建 ParameterHandler 的过程,它实际上是交由 LanguageDriver 来创建具体的参数处理器,LanguageDriver 默认的实现类是 XMLLanguageDriver,由它调用 DefaultParameterHandler 中的构造方法完成 ParameterHandler 的创建工作

  1. public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {

  2. return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);

  3. }


  4. public DefaultParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {

  5. this.mappedStatement = mappedStatement;

  6. this.configuration = mappedStatement.getConfiguration();

  7. // 获取 TypeHandlerRegistry 注册

  8. this.typeHandlerRegistry = mappedStatement.getConfiguration().getTypeHandlerRegistry();

  9. this.parameterObject = parameterObject;

  10. this.boundSql = boundSql;

  11. }

上面的流程是创建 ParameterHandler 的过程,创建完成之后,该进行具体的解析工作,那么 ParameterHandler 如何解析SQL中的参数呢?SQL中的参数从哪里来的?

ParameterHandler 中的参数从何而来

你可能知道 Parameter 中的参数是怎么来的,无非就是从 Mapper 配置文件中映射过去的啊,就比如如下例子

参数肯定就是图中标红的 1 ,然后再传到XML对应的 SQL 语句中,用 #{} 或者 ${} 来进行赋值啊,

嗯,你讲的没错,可是你知道这个参数是如何映射过来的吗?或者说你知道 Parameter 的解析过程吗?或许你不是很清晰了,我们下面就来探讨一下 ParameterHandler 对参数的解析,这其中涉及到 MyBatis 中的动态代理模式

在MyBatis 中,当 deptDao.findByDeptNo(1) 将要执行的时候,会被 JVM 进行拦截,交给 MyBatis 中的代理实现类 MapperProxy 的 invoke 方法中,这也是执行 SQL 语句的主流程。

然后交给 Executor 、StatementHandler进行对应的参数解析和执行,因为是带参数的 SQL 语句,最终会创建 PreparedStatement 对象并创建参数解析器进行参数解析

SimpleExecutor.java

handler.parameterize(stmt) 最终会调用到 DefaultParameterHandler 中的 setParameters 方法,我在源码上做了注释,为了方便拷贝,我没有采用截图的形式

  1. public void setParameters(PreparedStatement ps) {

  2. ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());

  3. // parameterMappings 就是对 #{} 或者 ${} 里面参数的封装

  4. List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();

  5. if (parameterMappings != null) {

  6. // 如果是参数化的SQL,便需要循环取出并设置参数的值

  7. for (int i = 0; i < parameterMappings.size(); i++) {

  8. ParameterMapping parameterMapping = parameterMappings.get(i);

  9. // 如果参数类型不是 OUT ,这个类型与 CallableStatementHandler 有关

  10. // 因为存储过程不存在输出参数,所以参数不是输出参数的时候,就需要设置。

  11. if (parameterMapping.getMode() != ParameterMode.OUT) {

  12. Object value;

  13. // 得到#{} 中的属性名

  14. String propertyName = parameterMapping.getProperty();

  15. // 如果 propertyName 是 Map 中的key

  16. if (boundSql.hasAdditionalParameter(propertyName)) { // issue #448 ask first for additional params

  17. // 通过key 来得到 additionalParameter 中的value值

  18. value = boundSql.getAdditionalParameter(propertyName);

  19. }

  20. // 如果不是 additionalParameters 中的key,而且传入参数是 null, 则value 就是null

  21. else if (parameterObject == null) {

  22. value = null;

  23. }

  24. // 如果 typeHandlerRegistry 中已经注册了这个参数的 Class对象,即它是Primitive 或者是String 的话

  25. else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {

  26. value = parameterObject;

  27. } else {

  28. // 否则就是 Map

  29. MetaObject metaObject = configuration.newMetaObject(parameterObject);

  30. value = metaObject.getValue(propertyName);

  31. }

  32. // 在通过SqlSource 的parse 方法得到parameterMappings 的具体实现中,我们会得到parameterMappings的typeHandler

  33. TypeHandler typeHandler = parameterMapping.getTypeHandler();

  34. // 获取typeHandler 的jdbc type

  35. JdbcType jdbcType = parameterMapping.getJdbcType();

  36. if (value == null && jdbcType == null) {

  37. jdbcType = configuration.getJdbcTypeForNull();

  38. }

  39. try {

  40. typeHandler.setParameter(ps, i + 1, value, jdbcType);

  41. } catch (TypeException e) {

  42. throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);

  43. } catch (SQLException e) {

  44. throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);

  45. }

  46. }

  47. }

  48. }

  49. }

ParameterHandler 解析

我们在 MyBatis核心配置综述之StatementHandler 一文中了解到 Executor 管理的是 StatementHandler 对象的创建以及参数赋值,那么我们的主要入口还是 Executor 执行器

下面用一个流程图表示一下 ParameterHandler 的解析过程,以简单执行器为例

像是 doQuery, doUpdate, doQueryCursor等方法都会先调用到

  1. // 生成 preparedStatement 并调用 prepare 方法,并为参数赋值

  2. private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {

  3. Statement stmt;

  4. Connection connection = getConnection(statementLog);

  5. stmt = handler.prepare(connection, transaction.getTimeout());

  6. handler.parameterize(stmt);

  7. return stmt;

  8. }

然后在生成 preparedStatement 调用 DefaultParameterHandler进行参数赋值。



往期精彩回顾:

spring 注解编程之注解属性别名与覆盖

分布式下必备神器之分布式锁


于加入知识星球的同学提供基本的福利:

文章有疑问的地方可以提问,其他工作问题都可以提问出来,作者免费作答。

 https://t.zsxq.com/Y3fYny7


每周都有大牛分享一些面试题,和面试注意的知识点!

 https://t.zsxq.com/2bufE2v


每周由Java极客技术独家编制的设计模式与大家分享!

 https://t.zsxq.com/3bUNbEI


每两周还会分享一个话题,和大家一起成长!

 https://t.zsxq.com/BI6Unm2


还有Java极客技术团队亲自录制了一套 Spring Boot 视频,这套视频加密,加密后放到云盘上,下载链接加密之后,一机一码,每个星球的用户一个播放授权码。

 

我们做知识星球的目的和其他星主一样,就是为了帮助大家一起更好的成长,与高手拉近距离,减少差距,其实你也是高手!

前1000人,50元/每年,现在大约还剩不到300个名额。

长按二维码


    您可能也对以下帖子感兴趣

    文章有问题?点此查看未经处理的缓存