关于mybatis的执行过程的简单分析（四）

最新推荐文章于 2024-11-13 10:37:12 发布
原创 最新推荐文章于 2024-11-13 10:37:12 发布 · 357 阅读 · 2 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#mybatis #源码 #介绍

本文对MyBatis中mapper.getDepartmentById(1)方法的执行过程进行分析。该方法由动态代理执行，会根据SQL查询类型操作，解析参数后执行查询。查询先从本地缓存获取，为空则从数据库查询，还涉及创建StatementHandler等操作，最后小结了四大对象及执行过程。
第四步 也是最后一步的分析：mapper.getDepartmentById(1)

因为mapper是动态代理对象，执行getDepartmentById（1）方法时由动态代理执行，调用debug进入invoke方法
代码如下

  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      if (Object.class.equals(method.getDeclaringClass())) {//   #1
        return method.invoke(this, args);
      } else if (isDefaultMethod(method)) {
        return invokeDefaultMethod(proxy, method, args);
      }
    } catch (Throwable t) {
      throw ExceptionUtil.unwrapThrowable(t);
    }
    final MapperMethod mapperMethod = cachedMapperMethod(method);
    return mapperMethod.execute(sqlSession, args);//    #2
  }

代码#1处，先判断是否是属于Object的类的方法，如果是，那么直接返回调用。
然后执行到 代码#2处，进入这个mapperMethod.execute(sqlSession, args)方法。

public Object execute(SqlSession sqlSession, Object[] args) {
    Object result;
   /*根据其command.getType()返回对应的结果集*/
    switch (command.getType()) {         //  #1
      case INSERT: {
      Object param = method.convertArgsToSqlCommandParam(args);
        result = rowCountResult(sqlSession.insert(command.getName(), param));
        break;
      }
      case UPDATE: {
        Object param = method.convertArgsToSqlCommandParam(args);
        result = rowCountResult(sqlSession.update(command.getName(), param));
        break;
      }
      case DELETE: {
        Object param = method.convertArgsToSqlCommandParam(args);
        result = rowCountResult(sqlSession.delete(command.getName(), param));
        break;
      }
      case SELECT:                    //    #2
        if (method.returnsVoid() && method.hasResultHandler()) {  //  #3
          executeWithResultHandler(sqlSession, args);   
          result = null;
        } else if (method.returnsMany()) {   
          result = executeForMany(sqlSession, args);
        } else if (method.returnsMap()) {
          result = executeForMap(sqlSession, args);
        } else if (method.returnsCursor()) {
          result = executeForCursor(sqlSession, args);
        } else {
          Object param = method.convertArgsToSqlCommandParam(args);     //  #4
          result = sqlSession.selectOne(command.getName(), param);     //   #5
        }
        break;
      case FLUSH:
        result = sqlSession.flushStatements();
        break;
      default:
        throw new BindingException("Unknown execution method for: " + command.getName());
    }
    if (result == null && method.getReturnType().isPrimitive() && !method.returnsVoid()) {
      throw new BindingException("Mapper method '" + command.getName() 
          + " attempted to return null from a method with a primitive return type (" + method.getReturnType() + ").");
    }
    return result;
  }

代码#·1根据sql语句查询的类型，执行对应的操作，这里的command.getType()=SELECT
执行代码2

 case SELECT:                    //    #2
        if (method.returnsVoid() && method.hasResultHandler()) {  //  #3
          executeWithResultHandler(sqlSession, args);   
          result = null;
        } else if (method.returnsMany()) {   //返回结果是多个
          result = executeForMany(sqlSession, args);
        } else if (method.returnsMap()) {  	//返回结果集合是map
          result = executeForMap(sqlSession, args);
        } else if (method.returnsCursor()) { //返回结果集合是光标
          result = executeForCursor(sqlSession, args);
        } else {//我这里的查询语句是查询单个对象，所以执行这里。
          Object param = method.convertArgsToSqlCommandParam(args);     //  #4
          result = sqlSession.selectOne(command.getName(), param);     //   #5
        }

