proxy (关于代理模式)

转自：Java设计模式圣经连载

        http://hi.baidu.com/liuzhenfeng511/blog/item/6f9f0c1be771501f8618bfd1.html

代理模式是一种非常重要的设计模式，在Java语言中有着广泛的应用，包括Spring AOP的核心设计思想，都和代理模式有密切关系。

代理模式主要分两种：一种是静态代理，一种是动态代理。两种代理方式的实现有着本质的差异。

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

代理模式一般涉及到的角色有：

抽象角色：声明真实对象和代理对象的共同接口。

代理角色：代理对象角色内部含有对真实对象的引用，从而可以操作真实对象，同时代理对象提供与真实对象相同的接口以便在任何时刻都能代替真实对象。同时，代理对象可以在执行真实对象操作时，附加其他的操作，相当于对真实对象进行封装。

真实角色：代理角色所代表的真实对象，是我们最终要引用的对象。

下面分别介绍两种代理模式：

一、静态代理

静态代理代理和被代理对象在代理之前是确定的。他们都实现相同的接口或者继承相同的抽象类。下面看一个例子，代码参考阎宏博士的《Java与模式》一书，有改动。

/**

* 抽象角色

*/

public abstract class Subject {

    abstract public void request();

}

/**

* 真实角色：实现了Subject的request()方法

*/

public class RealSubject extends Subject {

    public RealSubject() {

    }

    public void request() {

        System.out.println("真实角色的请求方法RealSubject.request()被调用!");

    }

}

/**

* 代理角色

*/

public class ProxySubject extends Subject {

    private RealSubject realSubject; // 以真实角色作为代理角色的属性

    public ProxySubject() {

    }

    // 该方法封装了真实对象的request方法

    public void request() {

        preRequest();               //代理前执行的操作

        if (realSubject == null) {

            realSubject = new RealSubject();

        }

        realSubject.request();     // 此处执行真实对象的request方法

        postRequest();              //代理后执行的操作

    }

    private void preRequest() {

        // something you want to do before requesting

        System.out.println("代理前执行的操作ProxySubject.preRequest()!");

    }

    private void postRequest() {

        // something you want to do after requesting

        System.out.println("代理后执行的操作ProxySubject.postRequest()!");

    }

}

/**

* 客户端调用

*/

public class Client {

    public static void main(String[] args) {

        Subject sub = new ProxySubject();

        sub.request();

    }

}

运行客户端调用，结果如下：

代理前执行的操作ProxySubject.preRequest()!

真实角色的请求方法RealSubject.request()被调用!

代理后执行的操作ProxySubject.postRequest()!

Process finished with exit code 0

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

另外，如果要按照上述的方法使用代理模式，那么真实角色必须是事先已经存在的，并将其作为代理对象的内部属性。但是实际使用时，一个真实角色必 须对应一个 代理角色，如果大量使用会导致类的急剧膨胀；此外，如果事先并不知道真实角色，该如何使用代理呢？这个问题可以通过Java的动态代理类来解决。请看下面 的动态代理模式。

二、动态代理

Java动态代理类位于java.lang.reflect包下，一般主要涉及到以下两个类：

(1)Interface InvocationHandler：该接口中仅定义了一个方法

public object invoke(Object obj,Method method, Object[] args)

在实际使用时，第一个参数obj一般是指代理类，method是被代理的方法，如上例中的request()，args为该方法的参数数组。 这个抽象方法在代理类中动态实现。

(2)Proxy：该类即为动态代理类，作用类似于上例中的ProxySubject，其中主要包含以下内容

动态代理类

protected Proxy(InvocationHandler h)：构造函数，用于给内部的h赋值。

static Class getProxyClass (ClassLoader loader, Class[] interfaces)：获得一个代理类，其中loader是类装载器，interfaces是真实类所拥有的全部接口的数组。

static Object newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h)：返回代理类的一个实例，返回后的代理类可以当作被代理类使用(可使用被代理类的在Subject接口中声明过的方法)

动态代理类

所谓Dynamic Proxy是这样一种class：它是在运行时生成的class，在生成它时你必须提供一组interface给它，然后该class就宣称它实现了这些 interface。你当然可以把该class的实例当作这些interface中的任何一个来用。当然，这个Dynamic Proxy其实就是一个Proxy，它不会替你作实质性的工作，在生成它的实例时你必须提供一个handler，由它接管实际的工作

在使用动态代理类时，我们必须实现InvocationHandler接口。

下面看个例子，在静态代理的基础上改为动态代理：

/**

* 抽象角色

*/

public interface Subject {

    public void request();

}

/**

* 具体角色:被代理类

*/

public class RealSubject implements Subject {

    public RealSubject() {

    }

    public void request() {

        System.out.println("具体角色的请求方法RealSubject.request()被调用!");

    }

}

/**

* 代理处理器

*

* 该代理类的内部属性为Object类，实际使用时通过该类的构造函数DynamicSubject(Object obj)对其赋值；

* 此外，在该类还实现了invoke方法，该方法中的 method.invoke(sub,args);

* 其实就是调用被代理对象的将要被执行的方法，方法参数sub是实际的被代理对象，

* args为执行被代理对象相应操作所需的参数。

* 通过动态代理类，我们可以在调用之前或之后执行一些相关操作

*/

public class DynamicSubject implements InvocationHandler {

    private Object sub;       //被代理对象

    public DynamicSubject() {

    }

    /**

     * 构造方法,并初始化被代理对象

     * @param obj 是被代理的对象

     */

