Mybatis框架--动态代理源码分析

最新推荐文章于 2024-04-10 14:52:42 发布

sdzrx

最新推荐文章于 2024-04-10 14:52:42 发布

阅读量140

点赞数

分类专栏： java编程框架

本文链接：https://blog.csdn.net/weixin_42262357/article/details/98635360

版权

java编程同时被 2 个专栏收录

55 篇文章 0 订阅

订阅专栏

框架

14 篇文章 0 订阅

订阅专栏

Mybatis整体框架和运行原理图

在这里插入图片描述

JDK动态代理：

代理是一种模式，提供了对目标对象的间接访问方式，即通过代理访问目标对象。如此便于在目标实现的基础上增加额外的功能操作，前拦截，后拦截等，以满足自身的业务需求，同时代理模式便于扩展目标对象功能的特点也为多人所用。

JDK动态代理

定义接口

public interface Subject {
    int add(int x, int y);
}

实现类

public class RealSubject implements Subject {
    @Override
    public int add(int x, int y) {
        System.out.println("计算两个数的和，结果为：" + (x + y));
        return x + y;
    }
}

定义代理类，实现动态代理接口

public class MyProxy implements InvocationHandler{

private Object targer;

public MyProxy(Object targer) {
    this.targer = targer;
}

@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    System.out.println("before method do something");
    Object result = method.invoke(targer, args);
    System.out.println("after method do something");
    return result;
}
}

获取代理类

public class Client {
    public static void main(String[] args) {
        Subject target = new RealSubject();
        MyProxy h = new MyProxy(target);
        Subject proxy = (Subject) Proxy.newProxyInstance(Subject.class.getClassLoader(), 
                new Class[]{Subject.class}, h);
        int result = proxy.add(1,2);
    }
}

简单三步即可获取到代理对象，调用代理对象的任何方法都会执行 invoke 方法。

Mybatis动态代理源码分析：

从以上代码可以看出，JDK 动态代理只能代理接口，而且还需要定义实现类，那 mybatis 是如何做到不需要实现类就轻松获取到代理对象的呢？（Mybatis 之所以不用我们自己实现接口的实例，根本原因就在于它采用了反射机制以及动态代理来代理我们的接口。）

mybatis中的getMapper方法的实现方式理解为动态代理方法的实现方式理解为动态代理

mybatis中的getMapper的调用为：sqlSession.getMapper(OrdersMapper1.class)；

mapper是如何添加进去的呢？

DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(OrdersMapper1.class);// 添加Mapper接口
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

等价于

String resource = "mybatis-config.xml"; // xml内容就不贴了
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

我们后去sqlSessionFactory采用以上方式
分析上面代码生成sqlSessionFactory过程有这么一行：
sqlSession类：

configuration.addMapper(OrdersMapper1.class);// 添加Mapper接口

addMapper 方法的代码实现
Configuration类：

  public <T> void addMapper(Class<T> type) {
    mapperRegistry.addMapper(type);
  }

mapper 实际上被添加到 mapperRegissry 中。继续跟进代码：

MapperRegistry类：

final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);


public <T> void addMapper(Class<T> type) {
    if (type.isInterface()) {// 只添加接口
      if (hasMapper(type)) {// 不允许重复添加
        throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
      }
      boolean loadCompleted = false;
      try {
        knownMappers.put(type, new MapperProxyFactory<T>(type));// 注意这里
        MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
        parser.parse();
        loadCompleted = true;
      } finally {
        if (!loadCompleted) {
          knownMappers.remove(type);
        }
      }
    }
  }

所执行的configuration.addMapper(BlogMapper.class); 其实最终被放到了HashMap中，其名为knownMappers ，knowMappers是MapperRegistry 类的一个私有属性，它是一个HashMap 。其Key 为当前Class对象，value 为一个MapperProxyFactory 实例。

总结一下：诸如OrdersMapper1之类的Mapper接口被添加到了MapperRegistry 中的一个HashMap中。并以 Mapper 接口的 Class 对象作为 Key , 以一个携带Mapper接口作为属性的MapperProxyFactory 实例作为value 。MapperProxyFacory从名字来看，好像是一个工厂，用来创建Mapper Proxy的工厂。

