MyBATIS插件原理第二篇 Mapper运行原理

最新推荐文章于 2024-10-02 14:14:03 发布

lppl010_

最新推荐文章于 2024-10-02 14:14:03 发布

阅读量190

点赞数

分类专栏： mybatis

mybatis 专栏收录该内容

16 篇文章

订阅专栏

本文解析了MyBIS如何利用动态代理实现接口调用，重点介绍了MapperProxy和MapperMethod类的工作原理，揭示了仅使用Mapper接口即可执行SQL的秘密。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

https://blog.youkuaiyun.com/ykzhen2015/article/details/50314509

我们目前在MyBATIS中，我们知道MyBATIS的Mapper是一个接口，而不是一个实体类。在Java中接口是没有办法运行的。那么它是怎么运行的呢？

有了第一篇的基础，我们可以大胆的想象——它是通过动态代理运行，没有错真实的情况就是这样的。

让我们看看mybatis是怎么实现这个动态代理的：

[java]view plain copy
/** 
 *    Copyright 2009-2015 the original author or authors. 
 * 
 *    Licensed under the Apache License, Version 2.0 (the "License"); 
 *    you may not use this file except in compliance with the License. 
 *    You may obtain a copy of the License at 
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0 
 * 
 *    Unless required by applicable law or agreed to in writing, software 
 *    distributed under the License is distributed on an "AS IS" BASIS, 
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 *    See the License for the specific language governing permissions and 
 *    limitations under the License. 
 */  
package org.apache.ibatis.binding;  
  
import java.io.Serializable;  
import java.lang.reflect.InvocationHandler;  
import java.lang.reflect.Method;  
import java.util.Map;  
  
import org.apache.ibatis.reflection.ExceptionUtil;  
import org.apache.ibatis.session.SqlSession;  
  
/** 
 * @author Clinton Begin 
 * @author Eduardo Macarron 
 */  
public class MapperProxy<T> implements InvocationHandler, Serializable {  
  
  private static final long serialVersionUID = -6424540398559729838L;  
  private final SqlSession sqlSession;  
  private final Class<T> mapperInterface;  
  private final Map<Method, MapperMethod> methodCache;  
  
  public MapperProxy(SqlSession sqlSession, Class<T> mapperInterface, Map<Method, MapperMethod> methodCache) {  
    this.sqlSession = sqlSession;  
    this.mapperInterface = mapperInterface;  
    this.methodCache = methodCache;  
  }  
  
  @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);  
    return mapperMethod.execute(sqlSession, args);  
  }  
  
  private MapperMethod cachedMapperMethod(Method method) {  
    MapperMethod mapperMethod = methodCache.get(method);  
    if (mapperMethod == null) {  
      mapperMethod = new MapperMethod(mapperInterface, method, sqlSession.getConfiguration());  
      methodCache.put(method, mapperMethod);  
    }  
    return mapperMethod;  
  }  
  
}  

这便是mybaitis处理对象的方法，我们可以看到invoke方法。我们知道一旦mapper是一个代理对象，那么它就会运行到invoke方法里面，invoke首先判断是否一个类，显然这里mapper是一个接口，不是类所以判定失败。那么跟着就会生成MapperMethod对象，它是通过cachedMapperMethod方法对其初始化的，然后执行execute方法，把sqlSession和当前运行的参数传递进去。

于是让我们看看这个execute方法的源码：

[java]view plain copy
package org.apache.ibatis.binding;  
  
  
public class MapperMethod {  
  
  private final SqlCommand command;  
  private final MethodSignature method;  
  
  public MapperMethod(Class<?> mapperInterface, Method method, Configuration config) {  
    this.command = new SqlCommand(config, mapperInterface, method);  
    this.method = new MethodSignature(config, method);  
  }  
  
  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()) {  
        <span style="color:#FF0000;">result = executeForMany(sqlSession, args);//我们主要看看这个方法</span>  
      } else if (method.returnsMap()) {  
        result = executeForMap(sqlSession, args);  
      } else {  
        Object param = method.convertArgsToSqlCommandParam(args);  
        result = sqlSession.selectOne(command.getName(), param);  
      }  
    } else if (SqlCommandType.FLUSH == command.getType()) {  
        result = sqlSession.flushStatements();  
    } 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;  
  }  
 ........  
  //方法还是很多，我们不需要全看就看一个很常用的查询返回多条记录的  
  private <E> Object executeForMany(SqlSession sqlSession, Object[] args) {  
    List<E> result;  
    Object param = method.convertArgsToSqlCommandParam(args);  
    if (method.hasRowBounds()) {  
      RowBounds rowBounds = method.extractRowBounds(args);  
      result = sqlSession.<E>selectList(command.getName(), param, rowBounds);  
    } else {  
      <span style="color:#FF0000;">result = sqlSession.<E>selectList(command.getName(), param);</span>  
    }  
    // 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;  
  }  
  .......  
 }  