javaweb 代理模式详解

1. 代理模式的重要性

spring底层就有用到动态代理模式，spring这个框架众所周知是非常重要的，因此如果不学习动态代理这块内容，那想学好spring是比较吃力的。当然spring还使用了动态字节码技术

2. 代理模式的简介

代理模式为其他对象提供了一种代理以控制对这个对象的访问，在某些情况下一个客户不想或者不能直接引用另一个对象，而代理对象可以在客户端和目标对象之间起到中介的作用

客户端都是和代理打交道的，通过代理来实现与目标对象之间的交流

3. 代理模式角色分析

抽象角色：声明真实对象和代理对象的共同接口
代理角色：代理对象角色内部含有对真实对象的引用，从而可以操作真实对象，同时代理对象提供与真实对象相同的接口，以便在任何时刻都能代替真实对象，同时代理对象可以在执行真实对象操作时，附加其他的操作，相当于对真实对象进行封装
真实角色：代理角色所代表的真实对象，是我们最终要引用的对象

4. 静态代理模式代码示例

抽象角色代码：

//真实角色与代理角色都要继承该类并实现request方法
public abstract class Subject {

    public abstract void request();
}

真实角色代码：

//实现抽象角色中的request方法
public class RealSubject extends Subject {

    @Override
    public void request() {
        System.out.println("real subject do something");
    }

}

代理角色代码：

//内部维护一个真实角色(RealSubject)的引用
//与真实角色都实现了抽象角色
public class ProxySubject extends Subject{

    RealSubject realSubject;
    
    public ProxySubject(RealSubject realSubject) {
        this.realSubject = realSubject;
    }

    @Override
    public void request() {
        //除了对真实对象进行访问之外还有其它增强操作,类似于中介租房子外还有收中介费的操作
        preRequest();
        realSubject.request();
        postRequest();
    }
    
    //调用真实角色方法之前的操作
    public void preRequest() {
        System.out.println("pre request ");
    }
    
    //调用真实角色方法之后的操作
    public void postRequest() {
        System.out.println("post request");
    }
    
}

测试类代码：

public class Client {

    public static void main(String[] args) {
        //被代理的真实角色,既然是被代理的那么就事先存在的,类比于房东
        RealSubject realSubject = new RealSubject();
        //生成一个代理对象,对于用户而言真实角色是无法直接被访问到的,代理对象类似于中介
        Subject sub = new ProxySubject(realSubject);
        //调用代理对象的相应方法,类比于中介与房东都拥有租房子的功能
        sub.request();
    }
}

控制台输出结果：

pre request 
real subject do something
post request

4.1. 静态代理模式UML图

静态代理UML图.png

4.2. 静态代理模式的弊端

由以上代码可以看出，客户实际需要调用的是RealSubject类的request方法，现在用ProxySubject来代理RealSubject类，同样达到目的，同时还封装了其他方法(preRequest、postRequest)可以处理一些其他问题

另外，如果要按照上述的方法使用代理模式，那么真实角色必须是事先存在的，并将其作为代理对象的内部属性，但是实际使用时，一个真实角色它必须对立一个代理角色，如果大量使用会导致类的急剧膨胀，这个问题可以通过java的动态代理类是解决

5. 动态代理简介

java动态代理所使用到的类位于java.lang.reflect包下，一般主要涉及到以下两个类
- Interface InvocationHandler：该接口中仅定义了一个方法 public Object invoke (Object obj, Method method, Object[] args) 在实际使用时，第一个参数obj一般是指代理类，method是被代理的方法，如上述代码中的request()，args为该方法的参数数组
- Proxy：该类即为动态代理类，作用类似于上例中的ProxySubject，其中主要包含以下内容：
  - 使用newProxyInstance可以这样理解，生成一个代理对象，可以代理真实对象，完成真实对象的操作以及自己的额外的操作
  - 所谓Dynamic Proxy是这样一种class：它是在运行时生成的class，在生成它时你必须提供一组interface给它，然后该class就宣称它实现了这些interface，你当然可以把该class的实例当作这些interface中的任何一个来用，当然这个Dynamic Proxy其实就是一个Proxy，它不会替你做实质性的工作，在生成它的实例时你必须提供一个handler，由它接管实际的工作

5.1. 动态代理模式代码示例

抽象角色代码：

public interface Subject {

    void request();
}

真实角色代码：

public class RealSubject implements Subject {

    @Override
    public void request() {
        System.out.println("Real Subject do something");
    }

}

自定义handler代码：

//自定义类实现了InvocationHandler
//内部维护了一个真实角色的引用
public class MyInvocationHandler implements InvocationHandler {

    private Object realSubject;
    
    public MyInvocationHandler(Object realSubject) {
        this.realSubject = realSubject;
    }
    
    public void preRequest() {
        System.out.println("pre request");
    }
    
    public void postRequest() {
        System.out.println("post request");
    }
    
    @Override
    public Object invoke(Object proxy, Method method, Object[] args)
            throws Throwable {
        preRequest();
        //动态代理类内部维护着一个InvocationHandelr的引用
        //而当调用动态代理类的方法时会转而调用handler的invoke方法
        //method、args都是动态代理类调用方法的时候已经封装好并传递过来的，可以直接使用
        Object result = method.invoke(realSubject, args);
        postRequest();
        return result;
    }
}

测试类代码：

//测试类
public class Client {

    public static void main(String[] args) {
        // 生成一个真实角色,事先存在的
        RealSubject realSubject = new RealSubject();
        // 得到真实角色的Class对象
        Class<? extends RealSubject> cls = realSubject.getClass();
        // 自定义一个类并实现InvocationHandler接口,该类内部维护着一个真实角色的对象
        InvocationHandler handler = new MyInvocationHandler(realSubject);
        // 在运行时动态生成代理类
        // 第一个参数是类加载器,可以用真实角色的类加载器
        // 第二个参数是真实角色所实现的接口数组
        // 第三个参数是InvocationHandler实例
        Subject sub = (Subject) Proxy.newProxyInstance(cls.getClassLoader(),
                cls.getInterfaces(), handler);
        // 调用代理对象的方法
        sub.request();

    }
}

控制台输出：

pre request
Real Subject do something
post request

5.2. 动态代理模式UML图

动态代理模式UML图.png

5.3. 动态代理编码步骤

创建一个实现接口InvocationHandler的类，它必须实现invoke方法
创建一个抽象角色被真实角色所实现
创建真实角色
将真实角色封装进InvocationHandler实现类的对象中
通过Proxy的静态方法newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h)创建一个代理
通过代理调用方法

6. 总结

每一个代理实例都有与之对立的调用处理器，invoke方法里可以通过反射调用真实角色，并可以增强该方法

通过这种方式，被代理的对象(RealSubject)可以在运行时动态改变，需要控制的接口(Subject接口)可以在运行时改变，控制的方式(MyInvocationHandler类)也可以动态改变，从而实现了非常灵活的动态代理方式

动态代理是指客户通过代理类来调用其它对象的方法

动态代理使用场合：

调试
远程方法调用[RMI]

7.文章引用来源

《张龙JAVA SE系列视频》