从源码上我们可以看到getMapper方法会去调用Configuration类的getMapper方法。

DefaultSqlSession类：

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

Configuration类里面存放了所有关于XML文件的配置信息。从参数上我们可以看到他要我们传入一个Class类型。这已经可以看到后面一定要用到反射机制和动态生成相应的类实例

Configuration类：

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

代码所示，这里的 getMapper 调用了 configuration.getMapper , 这一步操作其实最终是调用了MapperRegistry,而此前我们已经知道，MapperRegistry是存放了一个HashMap的

MapperRegistry类：

  private final Map<Class<?>, MapperProxyFactory<?>> knownMappers = new HashMap<Class<?>, MapperProxyFactory<?>>();


  public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    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);
    }
  }

我们调用的session.getMapper(OrdersMapper1.class);最终会到达上面这个方法，这个方法根据OrdersMapper1的class对象,以它为key在knowMappers 中找到了对应的value —— MapperProxyFactory(BlogMapper) 对象，然后调用这个对象的newInstance()方法。根据这个名字，我们就能猜到这个方法是创建了一个对象

public class MapperProxyFactory<T> { //映射器代理工厂

  private final Class<T> mapperInterface;
  private final Map<Method, MapperMethod> methodCache = new ConcurrentHashMap<Method, MapperMethod>();

  //删除不必要代码

  @SuppressWarnings("unchecked")
  protected T newInstance(MapperProxy<T> mapperProxy) {
    //使用了JDK自带的动态代理生成映射器代理类的对象 
    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);
  }

}

最终是通过Proxy.newProxyInstance产生了一个OrdersMapper1的代理对象。Mybatis 为了完成 Mapper 接口的实现，运用了代理模式。具体是使用了JDK动态代理，这个Proxy.newProxyInstance方法生成代理类的三个要素是：
ClassLoader —— 指定当前接口的加载器即可
OrdersMapper1 —— 这当前被代理的接口是什么
MapperProxy——代理类是什么

代理模式中，代理类(MapperProxy)中才真正的完成了方法调用的逻辑。我们贴出MapperProxy的代码

public class MapperProxy<T> implements InvocationHandler, Serializable {
//实现了InvocationHandler接口

  @Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    if (Object.class.equals(method.getDeclaringClass())) {
    //代理以后，所有Mapper的方法调用时，都会调用这个invoke方法
      try {
        return method.invoke(this, args);// 注意1
      } catch (Throwable t) {
        throw ExceptionUtil.unwrapThrowable(t);
      }
    }
    final MapperMethod mapperMethod = cachedMapperMethod(method); // 使用了缓存
    //执行CURD
    return mapperMethod.execute(sqlSession, args);// 注意2
  }

  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;
  }

}

Blog blog =mapper.getOrdersById(3); 实际上最后是会调用这个MapperProxy的invoke方法。这段代码中，if 语句先判断，我们想要调用的方法是否来自Object类，这里的意思就是，如果我们调用toString()方法，那么是不需要做代理增强的，直接还调用原来的method.invoke()就行了。只有调用getOrdersById之类的方法的时候，才执行增强的调用——即mapperMethod.execute(sqlSession, args);
而mapperMethod.execute(sqlSession, args);这句最终就会执行增删改查了

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;
        }
       // 删除部分代码      
      }
  // 删除部分代码
    return result;
  }

我们分析了 Mapper接口是如何注册的，Mapper接口是如何产生动态代理对象的，Maper接口方法最终是如何执行的。总结起来主要就是这几个点：

Mapper 接口在初始SqlSessionFactory 注册的。
Mapper 接口注册在了名为 MapperRegistry 类的 HashMap中， key = Mapper class value = 创建当前Mapper的工厂。
Mapper 注册之后，可以从SqlSession中get
SqlSession.getMapper 运用了 JDK动态代理，产生了目标Mapper接口的代理对象。
动态代理的代理类是 MapperProxy ，这里边最终完成了增删改查方法的调用。