代码#4处method.convertArgsToSqlCommandParam(args)这个方法的作用是用来解析参数的，将参数sql里面的参数类型

    public Object convertArgsToSqlCommandParam(Object[] args) {
      return paramNameResolver.getNamedParams(args);
    }

getNamedParams(args) 代码如下：

  public Object getNamedParams(Object[] args) {
  //(@param stirng username ，@param int age , String  hight )
  //names是什么？是SortedMap<Integer, String> names 跟我们传入的参数的name构造出一个map{0=username,1=age,2=2} ，names的构造过程，再下一段代码
    final int paramCount = names.size();
    if (args == null || paramCount == 0) {
      return null;
    } else if (!hasParamAnnotation && paramCount == 1) {
      return args[names.firstKey()];
    } else {
      final Map<String, Object> param = new ParamMap<Object>();
      int i = 0;
      for (Map.Entry<Integer, String> entry : names.entrySet()) {
      	//有两种构造的方法{0=username,1=age,2=2}
      	//第一种{username=arg[0],age=arg[1],2=arg[2]}
        param.put(entry.getValue(), args[entry.getKey()]);
       
        final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);
        // ensure not to overwrite parameter named with @Param
        if (!names.containsValue(genericParamName)) {
        // 第二种：{param1=arg[0],param2=arg[1],param3=arg[3]}
          param.put(genericParamName, args[entry.getKey()]);
        }
        i++;
      }
      return param;
    }
  }
}

