Home Java静态代理与动态代理
Post
Cancel

Java静态代理与动态代理

Posted Aug 12, 2021
By
25 min read

代理概念

为某个对象提供一个代理，以控制对这个对象的访问。代理类和委托类有共同的父类或父接口，这样在任何使用委托类对象的地方都可以用代理对象替代。代理类负责请求的预处理、过滤、将请求分派给委托类处理、以及委托类执行完请求后的后续处理。

从图中可以看出，代理接口（Subject）、代理类（ProxySubject）、委托类（RealSubject）形成一个“品”字结构。根据代理类的生成时间不同可以将代理分为静态代理和动态代理两种。下面以一个模拟需求说明静态代理和动态代理：委托类要处理一项耗时较长的任务，客户类需要打印出执行任务消耗的时间。解决这个问题需要记录任务执行前时间和任务执行后时间，两个时间差就是任务执行消耗的时间。

静态代理

由程序员创建或工具生成代理类的源码，再编译代理类。所谓静态也就是在程序运行前就已经存在代理类的字节码文件，代理类和委托类的关系在运行前就确定了。

代理接口

1
2
3
4
5
6
7

// 代理接口，处理给定名字的任务。 
public interface Subject {  

    // 执行给定名字的任务，taskName 任务名 
    public void dealTask(String taskName);   

}

委托类，具体处理业务

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

// 真正执行任务的类，实现了代理接口。 
public class RealSubject implements Subject {  

    // 执行给定名字的任务。这里打印出任务名
    // 并休眠500ms模拟任务执行了很长时间 
    @Override  
    public void dealTask(String taskName) {  
        System.out.println("正在执行任务：" + taskName);  
        try {  
           Thread.sleep(500);  
        } catch (InterruptedException e) {  
           e.printStackTrace();  
        }  
    }
  
}

静态代理类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// 代理类，实现了代理接口。  
public class ProxySubject implements Subject { 
     
    // 代理类持有一个委托类的对象引用  
    private Subject delegate;  
   
    public ProxySubject(Subject delegate) {  
        this.delegate = delegate;  
    }  
  
    // 将请求分派给委托类执行
    // 记录任务执行前后的时间，时间差即为任务的处理时间 
    @Override  
    public void dealTask(String taskName) {  
        long stime = System.currentTimeMillis();   
        // 将请求分派给委托类处理  
        delegate.dealTask(taskName);  
        long ftime = System.currentTimeMillis();   
        System.out.println("执行任务耗时" + (ftime - stime) + "毫秒");  
    } 

}

生成静态代理类工厂

1
2
3
4
5
6
7
8
9

public class SubjectStaticFactory { 

    // 客户类调用此工厂方法获得代理对象。  
    // 对客户类来说，其并不知道返回的是代理类对象还是委托类对象。  
    public static Subject getInstance() {   
        return new ProxySubject(new RealSubject());  
    }  

}

客户类

1
2
3
4
5
6
7
8

public class Client1 {  

    public static void main(String[] args) {  
        Subject proxy = SubjectStaticFactory.getInstance();  
        proxy.dealTask("DBQueryTask");  
    }   
  
}

静态代理的优缺点

  • 优点：业务类只需要关注业务逻辑本身，保证了业务类的重用性。这是代理的共有优点。
  • 缺点：
    • 代理对象的一个接口只服务于一种类型的对象，如果要代理的方法很多，势必要为每一种方法都进行代理，静态代理在程序规模稍大时就无法胜任了。
    • 如果接口增加一个方法，除了所有实现类需要实现这个方法外，所有代理类也需要实现此方法。增加了代码维护的复杂度。

动态代理

动态代理类的源码是在程序运行期间由JVM根据反射等机制动态的生成，所以不存在代理类的字节码文件。代理类和委托类的关系是在程序运行时确定。先看看与动态代理紧密关联的Java API。

  • java.lang.reflect.Proxy

    这是Java动态代理机制生成的所有动态代理类的父类，它提供了一组静态方法来为一组接口动态地生成代理类及其对象。

    1
