MapperMethod

---

title:MapperMethod
date:2017年11月25日22:20:53
categories:Mybatis

---

---

我们接着上面继续分析

@Test
    public void testSelect() {
        SqlSession session = null;
        try {
            session = MybatisUtil.getCurrentSession();
            UserDao userDao = session.getMapper(UserDao.class);
            List list = new ArrayList();
            list.add(1);
            list.add(3);
            list.add(25);

            List userList = userDao.queryList(list);
            System.out.println(JSON.toJSONString(userList));

        } catch (Exception e) {
            // TODO: handle exception
        } finally {
            if (session != null)
                session.close();
        }
    }

我们都这一句代码进行DEBUG

            List userList = userDao.queryList(list);

首先，我们会进入MapperProxy这个类

  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
       //如果方法是Object类自带的方法，比如没有被重写的equals toString, hashcode 等，还是执行原来的方法
    // getDeclaringClass()返回表示声明由此 Method 对象表示的方法的类或接口的 Class 对象。
    if (Object.class.equals(method.getDeclaringClass())) {
      try {
        return method.invoke(this, args);
      } catch (Throwable t) {
        throw ExceptionUtil.unwrapThrowable(t);
      }
    }
    //如果不是object的自带方法，先去  Map methodCache中找是否已经存在这个method了，没有就将method封装成MapperMethod存进mehtodCache中然后返回MapperMethod。

    final MapperMethod mapperMethod = cachedMapperMethod(method);
    //然后执行MapprMehtod的execute方法
    return mapperMethod.execute(sqlSession, args);
  }

我们看看cachedMapperMethod

  private MapperMethod cachedMapperMethod(Method method) {
  //当method是第一次调用时,我们无法在methodCache中得到MapperMethod,我们就得新创建一个MapperMethod
    MapperMethod mapperMethod = methodCache.get(method);
    if (mapperMethod == null) {
      //创建一个MapperMethod,这里是关键。
      mapperMethod = new MapperMethod(mapperInterface, method, sqlSession.getConfiguration());
      methodCache.put(method, mapperMethod);
    }
    return mapperMethod;
  }

终于到了我们重点要讲解的MapperMethod类了

我们先看MapperMethod构造方法，初始化了他的两个属性，command和method

public MapperMethod(Class mapperInterface, Method method, Configuration config) {
    this.command = new SqlCommand(config, mapperInterface, method);
    this.method = new MethodSignature(config, method);
  }

这两个属性非常的重要，要详细的介绍的话需要大量的篇幅，所以先放在一旁。

我们先看具体的执行方法execute

 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));
    } 
   //很明显我们的SqlCommandType是SELECT类型
   else if (SqlCommandType.SELECT == command.getType()) {
     //是否返回类型是void类型并且Method参数列表中包含resultHandler,具体的判断在文末分析
      if (method.returnsVoid() && method.hasResultHandler()) {
        executeWithResultHandler(sqlSession, args);
        result = null;
      } 
     //我们调用的方法的返回类型是List，会走这个分支。我们看下method.returnsMany的具体实现吧。
     //这里的method是MapperMethod的属性MethodSignature对象
     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;
  }

executeForMany

  private  Object executeForMany(SqlSession sqlSession, Object[] args) {
    List result;
    //这个方法我们非常有必要分析一下,这个方法封装了我们调用的Mapper接口Method的参数列表对应实参
    Object param = method.convertArgsToSqlCommandParam(args);
    if (method.hasRowBounds()) {
      RowBounds rowBounds = method.extractRowBounds(args);
   //终于到了我们的DefaultSqlSession的方法了
      result = sqlSession.selectList(command.getName(), param, rowBounds);
    } else {
      result = sqlSession.selectList(command.getName(), param);
    }
    // issue #510 Collections & arrays support
    if (!method.getReturnType().isAssignableFrom(result.getClass())) {
      if (method.getReturnType().isArray()) {
        return convertToArray(result);
      } else {
        return convertToDeclaredCollection(sqlSession.getConfiguration(), result);
      }
    }
    return result;
  }

convertArgsToSqlCommandParam

public Object convertArgsToSqlCommandParam(Object[] args) {

      final int paramCount = params.size();
   //没有参数 
   if (args == null || paramCount == 0) {
        return null;
      } 
   //有一个参数，而且不是@Param注解修饰的参数
   else if (!hasNamedParameters && paramCount == 1) {
     //直接返回形参对应的实参
        return args[params.keySet().iterator().next()];
      }
   /*
   否则
   多个参数或者一个参数但是使用@param注解
   就要按以下方法操作
   */

   else {
        final Map param = new ParamMap