Proxy 代理模式

JAVA代理模式

      什么叫代理呢，网络中有各种各样的代理，比如我们上网有时候用代理服务器。你通过这样上网就是使用了代理上网。
     再举个通俗的例子，你想找某局长帮你做一件事情，但局长官位显赫，你又不能轻易见着，你就想到了找他的秘书，通过她传话给局长，这样你就等于请他的秘书帮你办成了那件事。秘书为什么就可以找到局长呢，因为秘书和局长之间有一定的关系。这里产生了四个对象：你、秘书、局长、秘书-局长（关系）。

      JAVA中同样有代理关系，我们叫做代理模式。
代理模式的作用是：为其他对象（局长）提供一种代理（秘书）以控制对这个对象（局长）的访问。代理对象可以在客户端（你）和目标对象（局长）之间起到中介的作用。
代理模式一般涉及到的角色有： 
1.抽象角色（秘书-局长）：声明真实对象和代理对象的共同接口（秘书-局长）
2. 代理角色（秘书）：代理对象角色（秘书）内部含有对真实对象（局长）的引用，从而可以操作真实对象（局长），同时代理对象（秘书）提供与真实对象（局长）相同的接口（秘书-局长）以便在任何时刻都能代替真实对象（局长）。同时，代理对象（秘书）可以在执行真实对象（局长）操作时，附加其他的操作，相当于对真实对象（局长）进行封装
3. 真实角色（局长）：代理角色（秘书）所代表的真实对象（局长），是我们最终要引用的对象（局长）
下面用四个代码来是这个原理：
Client.java(你)、ProxySubject.java(秘书)、RealSubject.java(局长)、Subject.java(关系)
（1）Subject.java(关系)
package com.pjwqh.proxyTest;
// 抽象角色
abstract public class Subject
{
    abstract public void request();
}
（2）RealSubject.java(局长)
package com.pjwqh.proxyTest;
//真实角色：实现了Subject的request()方法
public class RealSubject extends Subject
{
    public RealSubject()
    {
    }
    public void request()
    {
        System.out.println("我是局长，哈哈");
    }
}

（3）ProxySubject.java(秘书)
package com.pjwqh.proxyTest;
//代理角色
public class ProxySubject extends Subject
{
    private RealSubject realSubject; // 以真实角色作为代理角色的属性
    public ProxySubject()
    {
    }
    public void request() // 该方法封装了真实对象的request方法
    {
        preRequest();
        if (realSubject == null)
        {
            realSubject = new RealSubject();
        }
        realSubject.request(); // 此处执行真实对象的request方法
        postRequest();
    }
    private void preRequest()
    {
        // something you want to do before requesting
    }
    private void postRequest()
    {
        // something you want to do after requesting
    }
}
（4）Client.java(你)
package com.pjwqh.proxyTest;
//客户端调用
public class Client
{
    public static void main(String[] args)
{
// 你直接找（秘书）
        Subject sub = new ProxySubject();
        sub.request();
    }
}
运行输出了“我是局长，哈哈”
这说明我们通过代理对象（秘书）成功调用了被代理对象（局长）的方法。

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

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

Java动态代理类位于java.lang.reflect包下，一般主要涉及到以下两个类： 
(1)Interface InvocationHandler：查看API，发现该接口中仅定义了一个方法
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，由它接管实际的工作

下面用实例说明
（1） Subject.java(关系)
package com.pjwqh.dynamicProxy;
//抽象角色(之前是抽象类，此处应改为接口)： 
public interface Subject
{
    abstract public void request();
}
（2） RealSubject.java（局长)
package com.pjwqh.dynamicProxy;
//具体角色
public class RealSubject implements Subject
{
    public RealSubject()
    {
    }
    public void request()
    {
        System.out.println("我是局长，哈哈");
    }
}
（3） DynamicSubject.java（秘书）
package com.pjwqh.dynamicProxy;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
//代理处理器 
/**
* 该代理类的内部属性为Object类，实际使用时通过该类的构造函数DynamicSubject(Object obj)对其赋值；
* 此外，在该类还实现了invoke方法，该方法中的 method.invoke(sub,args);
* 其实就是调用被代理对象(sub)的将要被执行的方法，方法参数sub是实际的被代理对象，
* args为执行被代理对象相应操作所需的参数。
* 通过动态代理类，我们可以在调用之前或之后执行一些相关操作
*/
public class DynamicSubject implements InvocationHandler
{
    private Object sub;//被代理对象（局长）
    public DynamicSubject()
    {
    }
    public DynamicSubject(Object obj)//构造方法，方便本类的调用
    {
        sub = obj;
}
//这个方法最重要，必须实现的方法，该invoke方法有JVM自动调用，无需程序员显式的调用
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
    {
        System.out.println("封装进来的附加方法");//封装进来的附加方法
        method.invoke(sub, args);//真正需要局长(sub)执行的方法
        System.out.println("封装进来的附加方法");//封装进来的附加方法
        return null;
}
}
（4） Client.java(你)
package com.pjwqh.dynamicProxy;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;
//客户端
public class Client
{
static public void main(String[] args) throws Throwable
{
   RealSubject rs = new RealSubject(); // 在这里指定被代理类(局长)
   InvocationHandler ds = new DynamicSubject(rs);// 在这里指定代理类(秘书)

   Class<?> cls = rs.getClass();
   // 以下是一次性生成代理
  Subject subject = (Subject) Proxy.newProxyInstance(cls.getClassLoader(), cls.getInterface(),ds);
   subject.request();
}
}
通过这种方式，被代理的对象(RealSubject)可以在运行时动态改变，需要控制的接口(Subject接口)可以在运行时改变，控制的方式(DynamicSubject类)也可以动态改变，从而实现了非常灵活的动态代理关系，它的功劳归公于static Object newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h)这个方法。