2
3
4
5
6
7
8
9
10
11
12
13
14

      // Proxy类的静态方法 

  // 方法 1: 该方法用于获取指定代理对象所关联的调用处理器  
  static InvocationHandler getInvocationHandler(Object proxy)   
    
  // 方法 2：该方法用于获取关联于指定类装载器和一组接口的动态代理类的类对象  
  static Class getProxyClass(ClassLoader loader, Class[] interfaces)   
    
  // 方法 3：该方法用于判断指定类对象是否是一个动态代理类  
  static boolean isProxyClass(Class cl)   
    
  // 方法 4：该方法用于为指定类装载器、一组接口及调用处理器生成动态代理类实例  
  static Object newProxyInstance(ClassLoader loader, 
          Class[] interfaces, InvocationHandler h)

  • java.lang.reflect.InvocationHandler

    这是调用处理器接口，它自定义了一个invoke方法，用于集中处理在动态代理类对象上的方法调用，通常在该方法中实现对委托类的代理访问。每次生成动态代理类对象时都要指定一个对应的调用处理器对象。

    1
2
3
4
5
6
7

      // InvocationHandler的核心方法 

  // 该方法负责集中处理动态代理类上的所有方法调用。
  // 第一个参数既是代理类实例，第二个参数是被调用的方法对象  
  // 第三个方法是调用参数。
  // 调用处理器根据这三个参数进行预处理或分派到委托类实例上反射执行  
  Object invoke(Object proxy, Method method, Object[] args)

  • java.lang.ClassLoader

    这是类装载器类，负责将类的字节码装载到Java虚拟机（JVM）中并为其定义类对象，然后该类才能被使用。Proxy静态方法生成动态代理类同样需要通过类装载器来进行装载才能使用，它与普通类的唯一区别就是其字节码是由JVM在运行时动态生成的而非预存在于任何一个.class文件中。每次生成动态代理类对象时都需要指定一个类装载器对象。

动态代理实现步骤

具体步骤是：

  1. 实现InvocationHandler接口创建自己的调用处理器
  2. 给Proxy类提供ClassLoader和代理接口类型数组创建动态代理类
  3. 以调用处理器类型为参数，利用反射机制得到动态代理类的构造函数
  4. 以调用处理器对象为参数，利用动态代理类的构造函数创建动态代理类对象
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

// 分步骤实现动态代理 

// InvocationHandlerImpl 实现了InvocationHandler接口
// 并能实现方法调用从代理类到委托类的分派转发  
// 其内部通常包含指向委托类实例的引用，用于真正执行分派转发过来的方法调用  
InvocationHandler handler = new InvocationHandlerImpl(..);   
  
// 通过Proxy为包括Interface接口在内的一组接口动态创建代理类的类对象  
Class clazz = Proxy.getProxyClass(
        classLoader, new Class[] { Interface.class, ... });   
  
// 通过反射从生成的类对象获得构造函数对象  
Constructor constructor = clazz.getConstructor(
        new Class[] { InvocationHandler.class });   
  
// 通过构造函数对象创建动态代理类实例  
Interface Proxy = (Interface)constructor.newInstance(
        new Object[] { handler });

Proxy类的静态方法newProxyInstance对上面具体步骤的后三步做了封装，简化了动态代理对象的获取过程。

1
2
3
4
5
6
7
8
9

// 简化后的动态代理实现 

// InvocationHandlerImpl实现了InvocationHandler接口
// 并能实现方法调用从代理类到委托类的分派转发  
InvocationHandler handler = new InvocationHandlerImpl(..);   
  
// 通过Proxy直接创建动态代理类实例  
Interface proxy = (Interface)Proxy.newProxyInstance( classLoader,   
    new Class[] { Interface.class },  handler );

动态代理实现示例

创建自己的调用处理器

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

//  动态代理类对应的调用处理程序类  
public class SubjectInvocationHandler implements InvocationHandler {  
   
    // 代理类持有一个委托类的对象引用  
    private Object delegate;  

