Mybatis 시리즈 심층 설명(10)---SQL 실행 프로세스 분석(소스 코드)

최근 너무 바빠서 블로그 업데이트를 계속할 시간이 없었습니다. 오늘은 바쁜 일정을 잠시 쉬고 마이바티스 학습 여정을 이어갔습니다. 처음 9개의 기사에서는 mybatis의 구성 및 사용 방법을 소개했으므로 이번 기사에서는 mybatis의 소스 코드에 들어가 mybatis의 실행 과정을 분석해 보겠습니다.

1. SqlSessionFactory 및 SqlSession.

이전 장에서 mybatis를 소개하고 사용함으로써 누구나 SqlSession의 중요성을 표면적으로 인식할 수 있습니다. 우리는 모두 SqlSession을 통해 SQL 문을 실행합니다(참고: 이는 표면적으로만 설명한 것이므로 실제 상황은 나중에 설명합니다). 그럼 먼저 SqlSession을 얻는 방법을 살펴보겠습니다.

(1) 먼저 SqlSessionFactoryBuilder는 mybatis의 구성 파일을 읽고, 그런 다음 DefaultSqlSessionFactory를 빌드합니다. 소스 코드는 다음과 같습니다.

/**
   * 一系列的构造方法最终都会调用本方法（配置文件为Reader时会调用本方法，还有一个InputStream方法与此对应）
   * @param reader
   * @param environment
   * @param properties
   * @return   */
  public SqlSessionFactory build(Reader reader, String environment, Properties properties) {    
  try {      //通过XMLConfigBuilder解析配置文件，解析的配置相关信息都会封装为一个Configuration对象
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);      
      //这儿创建DefaultSessionFactory对象
      return build(parser.parse());
    } catch (Exception e) {      
    throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();      
      try {
        reader.close();
      } catch (IOException e) {        
      // Intentionally ignore. Prefer previous error.      }
    }
  }  public SqlSessionFactory build(Configuration config) {    
  return new DefaultSqlSessionFactory(config);
  }

(2) SqlSessionFactory를 얻은 후 SqlSessionFactory를 통해 SqlSession 객체를 얻을 수 있습니다. 소스 코드는 다음과 같습니다.

