mybatis 底层是基于 JDK 动态代理来实现 mapper 动态代理的,所以我们先来看看 JDK 动态代理。
1、回顾JDK 动态代理
1.1、定义接口 & 实现类
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; } }
1.2、定义代理类,实现动态代理接口
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; } }
1.3、获取代理类
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 方法。
从以上代码可以看出,JDK 动态代理只能代理接口,而且还需要定义实现类,那 mybatis 是如何做到不需要实现类就轻松获取到代理对象的呢。
2、mybatis 动态代理
一般我们会这么获取代理类。
1、DefaultSqlSession.java public <T> T getMapper(Class<T> type) { return configuration.<T>getMapper(type, this); } 2、Configuration.java public <T> T getMapper(Class<T> type, SqlSession sqlSession) { return mapperRegistry.getMapper(type, sqlSession); } 3、MapperRegistry.java 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); } } 4、MapperProxyFactory.java public T newInstance(SqlSession sqlSession) { final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache); return newInstance(mapperProxy); } protected T newInstance(MapperProxy<T> mapperProxy) { return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy); }
一路追踪代码下来发现是先获取MapperProxyFactory
,然后通过参数构建出代理对象即可。
重点就是获取 MapperProxyFactory 类,从代码看是从 knownMappers 中获取的,来看看这个 knownMappers 到底是个啥。
在MapperRegistry类中是这样定义的
Map<Class<?>, MapperProxyFactory<?>> knownMappers = new HashMap<Class<?>, MapperProxyFactory<?>>()原来是一个 Class 为 key,MapperProxyFactory 为 value 的 map 对象。可见是针对不同的 mapper 类型会有不一样的 MapperProxyFactory。那是在什么时候放进去该 map 的呢?查看源码得知在 MapperRegistry 类中 54 行有这么一行代码。
knownMappers.put(type, new MapperProxyFactory<T>(type));
而该方法源头是在 XMLConfigBuilder.mapperElement(XNode)
开始一步步被调用的,而 XMLConfigBuilder.mapperElement(XNode)
是在读取配置文件时[XMLConfigBuilder 118行]被调用的,也就是说加载配置文件的时候就把 key - value 注入到 knownMappers 中去了,以便后续调用。
至此,mapper 接口是如何被 mybatis 代理的一目了然。
同时可以看出获取到的代理对象就是 MapperProxy 类,该类实现 InvocationHandler 接口和 invoke 方法。获取到了 MapperProxy 对象之后,在调用该代理对象的接口方法时,只要在这个对象的 invoke 方法里执行相应的 SQL 语句并将结果集返回不就达到我们的目的了吗,因此也就不需要接口实现类了。
摘自:https://www.jianshu.com/p/93e18dcc7c10