    public SubjectInvocationHandler(Object delegate) {  
        this.delegate = delegate;  
    }  
   
    @Override  
    public Object invoke(Object proxy, Method method, Object[] args) 
            throws Throwable {  
        long stime = System.currentTimeMillis();   
        // 利用反射机制将请求分派给委托类处理
        // Method的invoke返回Object对象作为方法执行结果。  
        // 因为示例程序没有返回值，所以这里忽略了返回值处理  
        method.invoke(delegate, args);  
        long ftime = System.currentTimeMillis();   
        System.out.println("执行任务耗时"+(ftime - stime)+"毫秒");  
        return null;  
    }  

}

生成动态代理对象的工厂

工厂方法列出了如何生成动态代理类对象的步骤

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// 生成动态代理对象的工厂
public class DynProxyFactory {  
    //客户类调用此工厂方法获得代理对象。  
    //对客户类来说，其并不知道返回的是代理类对象还是委托类对象。  
    public static Subject getInstance(){   
        Subject delegate = new RealSubject();  
        InvocationHandler handler = new SubjectInvocationHandler(delegate);  
        Subject proxy = null;  
        proxy = (Subject)Proxy.newProxyInstance(  
            delegate.getClass().getClassLoader(),   
            delegate.getClass().getInterfaces(),   
            handler);  
        return proxy;  
    }  
}

动态代理客户类

1
2
3
4
5
6

public class Client {  
    public static void main(String[] args) {  
        Subject proxy = DynProxyFactory.getInstance();  
        proxy.dealTask("DBQueryTask");  
    }   
}

动态代理机制特点

首先是动态生成的代理类本身的一些特点。

  • 包：如果所代理的接口都是public的，那么它将被定义在顶层包（即包路径为空），如果所代理的接口中有非public的接口（因为接口不能被定义为protect或 private，所以除public之外就是默认的package访问级别），那么它将被定义在该接口所在包（假设代理了com.ibm.developerworks包中的某非public接口A，那么新生成的代理类所在的包就是com.ibm.developerworks），这样设计的目的是为了最大程度的保证动态代理类不会因为包管理的问题而无法被成功定义并访问；
  • 类修饰符：该代理类具有final和public修饰符，意味着它可以被所有的类访问，但是不能被再度继承；
  • 类名：格式是“$ProxyN”，其中N是一个逐一递增的阿拉伯数字，代表Proxy类第N次生成的动态代理类，值得注意的一点是，并不是每次调用Proxy的静态方法创建动态代理类都会使得N值增加，原因是如果对同一组接口（包括接口排列的顺序相同）试图重复创建动态代理类，它会很聪明地返回先前已经创建好的代理类的类对象，而不会再尝试去创建一个全新的代理类，这样可以节省不必要的代码重复生成，提高了代理类的创建效率。

  • 类继承关系：该类的继承关系如图：

    由图可见，Proxy类是它的父类，这个规则适用于所有由Proxy创建的动态代理类。而且该类还实现了其所代理的一组接口，这就是为什么它能够被安全地类型转换到其所代理的某接口的根本原因。

接下来让我们了解一下代理类实例的一些特点。每个实例都会关联一个调用处理器对象，可以通过Proxy提供的静态方法getInvocationHandler去获得代理类实例的调用处理器对象。在代理类实例上调用其代理的接口中所声明的方法时，这些方法最终都会由调用处理器的invoke方法执行，此外，值得注意的是，代理类的根类java.lang.Object中有三个方法也同样会被分派到调用处理器的invoke方法执行，它们是hashCode，equals和toString，可能的原因有：

  • 一是因为这些方法为public且非final类型，能够被代理类覆盖；
  • 二是因为这些方法往往呈现出一个类的某种特征属性，具有一定的区分度，所以为了保证代理类与委托类对外的一致性，这三个方法也应该被分派到委托类执行。当代理的一组接口有重复声明的方法且该方法被调用时，代理类总是从排在最前面的接口中获取方法对象并分派给调用处理器，而无论代理类实例是否正在以该接口（或继承于该接口的某子接口）的形式被外部引用，因为在代理类内部无法区分其当前的被引用类型。