    public DynamicSubject(Object obj) {

        sub = obj;

    }

    /**

     *

     * @param proxy 指代理类

     * @param method 被代理的方法

     * @param args   被代理的方法所需要的参数数组

     * @return 在代理实例上处理方法调用并返回结果。

     * @throws Throwable

     */

    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

        System.out.println("代理前执行的操作!");

        method.invoke(sub, args);

        System.out.println("代理后执行的操作!");

        return null;

    }

}

/**

* 客户端

*/

public class Client {

    static public void main(String[] args) throws Throwable {

        RealSubject rs = new RealSubject();     // 在这里指定被代理类

        //通过被代理类对象声明一个代理类对象

        InvocationHandler dynamicSubject = new DynamicSubject(rs);

        Class<?> cls = rs.getClass();

        // 以下是一次性生成代理类实例:

        // 返回一个指定接口的代理类实例，该接口可以将方法调用指派到指定的调用处理程序。

        Subject subject = (Subject) Proxy.newProxyInstance(

                cls.getClassLoader(),           //定义代理类的类加载器

                cls.getInterfaces(),            //代理类要实现的接口列表

                dynamicSubject);                //指派方法调用的调用处理程序:InvocationHandler对象

        subject.request();      //调用代理处理器上的方法

    }

}

运行结果：

代理前执行的操作!

具体角色的请求方法RealSubject.request()被调用!

代理后执行的操作!

Process finished with exit code 0

注释很详细，在此不再赘述。

从上面例子可以看出，动态代理的功能很强大，但主要还是依赖Java语言的自身特征来处理的。

总结一下，动态代理实现的步骤

1.创建一个实现接口InvocationHandler的类，它必须实现invoke方法

2.创建被代理的类以及接口。

3.通过Proxy的静态方法。

newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h) 创建一个代理类。

4.通过代理调用方法。

其他资料：

Java动态代理类位于Java.lang.reflect包下，一般主要涉及到以下两个类：
(1). Interface InvocationHandler：该接口中仅定义了一个方法Object：invoke(Object obj,Method method, J2EEjava语言JDK1.4APIjavalangObject.html">Object[] args)。在实际使用时，第一个参数obj一般是指代理类，method是被代理的方法，如上例中的request()，args为该方法的参数数组。 这个抽象方法在代理类 中动态实现。

(2).Proxy：该类即为动态代理类，作用类似于上例中的ProxySubject，其中主要包含以下内容：
Protected Proxy(InvocationHandler h)：构造函数，估计用于给内部的h赋值。
Static Class getProxyClass (ClassLoader loader, Class[] interfaces)：获得一个代理类，其中loader是类装载器 ，interfaces是真实类所拥有的全部接口的数组。
Static Object newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h)：返回代理类的一个实例，返回后的代理类可以当作被代理类使用(可使用被代理类的在Subject接口中声明过的方法)。


       所谓Dynamic Proxy是这样一种class：它是在运行时生成的class，在生成它时你必须提供一组interface给它，然后该class就宣称它实现了这些 interface。你当然可以把该class的实例当作这些interface中的任何一个来用。当然啦，这个Dynamic Proxy其实就是一个Proxy，它不会替你作实质性的工作，在生成它的实例 时你必须提供一个handler，由它接管实际的工作。(参见文献3)

在使用动态代理类时，我们必须实现InvocationHandler接口，以第一节中的示例为例：
抽象角色(之前是抽象类，此处应改为接口)：
public interface Subject
{
    abstract public void request();
}
具体角色RealSubject：同上；

代理角色：
import java.lang.reflect.Method;
import java.lang.reflect.InvocationHandler;

public class DynamicSubject implements InvocationHandler {
private Object sub;

public DynamicSubject() {
}

public DynamicSubject(Object obj) {
    sub = obj;
}


public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    System.out.println("before calling " + method);

    method.invoke(sub,args);

    System.out.println("after calling " + method);
    return null;
}

}

       该代理类的内部属性 为Object类，实际使用时通过该类的构造函数DynamicSubject(Object obj)对其赋值；此外，在该类还实现了invoke方法，该方法中的
method.invoke(sub,args);
其实就是调用被代理对象的将要被执行的方法，方法参数 sub是实际的被代理对象 ，args为执行被代理对象相应操作所需的参数。通过动态代理类，我们可以在调用之前或之后执行一些相关操作 。
客户端：
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;

public class Client
{

    static public void main(String[] args) throws Throwable
       {
      RealSubject rs = new RealSubject(); //在这里指定被代理类
      InvocationHandler ds = new DynamicSubject(rs); //初始化代理类
        Class cls = rs.getClass();
      //以下是分解步骤
      /*
      Class c = Proxy.getProxyClass(cls.getClassLoader(),cls.getInterfaces()) ;
      Constructor ct=c.getConstructor(new Class[]{InvocationHandler.class});
      Subject subject =(Subject) ct.newInstance(new Object[]);
     */
     //以下是一次性生成
      Subject subject = (Subject) Proxy.newProxyInstance(cls.getClassLoader(),
                                 cls.getInterfaces(),ds );


      subject.request();
}
       通过这种方式，被代理的对象(RealSubject)可以在运行时动态改变，需要控制的接口(Subject接口)可以在运行时改变，控制的方式(DynamicSubject类)也可以动态改变，从而实现了非常灵活的动态代理关系(参见文献2)。

参考文献：
1.      阎宏，《Java 与模式 》
2.          透明,《动态代理的前世今生 》
3.   Forest Hou，《Dynamic Proxy 在 Java RMI 中的应用 》