动态代理是指客户通过代理类来调用其它对象的方法
动态代理使用场合:
    调试
     远程方法调用(RMI)

动态代理步骤：
1.创建一个实现接口InvocationHandler的类，它必须实现invoke方法
2.创建接口
3.创建被代理的类
4.通过Proxy的静态方法
newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h) 创建一个代理
5.通过代理调用方法
下面通过实例件解：
1.创建一个实现接口InvocationHandler的类CommonInvocationHandler.java，它必须实现invoke方法
package com.pjwqh.demo;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
public class CommonInvocationHandler implements InvocationHandler
{
    // 动态执行对象，需要回调的对象
    private Object target;//局长
    // 支持构造子注射
    public CommonInvocationHandler()
    {
    }
    // 支持构造子注射
    public CommonInvocationHandler(Object target)
    {
        setTarget(target);
    }
    /**
     * 采用setter方法注射
     * @param target
     */
    public void setTarget(Object target)
    {
        this.target = target;
    }
    /**
     * 调用proxy中指定的方法method，并传入参数列表args
     * @param proxy
     *            代理类的类型，例如定义对应method的代理接口
     * @param method
     *            被代理的方法
     * @param args
     *            调用被代理方法的参数
     * @return
     * @throws java.lang.Throwable
     */
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
    {
        return method.invoke(target, args);
    }
}
2.创建接口Foo.java
package com.pjwqh.demo;
public interface Foo
{
    void doAction();
}
3.创建被代理的类,这里创建了两个被代理类，以后程序动态调用
(1) FooImpl.java
package com.pjwqh.demo;
public class FooImpl implements Foo
{
    public FooImpl()
    {
    }
    public void doAction()
    {
        System.out.println("这是第一个被代理类（局长）的处理方法");
    }
}
(2) FooImpl2.java
package com.pjwqh.demo;
public class FooImpl2 implements Foo
{
    public FooImpl2()
    {
    }
    public void doAction()
    {
        System.out.println("这是第二个被代理类（局长）的处理方法");
    }
}
4.通过Proxy的静态方法newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h) 创建一个代理
package com.pjwqh.demo;
import java.lang.reflect.Proxy;
public class Demo
{
public static void main(String[] args)
{
   // 1.通用的动态代理实现
   CommonInvocationHandler handler = new CommonInvocationHandler();
   Foo f;
   // 2.接口实现1
   handler.setTarget(new FooImpl());
   // 方法参数说明：代理类、代理类实现的接口列表、代理类的处理器
   // 关联代理类、代理类中接口方法、处理器，当代理类中接口方法被调用时，会自动分发到处理器的invoke方法
   // 如果代理类没有实现指定接口列表，会抛出非法参数异常
   f = (Foo) Proxy.newProxyInstance(Foo.class.getClassLoader(),new Class[] { Foo.class },handler);
   f.doAction();
   // 3.接口实现2
   handler.setTarget(new FooImpl2());
   f = (Foo) Proxy.newProxyInstance(Foo.class.getClassLoader(), new Class[] { Foo.class },handler);
   f.doAction();
}
}
控制台输出：
     这是第一个被代理类（局长）的处理方法
     这是第二个被代理类（局长）的处理方法

JAVA代理模式的一个典型应用：struts2拦截器。有兴趣的朋友可以一起研究。

JAVA代理模式讲解完毕。

转载自蜗牛小屋