一、前言

动态代理 是一种设计模式,JDK 所提供的动态代理是基于接口实现。动态代理用处颇多,比如 Mybatis 使用动态代理代理 Mapper 对象,我们不需要写实现类就能调用接口所定义的方法并获取返回结果。也可以用于日志、AOP 等业务场景。

二、JDK Demo

首先看一下精简版本的基于 JDK 动态代理的示例:

2.1 定义需要被代理的接口以及实现类

  1. /**
  2. * #1 定义需要动态代理的接口
  3. */
  4. public interface Subject {
  5. /**
  6. * 被代理的方法
  7. */
  8. void doing();
  9. }
  10. /**
  11. * #2 接口实现类
  12. */
  13. public class SubjectImpl implements Subject{
  14. @Override
  15. public void doing() {
  16. System.out.println("I'm doing");
  17. }
  18. }

2.2 定义InvocationHandler

我们需要对上述的 doing() 方法进行代理,加一句话吧:

  1. /**
  2. * #3 定义动态代理InvocationHandler
  3. */
  4. public class SubjectInvocationHandlerImpl implements InvocationHandler {
  5. // 原始对象
  6. private Object target;
  7. public SubjectInvocationHandlerImpl(Object target) {
  8. this.target = target;
  9. }
  10. // proxy: JDK生成的代理对象
  11. @Override
  12. public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
  13. // Before
  14. System.out.println("Before doing, I need a good sleep");
  15. Object result = method.invoke(target, args);
  16. System.out.println("After doing, I also need a good sleep");
  17. return result;
  18. }
  19. }

此外需要通过构造器传入被代理对象,并作为参数传入 method.invoke(target,args) 方法中。

jdk-proxy.png

2.3 创建 Proxy

  1. public class JdkDynamicDemo {
  2. public static void main(String[] args) {
  3. // #1 创建 需要被代理对象
  4. SubjectImpl subject = new SubjectImpl();
  5. // #2 使用Proxy静态方法创建代理对象
  6. Subject subjectProxy = (Subject) Proxy.newProxyInstance(
  7. JdkDynamicDemo.class.getClassLoader(),
  8. new Class[]{Subject.class},
  9. new SubjectInvocationHandlerImpl(subject));
  10. // #3 执行目标方法
  11. subjectProxy.doing();
  12. }
  13. }
  14. // OUTPUT
  15. // Before doing, I need a good sleep
  16. // I'm doing
  17. // After doing, I also need a good sleep

简单几个步骤,我们不需要改动目标类方法 doing() 源码,就能在方法执行前、后进行自定义逻辑处理。

三、剖析

3.1 Java Doc 关于 Proxy 说明

