Mybatis源码解析二(请求处理过程解析)

最新推荐文章于 2022-09-20 15:59:38 发布

AnEra

最新推荐文章于 2022-09-20 15:59:38 发布

阅读量262

点赞数 1

分类专栏： # Mybatis源码解析文章标签： Mybatis

本文链接：https://blog.csdn.net/qq_38975553/article/details/103513327

版权

Mybatis源码解析专栏收录该内容

5 篇文章 0 订阅

订阅专栏

测试示例:

package com.lic.ibatis.test;

import com.lic.ibatis.dao.UserMapper;
import com.lic.ibatis.entity.User;
import org.apache.ibatis.binding.MapperProxy;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.Reader;

public class MybatisHelloWorld2 {
  public static void main(String[] args) {
    try {
      Reader reader = Resources.getResourceAsReader("Configuration.xml");
      SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
      SqlSession session = sqlSessionFactory.openSession();
      try {
        UserMapper userMapper = session.getMapper(UserMapper.class);
        /**
         * {@link MapperProxy#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])}
         */
        User user = userMapper.getUserById(1);
        System.out.println(user.toString());
      } finally {
        session.close();
      }

    } catch (IOException e) {
      e.printStackTrace();
    }
  }
}

控制台输出:

User{id='1', username='王五', birthday='2014-07-10', sex='2', address='北京'}

分析:

获取SqlSessionFactory
获取SqlSession
通过SqlSession获取Mapper实例
通过实例对象调用指定对象获取数据

问题: mybatis是怎样实现仅通过调用Mapper接口方法就可以执行到mapper.xml中sql的?

图解:

源码分析入口一:

UserMapper userMapper = session.getMapper(UserMapper.class)

DefaultSqlSession#getMapper()方法实现:

@Override
  public <T> T getMapper(Class<T> type) {
    return configuration.getMapper(type, this);
  }

Configuration#getMapper()方法实现:

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    return mapperRegistry.getMapper(type, sqlSession);
  }

MapperRegistry#getMapper()方法实现:

public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    //根据类型获取MapperProxyFactory代理(在解析时通过addMapper()方法添加到knownMappers集合中)
    final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
    if (mapperProxyFactory == null) {
      throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
    }
    try {
      return mapperProxyFactory.newInstance(sqlSession);
    } catch (Exception e) {
      throw new BindingException("Error getting mapper instance. Cause: " + e, e);
    }
  }

分析:

根据接口类型获取MapperProxyFactory代理(在解析时通过addMapper()方法添加到knownMappers集合中)
使用mapperProxyFactory创建代理对象, 并返回

MapperProxyFactory#newInstance(org.apache.ibatis.session.SqlSession)方法实现:

  public T newInstance(SqlSession sqlSession) {
    final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession, mapperInterface, methodCache);
    return newInstance(mapperProxy);
  }


  @SuppressWarnings("unchecked")
  protected T newInstance(MapperProxy<T> mapperProxy) {
    return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
  }

源码分析入口二:

User user = userMapper.getUserById(1)

实际上调用的是:

MapperProxy#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])

MapperProxy#invoke()方法实现:

  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      //判断method是否是属于Object类，如果是则直接执行
      if (Object.class.equals(method.getDeclaringClass())) {
        return method.invoke(this, args);
      } else if (method.isDefault()) {
        if (privateLookupInMethod == null) {
          return invokeDefaultMethodJava8(proxy, method, args);
        } else {
          return invokeDefaultMethodJava9(proxy, method, args);
        }
      }
    } catch (Throwable t) {
      throw ExceptionUtil.unwrapThrowable(t);
    }
    /**
     * 获取method对应的MapperMethod封装
     */
    final MapperMethod mapperMethod = cachedMapperMethod(method);
    /**
     * 执行该方法对象
     */
    return mapperMethod.execute(sqlSession, args);
  }

分析 (使用代理类创建接口的实现类,以及重写相关方法):

判断method是否是属于Object类，如果是则直接执行
获取method对应的MapperMethod封装
执行该方法对象

MapperMethod#execute()方法实现:

public Object execute(SqlSession sqlSession, Object[] args) {
    Object result;
    switch (command.getType()) {
      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:
        if (method.returnsVoid() && method.hasResultHandler()) {
          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);
          /**
           * 
           */
          result = sqlSession.selectOne(command.getName(), param);
          if (method.returnsOptional()
              && (result == null || !method.getReturnType().equals(result.getClass()))) {
            result = Optional.ofNullable(result);
          }
        }
        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;
  }

分析: 根据MapperMethod调用sqlSession中封装的Sql方法

SqlSession#selectOne(java.lang.String, java.lang.Object)方法实现:

  @Override
  public <T> T selectOne(String statement, Object parameter) {
    List<T> list = this.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;
    }
  }

DefaultSqlSession#selectList()方法实现:

  @Override
  public <E> List<E> selectList(String statement, Object parameter) {
    return this.selectList(statement, parameter, RowBounds.DEFAULT);
  }


  @Override
  public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
    try {
      //1. 获取根据statement(接口路径 + 方法名称)获取MappedStatement实例
      MappedStatement ms = configuration.getMappedStatement(statement);
      /**
       * 调用执行器的query方法进行查询
       * {@link CachingExecutor#query(MappedStatement,Object, RowBounds, ResultHandler)}
       */
      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();
    }
  }

分析:

获取根据statement(接口路径 + 方法名称)获取MappedStatement实例
调用缓存执行器的query方法进行查询