接着来了解一下被代理的一组接口有哪些特点。首先，要注意不能有重复的接口，以避免动态代理类代码生成时的编译错误。其次，这些接口对于类装载器必须可见，否则类装载器将无法链接它们，将会导致类定义失败。再次，需被代理的所有非public的接口必须在同一个包中，否则代理类生成也会失败。最后，接口的数目不能超过65535，这是JVM设定的限制。

最后再来了解一下异常处理方面的特点。从调用处理器接口声明的方法中可以看到理论上它能够抛出任何类型的异常，因为所有的异常都继承于Throwable接口，但事实是否如此呢？答案是否定的，原因是我们必须遵守一个继承原则：即子类覆盖父类或实现父接口的方法时，抛出的异常必须在原方法支持的异常列表之内。所以虽然调用处理器理论上讲能够，但实际上往往受限制，除非父接口中的方法支持抛Throwable异常。那么如果在invoke方法中的确产生了接口方法声明中不支持的异常，那将如何呢？放心，Java动态代理类已经为我们设计好了解决方法：它将会抛出UndeclaredThrowableException异常。这个异常是一个RuntimeException类型，所以不会引起编译错误。通过该异常的getCause方法，还可以获得原来那个不受支持的异常对象，以便于错误诊断。

总结

一个典型的动态代理创建对象过程可分为以下四个步骤：

  1. 通过实现InvocationHandler接口创建自己的调用处理器IvocationHandler handler = new InvocationHandlerImpl(...);
  2. 通过为Proxy类指定ClassLoader对象和一组interface创建动态代理类Class clazz = Proxy.getProxyClass(classLoader,new Class[]{...});
  3. 通过反射机制获取动态代理类的构造函数，其参数类型是调用处理器接口类型Constructor constructor = clazz.getConstructor(new Class[]{InvocationHandler.class});
  4. 通过构造函数创建代理类实例，此时需将调用处理器对象作为参数被传入Interface Proxy = (Interface)constructor.newInstance(new Object[] (handler));

为了简化对象创建过程，Proxy类中的newInstance方法封装了2~4，只需两步即可完成代理对象的创建。生成的ProxySubject继承Proxy类实现Subject接口，实现的Subject的方法实际调用处理器的invoke方法，而invoke方法利用反射调用的是被代理对象的的方法Object result = method.invoke(proxied,args)

动态代理的优缺点

  • 优点：动态代理与静态代理相比较，最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理（InvocationHandler.invoke）。这样，在接口方法数量比较多的时候，我们可以进行灵活处理，而不需要像静态代理那样每一个方法进行中转。在本示例中看不出来，因为invoke方法体内嵌入了具体的外围业务（记录任务处理前后时间并计算时间差），实际中可以类似Spring AOP那样配置外围业务。

  • 缺点： 诚然，Proxy已经设计得非常优美，但是还是有一点点小小的遗憾之处，那就是它始终无法摆脱仅支持interface代理的桎梏，因为它的设计注定了这个遗憾。回想一下那些动态生成的代理类的继承关系图，它们已经注定有一个共同的父类叫Proxy。Java的继承机制注定了这些动态代理类们无法实现对class的动态代理，原因是多继承在 Java中本质上就行不通。

    有很多条理由，人们可以否定对class代理的必要性，但是同样有一些理由，相信支持class动态代理会更美好。接口和类的划分，本就不是很明显，只是到了Java中才变得如此的细化。如果只从方法的声明及是否被定义来考量，有一种两者的混合体，它的名字叫抽象类。实现对抽象类的动态代理，相信也有其内在的价值。此外，还有一些历史遗留的类，它们将因为没有实现任何接口而从此与动态代理永世无缘。如此种种，不得不说是一个小小的遗憾。

Knowledge, Java
Java
This post is licensed under CC BY 4.0 by the author.
Contents