Proxy 提供静态方法用以创建对象,它的行为类似接口实例所定义的一样,在此基础上,允许我肯定义方法调用。
一个代理类是在运行时根据指定接口集合(list)创建,所创建的代理对象也属于 Proxy
每个 Proxy 实例需要一个与之关联的 invocation Handler 对象,它实现 InvocationHandler 接口。通过其代理接口之一对代理实例进行的方法调用将分派给该实例的调用处理程序的 invoke 方法,并传递该代理实例,一个标识所调用方法的 java.lang.reflect.Method 对象以及一个数组。
一个代理类有如下属性:

  • 名称独一无二,并以 @Proxy 开头。
  • 代理类为 final 且为非抽象类。
  • 代理类继承 java.lang.reflect.Proxy 类。
  • 代理类完成按照其创建顺序实现接口。
  • 调用 Class#getInterfaces() 返回所有实现的接口。
  • 调用 Class#getMethods getMethods 返回所有实现的方法。
  • 与 Object 一致的安全规则。
  • Proxy#isProxyClass 方法用以判断当前类是否为代理对象。
  • 当不同接口具有相同的方法签名时,接口顺序就变得重要了,代理类的接口列表包含该方法的最前接口的方法的 Method 对象将会传递给 InvocationHandler

    3.2 源码分析 (JDK 14)

    JDK 动态代理源码在 JDK9 被重写了,代码如下:

    1. // java.lang.reflect.Proxy
    2. public static Object newProxyInstance(ClassLoader loader,
    3. Class<?>[] interfaces,
    4. InvocationHandler h) {
    5. Objects.requireNonNull(h);
    6. final Class<?> caller = System.getSecurityManager() == null
    7. ? null
    8. : Reflection.getCallerClass();
    9. // 查找或生成指定的代理类及其构造函数。
    10. Constructor<?> cons = getProxyConstructor(caller, loader, interfaces);
    11. // 使用反射实例化对象
    12. return newProxyInstance(caller, cons, h);
    13. }
  1. // java.lang.reflect.Proxy
  2. private static Class<?> defineProxyClass(Module m, List<Class<?>> interfaces) {
  3. String proxyPkg = null; // package to define proxy class in
  4. int accessFlags = Modifier.PUBLIC | Modifier.FINAL;
  5. /*
  6. * Record the package of a non-public proxy interface so that the
  7. * proxy class will be defined in the same package. Verify that
  8. * all non-public proxy interfaces are in the same package.
  9. */
  10. for (Class<?> intf : interfaces) {
  11. int flags = intf.getModifiers();
  12. if (!Modifier.isPublic(flags)) {
  13. accessFlags = Modifier.FINAL; // non-public, final
  14. String pkg = intf.getPackageName();
  15. if (proxyPkg == null) {
  16. proxyPkg = pkg;
  17. } else if (!pkg.equals(proxyPkg)) {
  18. throw new IllegalArgumentException(
  19. "non-public interfaces from different packages");
  20. }
  21. }
  22. }
  23. if (proxyPkg == null) {
  24. // all proxy interfaces are public
  25. proxyPkg = m.isNamed() ? PROXY_PACKAGE_PREFIX + "." + m.getName()
  26. : PROXY_PACKAGE_PREFIX;
  27. } else if (proxyPkg.isEmpty() && m.isNamed()) {
  28. throw new IllegalArgumentException(
  29. "Unnamed package cannot be added to " + m);
  30. }
  31. if (m.isNamed()) {
  32. if (!m.getDescriptor().packages().contains(proxyPkg)) {
  33. throw new InternalError(proxyPkg + " not exist in " + m.getName());
  34. }
  35. }
  36. /*
  37. * Choose a name for the proxy class to generate.
  38. */
  39. long num = nextUniqueNumber.getAndIncrement();
  40. String proxyName = proxyPkg.isEmpty()
  41. ? proxyClassNamePrefix + num
  42. : proxyPkg + "." + proxyClassNamePrefix + num;
  43. ClassLoader loader = getLoader(m);
  44. trace(proxyName, m, loader, interfaces);
  45. /*
  46. * Generate the specified proxy class.
  47. * PROXY_GENERATOR_V49一般为false, 选择 ProxyGenerator.generateProxyClass 生成字节码文件
  48. */
  49. byte[] proxyClassFile = PROXY_GENERATOR_V49
  50. ? ProxyGenerator_v49.generateProxyClass(proxyName, interfaces, accessFlags)
  51. : ProxyGenerator.generateProxyClass(loader, proxyName, interfaces, accessFlags);
  52. try {
  53. Class<?> pc = JLA.defineClass(loader, proxyName, proxyClassFile,
  54. null, "__dynamic_proxy__");
  55. reverseProxyCache.sub(pc).putIfAbsent(loader, Boolean.TRUE);
  56. return pc;
  57. } catch (ClassFormatError e) {
  58. throw new IllegalArgumentException(e.toString());
  59. }
  60. }

jdk-proxy-byte-code.png
最重要的方法为 ProxyGenerator.generateProxyClass(loader, proxyName, interfaces, accessFlags) ,他根据入参生成相对应的代理类的字节码。

四、总结

  • JDK 动态代理前提之一是需要用户传入自定义接口,JDK 根据接口生成对应的字节码(生成的字节码会持久化至本地,可以在启动时配置 jdk.proxy.ProxyGenerator.saveGeneratedFiles),相当于帮助我们实现了一个代理对象。