Mybatis之结果处理器

前言

在上文Mybatis之方法如何映射到XML中讲到需要实例化SqlCommand和MethodSignature两个类，在MethodSignature初始化的时候有一个resultHandlerIndex的参数用来指定是否设置了ResultHandler参数，本文将重点ResultHandler如何使用，分析如何触发的以及如何自定义结果处理器。

使用结果处理器

首先看一下Mybatis提供的结果处理器接口类ResultHandler：

public interface ResultHandler {

  void handleResult(ResultContext resultContext);

}

还是比较简单的，就只有一个handleResult的方法，方法参数是ResultContext里面存放了正常执行sql的结果，这里的结果处理器其实就是对结果进行二次加工处理；Mybatis提供了两个默认的处理器分别是：DefaultResultHandler和DefaultMapResultHandler，分别处理list和map，下面看一下是如何使用这两个处理器的：

    public static void selectHandler(SqlSession session, Configuration configuration) {
        BlogMapper mapper = session.getMapper(BlogMapper.class);
        //DefaultResultHandler内置结果处理器
        DefaultResultHandler defaultHandler = new DefaultResultHandler();
        mapper.selectBlogsByHandler("zhaohui", defaultHandler);
        System.out.println(defaultHandler.getResultList());

        //DefaultMapResultHandler内置结果处理器
        DefaultMapResultHandler defaultMapResultHandler = new DefaultMapResultHandler("id",
                configuration.getObjectFactory(), configuration.getObjectWrapperFactory(),
                configuration.getReflectorFactory());
        mapper.selectBlogsByHandler("zhaohui", defaultMapResultHandler);
        System.out.println(defaultMapResultHandler.getMappedResults());
    }

上面的实例分别使用了两个内置处理器，分别处理获取到的相同结果；map处理器指定了id作为key；下面再看一下BlogMapper中的selectBlogsByHandler：

public void selectBlogsByHandler(String author, ResultHandler handler);


        select * from blog where author = #{author}

上面唯一要注意的点就是selectBlogsByHandler的返回值void类型，不然结果处理器是不会触发处理结果的，这个后面再分析为什么；看一下输出结果：

[Blog [id=159, title=hello java, author=zhaohui, content=hello java666], Blog [id=160, title=hello java, author=zhaohui, content=hello java666]]
{160=Blog [id=160, title=hello java, author=zhaohui, content=hello java666], 159=Blog [id=159, title=hello java, author=zhaohui, content=hello java666]}

处理流程

首先我们需要了解结果处理器在什么情况下才会被触发，其次再看什么时候被调用的，最后我们在分析一下内置的处理器什么时候被使用的；

1.触发条件

上一节中提到需要指定void返回类型，主要原因可以查看MapperMethod的execute方法，MapperMethod在Mybatis之方法如何映射到XML中是有介绍的，重点讲到了SqlCommand和MethodSignature类，下面看一下execute方法部分代码：

public Object execute(SqlSession sqlSession, Object[] args) {
    Object result;
    switch (command.getType()) {
      ...省略...
      case SELECT:
        if (method.returnsVoid() && method.hasResultHandler()) {
          executeWithResultHandler(sqlSession, args);
          result = null;
        } 
      ...省略...
    return result;
  }

可以看到什么情况下才会调用结果处理器有三个要求：
1.首先必须是查询命令，其他的增删改是没有结果处理器的；
2.其次是方法的返回值必须是void，这其实也好理解，如果本身方法就有返回值，结果处理器也有返回值，反而容易搞混；
3.必须要有结果处理器，这个肯定是必须的，没有也别谈结果处理器了。

2.何时调用

具体何时调用我们自己的结果处理器，相关处理主要在DefaultResultSetHandler中，也就是在处理结果映射的时候，更多可以参考Mybatis之XML如何映射到方法，在主方法handleResultSets中调用的handleResultSet方法：

 private void handleResultSet(ResultSetWrapper rsw, ResultMap resultMap, List