/**
   * 通常一系列openSession方法最终都会调用本方法
   * @param execType 
   * @param level
   * @param autoCommit
   * @return
   */
  private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    Transaction tx = null;    try {      
    //通过Confuguration对象去获取Mybatis相关配置信息, Environment对象包含了数据源和事务的配置
      final Environment environment = configuration.getEnvironment();      
      final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
      tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);      
      //之前说了，从表面上来看，咱们是用sqlSession在执行sql语句， 实际呢，其实是通过excutor执行， excutor是对于Statement的封装
      final Executor executor = configuration.newExecutor(tx, execType);      
      //关键看这儿，创建了一个DefaultSqlSession对象
      return new DefaultSqlSession(configuration, executor, autoCommit);
    } catch (Exception e) {
      closeTransaction(tx); // may have fetched a connection so lets call close()
      throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

위 단계를 통해 SqlSession 개체를 얻었습니다. 다음 단계는 수행해야 하는 모든 작업을 수행하는 것입니다(물론 SQL 문 실행 등 다른 작업을 수행할 수 있음). 위 내용을 읽고나서 우리가 예전에 썼던 Demo도 떠올려보자,

아아아아

정말 이렇죠?

SqlSession도 얻었습니다. SqlSession에서 일련의 select..., insert..., update..., delete... 메소드를 호출하여 CRUD 작업을 쉽게 수행할 수 있습니다네. 그게 다야? 그렇다면 우리가 구성한 매핑 파일은 어디에 있습니까? 걱정하지 마세요. 계속 읽어보세요.

2. 날카로운 도구 MapperProxy:

mybatis에서는 MapperProxy를 통해 dao를 동적으로 프록시합니다. 즉, 우리가 작성한 dao에서 메서드를 실행할 때 해당 mapperProxy가 실제로 프록시 역할을 합니다. 그래서 MapperProxy 개체를 가져오는 방법을 살펴보겠습니다.

(1) SqlSession을 통해 Configuration에서 를 가져옵니다. 소스 코드는 다음과 같습니다.

SqlSessionFactory sessionFactory = null;  
String resource = "mybatis-conf.xml";  
try {
     //SqlSessionFactoryBuilder读取配置文件
    sessionFactory = new SqlSessionFactoryBuilder().build(Resources  
              .getResourceAsReader(resource));
} catch (IOException e) {  
    e.printStackTrace();  
}    //通过SqlSessionFactory获取SqlSessionSqlSession sqlSession = sessionFactory.openSession();

(2) SqlSession은 부담을 Configuration에 덤프하고 다음에는 Configuration을 살펴보겠습니다. 소스 코드는 다음과 같습니다.

/**
   * 什么都不做，直接去configuration中找， 哥就是这么任性   */
  @Override  public <t> T getMapper(Class<t> type) {    
  return configuration.<t>getMapper(type, this);
  }</t></t></t>

(3) 구성에서는 이 뜨거운 감자를 원하지 않고 MapperRegistry에 덤프합니다. MapperRegistry를 살펴보세요. 소스코드는 다음과 같습니다:

/**
   * 烫手的山芋，俺不要，你找mapperRegistry去要
   * @param type
   * @param sqlSession
   * @return
   */
  public <t> T getMapper(Class<t> type, SqlSession sqlSession) {    
  return mapperRegistry.getMapper(type, sqlSession);
  }</t></t>

(4)MapperProxyFactory是个苦B的人，粗活最终交给它去做了。咱们看看源码：

/**
   * 别人虐我千百遍，我待别人如初恋
   * @param mapperProxy
   * @return
   */
  @SuppressWarnings("unchecked")  protected T newInstance(MapperProxy<t> mapperProxy) {    
  //动态代理我们写的dao接口
    return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
  }  
  public T newInstance(SqlSession sqlSession) {    
  final MapperProxy<t> mapperProxy = new MapperProxy<t>(sqlSession, mapperInterface, methodCache);    
  return newInstance(mapperProxy);
  }</t></t></t>

通过以上的动态代理，咱们就可以方便地使用dao接口啦， 就像之前咱们写的demo那样：

 UserDao userMapper = sqlSession.getMapper(UserDao.class);  
 User insertUser = new User();

这下方便多了吧， 呵呵， 貌似mybatis的源码就这么一回事儿啊。

别急，还没完， 咱们还没看具体是怎么执行sql语句的呢。

 

3. Excutor:

接下来，咱们才要真正去看sql的执行过程了。

上面，咱们拿到了MapperProxy, 每个MapperProxy对应一个dao接口， 那么咱们在使用的时候，MapperProxy是怎么做的呢？ 源码奉上：

MapperProxy:

/**
   * MapperProxy在执行时会触发此方法   */
  @Override  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {   
   if (Object.class.equals(method.getDeclaringClass())) {      
  try {        
  return method.invoke(this, args);
      } catch (Throwable t) {       
       throw ExceptionUtil.unwrapThrowable(t);
      }
    }    final MapperMethod mapperMethod = cachedMapperMethod(method);    
    //二话不说，主要交给MapperMethod自己去管
    return mapperMethod.execute(sqlSession, args);
  }

MapperMethod:

 /**
   * 看着代码不少，不过其实就是先判断CRUD类型，然后根据类型去选择到底执行sqlSession中的哪个方法，绕了一圈，又转回sqlSession了
   * @param sqlSession
   * @param args
   * @return
   */
  public Object execute(SqlSession sqlSession, Object[] args) {
    Object result;    if (SqlCommandType.INSERT == command.getType()) {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.insert(command.getName(), param));
    } else if (SqlCommandType.UPDATE == command.getType()) {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.update(command.getName(), param));
    } else if (SqlCommandType.DELETE == command.getType()) {
      Object param = method.convertArgsToSqlCommandParam(args);
      result = rowCountResult(sqlSession.delete(command.getName(), param));
    } else if (SqlCommandType.SELECT == command.getType()) {      
    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 {
        Object param = method.convertArgsToSqlCommandParam(args);
        result = sqlSession.selectOne(command.getName(), param);
      }
    } else {      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;
  }

既然又回到SqlSession了， 那么咱们就看看SqlSession的CRUD方法了，为了省事，还是就选择其中的一个方法来做分析吧。这儿，咱们选择了selectList方法：

public <e> List<e> selectList(String statement, Object parameter, RowBounds rowBounds) {    
try {
      MappedStatement ms = configuration.getMappedStatement(statement);      
      //CRUD实际上是交给Excetor去处理， excutor其实也只是穿了个马甲而已，小样，别以为穿个马甲我就不认识你嘞！
      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();
    }
  }</e></e>

然后，通过一层一层的调用，最终会来到doQuery方法， 这儿咱们就随便找个Excutor看看doQuery方法的实现吧，我这儿选择了SimpleExecutor:

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());      
      //StatementHandler封装了Statement, 让 StatementHandler 去处理
      return handler.<e>query(stmt, resultHandler);
    } finally {
      closeStatement(stmt);
    }
  }</e></e></e>

接下来，咱们看看StatementHandler 的一个实现类 PreparedStatementHandler（这也是我们最常用的，封装的是PreparedStatement）, 看看它使怎么去处理的：

public <e> List<e> query(Statement statement, ResultHandler resultHandler) throws SQLException {     
//到此，原形毕露， PreparedStatement, 这个大家都已经滚瓜烂熟了吧
    PreparedStatement ps = (PreparedStatement) statement;
    ps.execute();    
    //结果交给了ResultSetHandler 去处理
    return resultSetHandler.<e> handleResultSets(ps);
  }</e></e></e>

到此， 一次sql的执行流程就完了。 我这儿仅抛砖引玉，建议有兴趣的去看看Mybatis3的源码。

好啦，本次就到此结束啦，最近太忙了， 又该忙去啦。

 以上就是深入浅出Mybatis系列（十）---SQL执行流程分析（源码篇）的内容，更多相关内容请关注PHP中文网（www.php.cn）！