CachingExecutor#query()方法实现:

  @Override
  public <E> List<E> query(MappedStatement ms, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler) throws SQLException {
    // 将sql语句与参数封装在BoundSql实例中
    BoundSql boundSql = ms.getBoundSql(parameterObject);
    /**
     * 创建缓存key值, 用于存储此次查询的结果
     *
     * CacheKey组成:
     *  1. statementId
     *  2. 要求的查询结果集的范围（RowBounds的offset和limit）
     *  3. 传给statement的sql语句
     *  4. 传给statement的参数集
     */
    CacheKey key = createCacheKey(ms, parameterObject, rowBounds, boundSql);
    return query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

分析:

CacheKey组成:

statementId
要求的查询结果集的范围（RowBounds的offset和limit）
传给statement的sql语句
传给statement的参数集

CachingExecutor#query()方法实现:

  @Override
  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) {
          /**
           * 如果没有从头缓存中获取到数据,则从数据库中查询
           * {@link BaseExecutor#query(MappedStatement, Object, RowBounds, ResultHandler, CacheKey,BoundSql)}
           */
          list = delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
          //将查询后的数据加入缓存
          tcm.putObject(cache, key, list); // issue #578 and #116
        }
        return list;
      }
    }
    //如果缓存为空, 则去数据库里面查询
    /**
     * {@link BaseExecutor#query(MappedStatement,Object, RowBounds, ResultHandler,CacheKey, BoundSql)}
     */
    return delegate.query(ms, parameterObject, rowBounds, resultHandler, key, boundSql);
  }

分析:

尝试获取二级缓存
如果获取到二级缓存,则尝试从缓存根据cacheKey获取数据
如果获取到数据,则直接返回, 如果没有获取到,则调用BaseExecutor执行器从数据库获取
如果没有获取到二级缓存, 则直接调用BaseExecutor执行器从数据库获取

BaseExecutor#query()方法实现:

  @SuppressWarnings("unchecked")
  @Override
  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++;
      //尝试从一级缓存中获取数据
      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);
      }
    } finally {
      queryStack--;
    }
    if (queryStack == 0) {
      for (DeferredLoad deferredLoad : deferredLoads) {
        deferredLoad.load();
      }
      // issue #601
      deferredLoads.clear();
      if (configuration.getLocalCacheScope() == LocalCacheScope.STATEMENT) {
        // issue #482
        clearLocalCache();
      }
    }
    return list;
  }

分析:

尝试从一级缓存中获取数据
如果没有从一级缓存中获取数据, 则从数据库中查询数据

BaseExecutor#queryFromDatabase()方法实现:

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 {
      /**
       * {@link SimpleExecutor#doQuery(MappedStatement,Object, RowBounds, ResultHandler, BoundSql)}
       */
      list = doQuery(ms, parameter, rowBounds, resultHandler, boundSql);
    } finally {
      //将EXECUTION_PLACEHOLDER移除, 等下将查询到的数据加入缓存
      localCache.removeObject(key);
    }
    localCache.putObject(key, list);
    if (ms.getStatementType() == StatementType.CALLABLE) {
      localOutputParameterCache.putObject(key, parameter);
    }
    return list;
  }

SimpleExecutor#doQuery()方法实现:

  @Override
  public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
    Statement stmt = null;
    try {
      Configuration configuration = ms.getConfiguration();
      StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, resultHandler, boundSql);
      stmt = prepareStatement(handler, ms.getStatementLog());
      /**
       * {@link SimpleStatementHandler#query(Statement, ResultHandler)}
       */
      return handler.query(stmt, resultHandler);
    } finally {
      closeStatement(stmt);
    }
  }

PreparedStatementHandler#query()方法实现:

  @Override
  public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
    PreparedStatement ps = (PreparedStatement) statement;
    //执行SQL
    ps.execute();
   /**
     * 对结果集进行解析
     * {@link DefaultResultSetHandler#handleResultSets(java.sql.Statement)}
     */
    return resultSetHandler.handleResultSets(ps);
  }

DefaultResultSetHandler#handleResultSets()方法实现:

  @Override
  public List<Object> handleResultSets(Statement stmt) throws SQLException {
    ErrorContext.instance().activity("handling results").object(mappedStatement.getId());

    final List<Object> multipleResults = new ArrayList<>();

    int resultSetCount = 0;
    ResultSetWrapper rsw = getFirstResultSet(stmt);

    List<ResultMap> resultMaps = mappedStatement.getResultMaps();
    int resultMapCount = resultMaps.size();
    validateResultMapsCount(rsw, resultMapCount);
    while (rsw != null && resultMapCount > resultSetCount) {
      ResultMap resultMap = resultMaps.get(resultSetCount);
      handleResultSet(rsw, resultMap, multipleResults, null);
      rsw = getNextResultSet(stmt);
      cleanUpAfterHandlingResultSet();
      resultSetCount++;
    }

    String[] resultSets = mappedStatement.getResultSets();
    if (resultSets != null) {
      while (rsw != null && resultSetCount < resultSets.length) {
        ResultMapping parentMapping = nextResultMaps.get(resultSets[resultSetCount]);
        if (parentMapping != null) {
          String nestedResultMapId = parentMapping.getNestedResultMapId();
          ResultMap resultMap = configuration.getResultMap(nestedResultMapId);
          handleResultSet(rsw, resultMap, null, parentMapping);
        }
        rsw = getNextResultSet(stmt);
        cleanUpAfterHandlingResultSet();
        resultSetCount++;
      }
    }

    return collapseSingleResultList(multipleResults);
  }

Mybatis源码解析二(请求处理过程解析)

Mybatis源码解析三(模拟Mybatis)

AnEra

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Mybatis源码解析二(请求处理过程解析)

测试示例:package com.lic.ibatis.test;import com.lic.ibatis.dao.UserMapper;import com.lic.ibatis.entity.User;import org.apache.ibatis.binding.MapperProxy;import org.apache.ibatis.io.Resources;imp...
复制链接

扫一扫