MyBatis源码解析5-MapperProxy与JDK Proxy动态代理

JDK proxy（JDK动态代理）

包括jdk中三个重要的类

java.lang.reflect.Proxy
java.lang.reflect.InvocationHandler
sun.misc.ProxyGenerator

用的时候
Proxy.java

    public static Object newProxyInstance(ClassLoader loader,
                                          Class[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException {

}

Proxy.newProxyInstance(classLoader, new Class[] {StudentMapper.class},
new MapperProxy()
):

public interface StudentMapper {
	List<Student> list();
}

newProxyInstance动态生成一个代理类，命名为( $Proxy0, $Proxy1…, 假如为 $Proxy6 )

$Proxy6 这个类实现了一个接口我们传入的interface, 这里我们以StudentMapper为例.

也就是根据StudentMapper.xml的sql配置实现了StudentMapper中的所有的method的实现。

具体怎么实现的呢？

答案：ProxyGenerator通过写汇编程序实现的，asm

private ProxyGenerator.MethodInfo generateMethod() throws IOException {
...
var9.writeShort(ProxyGenerator.this.cp.getInterfaceMethodRef("java/lang/reflect/InvocationHandler", "invoke", "(Ljava/lang/Object;Ljava/lang/reflect/Method;[Ljava/lang/Object;)Ljava/lang/Object;"));

...
}

其中这里是生成汇编ASM代码。去动态创建一个Class ，$Proxy0, 后面的数字0是不断增长的（比如0, 1,2,3,4…)

getInterfaceMethodRef("java/lang/reflect/InvocationHandler", "invoke", "(Ljava/lang/Object;Ljava/lang/reflect/Method;[Ljava/lang/Object;)Ljava/lang/Object;")

也就是每个$Proxy6中每个用户自定义的method的实现。
都是

return invocationHandler.invoke($Proxy6, listMethod.class, null);

总结下全过程

Proxy.newProxyInstance()
产生了一个代理类 $Proxy6

public class $Proxy6 implements StudentMapper {
private InvocationHandler handler;
public $Proxy6(InvocationHandler mapperProxy) {
	handler = mapperProxy;
}
public List<Student> list() {
	return handler.invoke(this, 
	StudentMapper.class.getDeclaredMethod("list),
	null);
}

MapperProxy定义如下：

public class MapperProxy implements InvocationHandler {
	@Override
  public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    try {
      if (Object.class.equals(method.getDeclaringClass())) {
        return method.invoke(this, args);
      } else if (isDefaultMethod(method)) {
        return invokeDefaultMethod(proxy, method, args);
      }
    } catch (Throwable t) {
      throw ExceptionUtil.unwrapThrowable(t);
    }
    final MapperMethod mapperMethod = cachedMapperMethod(method);
    return mapperMethod.execute(sqlSession, args);
  }
}

mapperMethod.execute(sqlSession, args)会去执行数据库操作。

如何找到创建动态代理类的代码ProxyGenerator

首先去找到java.lang.reflect.Proxy#newProxyInstance

Class<?> cl = getProxyClass0(loader, intfs);
final Constructor<?> cons = cl.getConstructor(constructorParams);
            final InvocationHandler ih = h;
            if (!Modifier.isPublic(cl.getModifiers())) {
                AccessController.doPrivileged(new PrivilegedAction<Void>() {
                    public Void run() {
                        cons.setAccessible(true);
                        return null;
                    }
                });
            }
return cons.newInstance(new Object[]{h});

可见getProxyClass0(loader, intfs)获取或创建了一个proxyClass (意思是代理类).最后根据cl创建了一个构造方法，最后用构造方法创建了一个代理对象。
查看getProxyClass0(loader, intfs);

  private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }

        // If the proxy class defined by the given loader implementing
        // the given interfaces exists, this will simply return the cached copy;
        // otherwise, it will create the proxy class via the ProxyClassFactory
        return proxyClassCache.get(loader, interfaces);
    }

proxyClassCache

  private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
        proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());

看下ProxyClassFactory的实现

/**
     * A factory function that generates, defines and returns the proxy class given
     * the ClassLoader and array of interfaces.
     */
    private static final class ProxyClassFactory
        implements BiFunction<ClassLoader, Class<?>[], Class<?>>
    {
        // prefix for all proxy class names
        private static final String proxyClassNamePrefix = "$Proxy";

        // next number to use for generation of unique proxy class names
        private static final AtomicLong nextUniqueNumber = new AtomicLong();

        @Override
        public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {

            Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
            for (Class<?> intf : interfaces) {
                /*
                 * Verify that the class loader resolves the name of this
                 * interface to the same Class object.
                 */
                Class<?> interfaceClass = null;
                try {
                    interfaceClass = Class.forName(intf.getName(), false, loader);
                } catch (ClassNotFoundException e) {
                }
                if (interfaceClass != intf) {
                    throw new IllegalArgumentException(
                        intf + " is not visible from class loader");
                }
                /*
                 * Verify that the Class object actually represents an
                 * interface.
                 */
                if (!interfaceClass.isInterface()) {
                    throw new IllegalArgumentException(
                        interfaceClass.getName() + " is not an interface");
                }
                /*
                 * Verify that this interface is not a duplicate.
                 */
                if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
                    throw new IllegalArgumentException(
                        "repeated interface: " + interfaceClass.getName());
                }
            }

            String proxyPkg = null;     // package to define proxy class in
            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;

            /*
             * Record the package of a non-public proxy interface so that the
             * proxy class will be defined in the same package.  Verify that
             * all non-public proxy interfaces are in the same package.
             */
            for (Class<?> intf : interfaces) {
                int flags = intf.getModifiers();
                if (!Modifier.isPublic(flags)) {
                    accessFlags = Modifier.FINAL;
                    String name = intf.getName();
                    int n = name.lastIndexOf('.');
                    String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
                    if (proxyPkg == null) {
                        proxyPkg = pkg;
                    } else if (!pkg.equals(proxyPkg)) {
                        throw new IllegalArgumentException(
                            "non-public interfaces from different packages");
                    }
                }
            }

            if (proxyPkg == null) {
                // if no non-public proxy interfaces, use com.sun.proxy package
                proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
            }

            /*
             * Choose a name for the proxy class to generate.
             */
            long num = nextUniqueNumber.getAndIncrement();
            String proxyName = proxyPkg + proxyClassNamePrefix + num;

            /*
             * Generate the specified proxy class.
             */
            byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
                proxyName, interfaces, accessFlags);
            try {
                return defineClass0(loader, proxyName,
                                    proxyClassFile, 0, proxyClassFile.length);
            } catch (ClassFormatError e) {
                /*
                 * A ClassFormatError here means that (barring bugs in the
                 * proxy class generation code) there was some other
                 * invalid aspect of the arguments supplied to the proxy
                 * class creation (such as virtual machine limitations
                 * exceeded).
                 */
                throw new IllegalArgumentException(e.toString());
            }
        }
    }

我们重点看其中的这几行

long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;

/*
 * Generate the specified proxy class.
 */
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
    proxyName, interfaces, accessFlags);
try {
    return defineClass0(loader, proxyName,
                        proxyClassFile, 0, proxyClassFile.length);

proxyName这里就是 xxx.yyy.$Proxy0 ,而ProxyGenerator.generateProxyClass()生成动态类的字节码byte[].
defineClass0是一个native放啊放，这个方法根据字节码生成真正的class。

ProxyGenerator.generateProxyClass里面就真正构建汇编代码ASM来生成class.
具体怎么做的，大家看下ProxyGenerator里的实现即可，而且上文已经有所说明，这里不再赘述。