names的构造过程入下

  public ParamNameResolver(Configuration config, Method method) {
 	 //获得参数类型
    final Class<?>[] paramTypes = method.getParameterTypes();
    // 获得参数注解
    final Annotation[][] paramAnnotations = method.getParameterAnnotations();
    //构造一个map 
    final SortedMap<Integer, String> map = new TreeMap<Integer, String>();
    int paramCount = paramAnnotations.length;
    // get names from @Param annotations
    for (int paramIndex = 0; paramIndex < paramCount; paramIndex++) {
      if (isSpecialParameter(paramTypes[paramIndex])) {
        // skip special parameters
        continue;
      }
      String name = null;
      // 如果带有注解标识的 name=((Param) annotation).value(); 例如：@param String username,此时的name=username
      for (Annotation annotation : paramAnnotations[paramIndex]) {
        if (annotation instanceof Param) {
          hasParamAnnotation = true;
          name = ((Param) annotation).value();
          break;
        }
      }
      if (name == null) {
        // 如果是全局配置，那么 ：name=参数名
        if (config.isUseActualParamName()) {
          name = getActualParamName(method, paramIndex);
        }
        if (name == null) {
          // 没有标注，那么相当于name=(map.size()) 当前索引的位置{0=name,1=age,2=2}
          // 
          name = String.valueOf(map.size());
   }
      }
      //添加到map当中
      map.put(paramIndex, name);
    }

入参数被解析成map集合然后返回，执行 result = sqlSession.selectOne(command.getName(), param);

/*selectOne(command.getName(), param)*/
 @Override
  public <T> T selectOne(String statement, Object parameter) {
    // Popular vote was to return null on 0 results and throw exception on too many.
    //执行查询
    List<T> list = this.<T>selectList(statement, parameter);
    if (list.size() == 1) {
      return list.get(0);
    } else if (list.size() > 1) {
      throw new TooManyResultsException("Expected one result (or null) to be returned by selectOne(), but found: " + list.size());
    } else {
      return null;
    }
  }

selectList(statement, parameter)

  @Override
  public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
    try {
     //statement为存储在map集合当中的key:com.kuake.dao.mapper.DepartmentMapper.getDepartmentById
     //通过key拿到MappedStatement 对象
      MappedStatement ms = configuration.getMappedStatement(statement);
      //调用query方法，执行语句。
      // wrapCollection(parameter)对出入的参数进行包装，
      /*
    if (object instanceof Collection) {
      StrictMap<Object> map = new StrictMap<Object>();
      map.put("collection", object);
      if (object instanceof List) {
        map.put("list", object);
      }
      return map;
    } else if (object != null && object.getClass().isArray()) {
      StrictMap<Object> map = new StrictMap<Object>();
      map.put("array", object);
      return map;
    }
    return object;
		*/
	将传入的参数进行包装成map  List的key list   collection的key collection  Array的key array
      return executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error querying database.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

执行query()方法

  @Override
  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
  	//返回boundSql ，也就是sql语句的详细信息 下面的截图可以看到详细信息
    BoundSql boundSql = ms.getBoundSql(parameterObject);
    //创建一个缓存的key 
    CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
    return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

在这里插入图片描述
query方法的调用，

  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql)
      throws SQLException {
    Cache cache = ms.getCache();
    if (cache != null) {
      flushCacheIfRequired(ms);
      if (ms.isUseCache() && resultHandler == null) {
        ensureNoOutParams(ms, boundSql);
        @SuppressWarnings("unchecked")
        List<E> list = (List<E>) tcm.getObject(cache, key);
        if (list == null) {
          list = delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        return list;
      }
    }
    //  因为没有开启缓存 ，调用配置了的SimpleExector
    return delegate.<E> query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

** delegate. query()先从本地缓存当中获得，如果为空调用queryFromDatabase（）**

 public <E> List<E> query(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    ErrorContext.instance().resource(ms.getResource()).activity("executing a query").object(ms.getId());
    if (closed) {
      throw new ExecutorException("Executor was closed.");
    }
    if (queryStack == 0 && ms.isFlushCacheRequired()) {
      clearLocalCache();
    }
    List<E> list;
    try {
      queryStack++;
      //先从本地缓存当中获得，如果为空调用queryFromDatabase（）
      list = resultHandler == null ? (List<E>) localCache.getObject(key) : null;
      if (list != null) {
        handleLocallyCachedOutputParameters(ms, key, parameter, boundSql);
      } else {
        list = queryFromDatabase(ms, parameter, rowBounds, resultHandler, key, boundSql);
      }

** queryFromDatabase（xxx,xxx,xxx,xxx）方法如下**

  private <E> List<E> queryFromDatabase(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, CacheKey key, BoundSql boundSql) throws SQLException {
    List<E> list;
    //在本地一级缓存当中设置一个占位符
    localCache.putObject(key, EXECUTION_PLACEHOLDER);
    try {
    //执行次方法
      list = doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
    } finally {
      localCache.removeObject(key);
    }
    localCache.putObject(key, list);
    if (ms.getStatementType() == StatementType.CALLABLE) {
    //查询到结果之后，把他存入本地缓存，一级缓存当中
      localOutputParameterCache.putObject(key, parameter);
    }
    return list;
  }

执行doQuery()

  @Override
  public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
  // 这个Statement 是我们jdbc原生的Statement 
    Statement stmt = null;
    try {
    	//从MappedStatement 对象当中获得configuration 
      Configuration configuration = ms.getConfiguration();
      //创建一个newStatementHandler，1同时也会构造parameterHandler,ResultSetHandler
      StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, resultHandler, boundSql);
      stmt = prepareStatement(handler, ms.getStatementLog());
      return handler.<E>query(stmt, resultHandler);
    } finally {
    // 关闭资源
      closeStatement(stmt);
    }
  }

** configuration.newStatementHandler（）创建一个StatementHandler用于创建Statement **

创建原生jdbc的statement的prepareStatement(handler, ms.getStatementLog()) 代码如下：

  private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {
    Statement stmt;
    Connection connection = getConnection(statementLog);
    //创建Statement 对象的时候
    stmt = handler.prepare(connection, transaction.getTimeout());
    //进行参数预编译TypeHandler typeHandler = parameterMapping.getTypeHandler();设置参数。
    handler.parameterize(stmt);
    return stmt;
  }

**执行handler.query(stmt, resultHandler)**方法拿到返回结果。

  @Override
  public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
    PreparedStatement ps = (PreparedStatement) statement;
    //执行查询
    ps.execute();
    //使用resultSetHandler来解析设置查询结果
    return resultSetHandler.<E> handleResultSets(ps);
  }

其调用过程的时序图如下图所示：
在这里插入图片描述
小结一下：四大对象
Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed):执行器
ParameterHandler (getParameterObject, setParameters)：设置预编译参数用的
ResultSetHandler (handleResultSets, handleOutputParameters)：处理结果集
StatementHandler (prepare, parameterize, batch, update, query) ：处理sql语句预编译，设置参数等相关工作；

执行过程：
在这里插入图片描述

MyBatis存储过程返回值处理
AI开发架构师
04-12 978
在数据库开发中，存储过程是一种预先编译好的SQL代码块，它可以接受参数、执行特定的操作并返回结果。MyBatis是一个优秀的持久层框架，它简化了Java与数据库之间的交互。本文章的目的在于详细探讨MyBatis如何处理存储过程的返回值，范围涵盖了MyBatis与常见数据库（如MySQL、Oracle等）中存储过程的交互，以及不同类型返回值（如单值、结果集、输出参数等）的处理方法。本文将按照以下结构进行组织：首先介绍核心概念，包括存储过程和MyBatis的原理及它们之间的联系；
Mybatis 执行过程
Mr.xing的博客
04-04 1151
Mybatis执行过程、sqlsession接口源码解析
Mybatis源码解析之执行流程解析
翻身已碰头的博客
03-12 1407
Mybatis源码解析之核心类分析 Mybatis源码解析之初始化分析 本篇文章将在前两篇文章的基础上解析Mybatis执行sql的流程。 一、 映射集mappers解析 对于在原生mybatis中的sql执行，需要在配置文件中通过标签引入mapper.xml文件。前文已经提到，对于xml配置文件，mybatis在XMLConfigBuilder#parseConfiguration(Xnode)...
Mybatis – 执行流程分析（源码分析）
12-21
前言 完成了一个User表的CRUD 了解了mybatis-config.xml的配置文件标签 学会了使用日志查看sql执行过程 现在，需要仔细分析Mybatis的执行流程 执行流程 其实，从我们前面的工具类大致可以看出一下步骤 Resources ——》InputStream(解析xml)——》SqlSessionFactoryBuilder().build(inputStream)——》SqlSessionFactory——》SqlSession——》动态代理Mapper接口 package com.learn.util; import org.apache.ibatis.io.Reso
MyBatis 的执行流程，值得一看
JavaShark的博客
07-05 1363
MyBatis可能很多人都一直在用，但是MyBatis的SQL执行流程可能并不是所有人都清楚了，那么既然进来了，通读本文你将收获如下：1、Mapper接口和映射文件是如何进行绑定的2、MyBatis中SQL语句的执行流程3、自定义MyBatis中的参数设置处理器typeHandler4、自定义MyBatis中结果集处理器typeHandlerPS：本文基于MyBatis3.5.5版本源码在MyBatis中，利用编程式进行数据查询，主要就是下面几行代码： SqlSession session = sqlSes
MyBatis 源码分析 - SQL 的执行过程
dishitu6229的博客
08-20 597
* 本文速览 本篇文章较为详细的介绍了 MyBatis 执行 SQL 的过程。该过程本身比较复杂，牵涉到的技术点比较多。包括但不限于 Mapper 接口代理类的生成、接口方法的解析、SQL 语句的解析、运行时参数的绑定、查询结果自动映射、延迟加载等。本文对所列举的技术点，以及部分未列举的技术点都做了较为详细的分析。全文篇幅很大，需要大家耐心阅读。下面来看一下本文的目录： 源码分析类文章...
mybatis执行过程分析
yang_yang_6666的博客
01-14 553
装载到spring bean容器 把扫描到的mapper加载到beanfactory中BeanDefinition Map中 通过修改BeanDefinition 使用MapperProxyFactory 创建mapper的代理对象 加载到spring bean容器中 执行sql过程 通过MapperProxy代理对象调用MapperMethod 执行sql查询 public Object...
【MyBatis-Plus 源码分析】核心组件、工作流程、SQL执行过程、源码分析
好好学习日记
05-29 2775
MyBatis-Plus 是一个增强版的 MyBatis 框架，它在 MyBatis 的基础上增加了许多实用的功能，例如乐观锁插件、字段自动填充、分页插件、条件构造器和 SQL 注入器等。MyBatis-Plus 允许开发者无需编写 XML 文件，直接通过继承 BaseMapper 接口的类来完成数据库操作。MyBatis-Plus 作为 MyBatis 的增强框架，其工作流程在继承 MyBatis 的基础上进行了优化和扩展。继承 BaseMapper。
mybatis统计每条SQL的执行时间的方法示例
09-08
MyBatis允许开发者自定义插件来拦截四大对象（Executor、ParameterHandler、ResultSetHandler、StatementHandler）的执行过程。通过实现`Interceptor`接口，我们可以创建一个插件来计算SQL执行时间。以下是一个简单...
MyBatis 源码分析-- SQL请求执行流程（ Mapper 接口方法的执行的过程）
weixin_42118323的博客
06-24 1127
MapperProxy#invoke 方法会判断执行的方法是否是 Object 类的方法，如果是就无需代理，否则才会走代理的方法，代理的方法有两个默认实现 一个是普通方法 PlainMethodInvoker 和默认方法实现 DefaultMethodInvoker。CachingExecutor#query 会判断是否使用了缓存，如果允许使用缓存会先从二级缓存查询，二级缓存中查询不到才会去查询一级缓存或者数据库，如果二级缓存为空或者不允许使用缓存就会直接去查询一级缓存或者数据库。
MyBatis的执行流程分析
程序员波特
05-15 273
核心流程介绍 我们都知道 MyBatis 是对 JDBC 的封装，不管怎样，JDBC 的那一套还是不会变的，只是做了抽象、封装、归类等；所以我们顺着 JDBC 的思路来说下MyBatis的执行流程，JDBC执行六部走 注册驱动 获取Connection连接 执行预编译 执行SQL 封装结果集 释放资源 然后通过这张图来分析下MyBatis的是怎样来封装这个过程的: MyBatis执行八步走 上面中流程就是 MyBatis 内部核心流程，咱么来一步步解释下 读取 MyBatis 的核心配置文件。myb
mybatis执行过程解析
Kris0526的博客
09-01 189
一、配置文件解析 配置文件的结构 mybatis-config.xml <configuration> <properties resource="config/database.properties"/> <environments default="development"> <environment id="development"> <transactionManager type="JDB
Mybatis执行流程分析
李永志的博客
03-24 1701
对于Mybatis大家应该都很熟悉了，记得刚开始学Java的时候持久层两大框架Mybatis和Hibernate，当时我就比较喜欢Mybatis，Hibernate使用的不多，因为Mybatis的SQL语句比较自由，条理性比较清晰，当然不是说Hibernate不好，而是个人比较喜欢那种文件SQL清晰的风格，本文带大家简单回顾一下Mybatis。
Mybatis执行流程解析
qq_38167579的博客
03-21 846
目录 启动Mybatis Resources.getResourceAsStream SqlSessionFactoryBuilder.build XMLConfigBuilder.parse DefaultSqlSessionFactory.openSession Configuration.newExecutor DefaultSqlSession.getMapper 启动Mybatis 在了解mybatis的原理之前，一定得知道它是如何运行起来的，它运行的入口在哪里？回到最原始的时期
Mybatis的执行流程解析
最新发布
她们都叫我靓仔
11-13 960
Mybatis的执行流程解析
mybatis的执行流程解析
scryihao的博客
08-09 162
分为几个大模块 1.配置文件解析 2.会话创建 3.方法执行 一.配置文件解析 mybatis-config.xml <configuration> <properties/> <settting/> <typeHandlers/> <..../> <mappers/> </configuration> mybatis-mapper.xml <mapper > <cache/&g
Mybatis的简单执行流程分析
G_rainy的博客
05-24 557
Mybatis的简单执行流程分析！(小结) 执行流程总览 MyBatis的全局的初始化过程（加载全局核心配置文件） 创建会话 获取Mapper实例 从Mapper注册中心获取实例 构建Mapper代理实例 拓展：简单分析注册过程： 在读取核心配置文件config.xml时 。mapper注册器会将所有的 mapper映射 注册添加到内存【即注册中心】中， 注册 mapper 的主要作用是将 Mapper 添加到 knownMappers 集合中，实现 M
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值