代理模式

1.代理模式（Proxy）

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

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

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

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

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

 

1.静态代理

代理类和真实类要实现相同的接口，从而代理对象可以代替真实对象做同样的事情。

代理类知道要代理的真实类，故在代理类的类内部声明真实类的对象。

在代理类中，在代替真实类做同样的事情的时候可以添加新的操作。

代码：

//抽象角色：
abstract public class Subject

{      
     abstract public void request();
}


//真实角色：实现了Subject的request()方法。
public class RealSubject extends Subject

{
     public RealSubject()

    { 
     }

     public void request()

     {
           System.out.println("From real subject.");
     }
} 

//代理角色：
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 
     }
}

//客户端调用：
Subject sub=new ProxySubject();
Sub.request(); 

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

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

2.动态代理

什么是动态代理？

被代理的对象（真实主题（RealSubject））可以在运行时动态改变

需要控制的接口(抽象主题（Subject）)可以在运行时改变，控制的方式也可以动态改变，从而实现了非常灵活的动态代理关系。

 

Java提供了动态代理的实现方法。

在Java的java.lang.reflect库中，提供了下面的三个类来实现动态代理。

Proxy(类): 此类表示代理设置，通常为类型（http、socks）和套接字地址。Proxy 是不可变对象。

InvocationHadler(接口): 可以称为调用处理器，是代理实例的调用处理程序 实现的接口。 每个代理实例都具有一个关联的调用处理程序。对代理实例调用方法时，将对方法调用进行编码并将其指派到它的调用处理程序的invoke 方法。

Method（类）: 提供关于类或接口上单独某个方法（以及如何访问该方法）的信息。所反映的方法可能是类方法或实例方法（包括抽象方法）。

 

那么，怎么实现动态代理呢？主要通过以下四步：

1） 定义一个抽象主题

2） 定义一个真实主题

前两个和静态代理相同。关键就是这个动态代理角色是怎么实现呢？

3) 需要实现InvocationHadler(接口)，这个接口的实现类，将会完成动态代理类的实际工作。

     在这个接口的invoke方法中，会通过Method（类），利用Java的反射机制，动态实现对真实主题的调用。

4) 在客户端（或InvocationHadler的实现类），调用Proxy(类)的静态方法newProxyInstance，会返回一个代理对象（这个就是动态代理类，它其实并不做实际的工作）。

 

现实生活中，去向卖家（抽象主题（Subject））买汽车，通常不直接向厂家（真实主题(Real Subject)）购买汽车，可以到4S店（代理（Proxy）角色）买汽车，那里可以得到更多的服务。

//抽象主题（Subject）： 

1. /** 
2.  * 抽象主题（Subject） 
3.  *  
4.  * 汽车的销售商 
5.  * 
6.  */  
7. public interface CarSeller {  
8.       
9.     /* 
10.      * 销售汽车 
11.      */  
12.     public Object sellCars(int type);  
13.   
14. }  

 

// 真实主题(Real Subject)： 

Java代码  

1. /** 
2.  * 真实主题(Real Subject)角色 
3.  * 奥迪厂家 
4.  * 
5.  */  
6. public class AudiCarFactory implements CarSeller {  
7.   
8.     /* 
9.      * 实现了抽象主题（Subject）角色的方法 
10.      */  
11.     public Object sellCars(int type)
12.   {  
13.         System.out.println("奥迪工厂出售汽车。");  
14.         if(type == 1){  
15.             return "AudiA6";  
16.         }else{  
17.             return "AudiA8";  
18.         }  
19.     }  
20. }  

 

// 调用处理器（InvocationHadler的实现类）： 

Java代码  

1. /* 
2.  * 实际提供代理商服务的一个类 
3.  * （很多地方把这个类称为代理类，个人觉得不准确。 
4.  * 它是一个会完成动态代理类的实际工作的类。） 
5.  */  
6. public class CarProxyInvocationHandler implements InvocationHandler {  
7.       
8.     Object carSeller = null;  
9.       
10.     public CarProxyInvocationHandler(Object carSeller)
11.    {  
12.         this.carSeller = carSeller;  
13.     }  
14.       
15.     /* 
16.      * 代理角色提供服务的真正方法。 
17.      * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[]) 
18.      */  
19.     public Object invoke(Object proxy, Method method, Object[] args)
20.    {  
21.         Object result = null;  
22.           
23.         try {  
24.               
25.             serveBeforeSell();  
26.             result = method.invoke(carSeller,args);  //与真实角色做相同的事情
27.             serveAfterSell();  
28.   
29.         } catch (Exception e) {  
30.             System.exit(1);  
31.         }  
32.           
33. //      System.out.println("result:" + result +";" + args[0]);  
34.           
35.         return result;  
36.     }  
37.       
38.     protected void serveBeforeSell(){  
39.         System.out.println("汽车代理商为客户提供了一些售前服务");  
40.     }  
41.       
42.     protected void serveAfterSell(){  
43.         System.out.println("汽车代理商为客户提供了一些售后服务");  
44.     }  
45.   
46. }  

  

客户端： 

Java代码  

1. /** 
2.  * 客户端调用 
3.  */  
4. public class Customer {  
5.   
6.     public static void main(String[] args) {  
7.   
8. //      创建真实主题对象  
9.         CarSeller carSeller = new AudiCarFactory();  
10.   
11. //      通过动态的方式，得到了真正的代理角色对象。  
12. //      在运行时，真实主题对象，代理角色以及实际完成代理操作的类被关联起来了。  
13.         CarSeller carProxy = (CarSeller) Proxy.newProxyInstance(
14.                       carSeller.getClass() .getClassLoader(), 
15.                       carSeller.getClass().getInterfaces(),  
16.                       new CarProxyInvocationHandler(carSeller)       );  
17.           
18. //函数声明：
19. // newProxyInstance(ClassLoader loader,Class<?>[] interfaces, InvocationHandler h)
    
    
20. //      由代理商销售汽车  
21.         Object car = carProxy.sellCars(2);  
22.         System.out.println("顾客从代理商那里买了一辆" + car);  
23.           
24.     }  
25.   
26. }  

 

运行结果： 

Java代码  

1. 汽车代理商为客户提供了一些售前服务  
2. 奥迪工厂出售汽车。  
3. 汽车代理商为客户提供了一些售后服务  
4. 顾客从代理商那里买了一辆AudiA8  

 

 在初看到Java动态代理的实现时，有几个地方总是不太容易理解： 

1） Proxy类的newProxyInstance方法中的三个参数用来干什么用的。

第一个参数，真实主题对象所使用的类加载器-----为了装载创建出来的动态代理类；

第二个参数，真实主题对象所实现的所有接口-----为了动态代理类将会实现真实主题的所有接口；

第三个参数，一个调用处理器（InvocationHadler的实现类）的实例-----因为动态代理类继承了Proxy类，所以使用其InvocationHadler的实现类从子类（通常为动态代理类）的构造函数构建新的 Proxy 实例。（可参见jdk的帮助文档）

 

这样，我们得到的动态代理类$Proxy0就被指定为某个真实主题的代理，并且该代理继承了Proxy(类)，也实现了抽象主题接口，并与InvocationHadler接口绑定在一起

 

2) InvocationHadler接口的invoke方法中的三个参数用来干什么的。

第一个参数，是动态代理对象$Proxy0，通常不使用。不过，因为有了这个参数，我们可以得到对这个对象的方法的访问了。

第二个参数，被代理对象（真实主题）定义的方法。

第三个参数，被代理对象（真实主题）定义的方法的参数

第二和第三个参数可以利用Method类的反射机制，实现了动态地对主题对象的调用。 

 

3) 调用动态代理类的方法时，是怎么调用到InvocationHadler接口的invoke方法的呢？

 根据动态代理类$Proxy0的代码，我们可以看到，它所实现的抽象主题接口的方法中，调用了InvocationHadler的invoke方法。并且以动态代理类$Proxy0自身的this指针做为invoke方法的第一个参数。

 

明白了这三点，结合上面的代码，就可以理解动态代理的运行机制：

1）创建一个真实主题(AudiCarFactory )对象，该对象继承了抽象主题类(CarSeller)；

2）使用Proxy类的newProxyInstance方法得到了一个动态代理类$Proxy0，并绑定了CarProxyInvocationHandler 实例；

3）该动态代理类$Proxy0继承了Proxy类，并实现了真实主题对象的所有接口(本例中，只有CarSeller)；

4）该动态代理类$Proxy0实现的抽象主题(CarSeller)类的方法(sellCars)中，调用了CarProxyInvocationHandler的invoke方法；

5）CarProxyInvocationHandler的invoke方法中，调用了真实主题(AudiCarFactory )的sellCars方法，并在sellCars之前或之后添加了额外的操作。

 

下面给出时序图，应该能更清晰一些：

 

 

动态代理类是这样的一个类：可以在运行时、在创建这个类的时候才指定它所实现的接口。每个代理类的实例都有一个对应的InvocationHandler对象。

 

引用一位网友的总结： 

所谓动态代理（Dynamic Proxy）是这样一种class: 它是在运行时生成的class,在生成它时你必须提供一组interface给它，然后该class 就宣传它实现了这个interface。你当然可以把该class的实例当做这个interface中的任意一个来用。当然，这个动态代理（Dynamic Proxy）其实就是一个代理（Proxy），它不会替你做实质性的工作。在生成它的实例时，你必须提供一个handler，由它接管实际的工作。

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

(1). Interface InvocationHandler：该接口中仅定义了一个方法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，由它接管实际的工作。(参见文献3)

在使用动态代理类时，我们必须实现InvocationHandler接口，以第一节中的示例为例： 

代码：

//抽象角色(之前是抽象类，此处应改为接口)：

public interface Subject{
     public void request();
} 

//具体角色RealSubject：实现了Subject接口的request()方法。
public class RealSubject implements Subject{ 
     public RealSubject(){

     }
     public void request(){ 
           System.out.println("From real subject."); 
     } 
}

//代理角色：
import java.lang.reflect.Method;
import java.lang.reflect.InvocationHandler;
public class DynamicSubject implements InvocationHandler{
     private Object sub; 
     public DynamicSubject(Object sub){            
           this.sub = sub;
     }
     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 sub)对其赋值；此外，在该类还实现了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[]{ds});
*/

//以下是一次性生成

  Subject subject = (Subject) Proxy.newProxyInstance(cls.getClassLoader(),cls.getInterfaces(),ds);
  subject.request();
}

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

3.代理模式使用原因和应用方面

（1）授权机制 不同级别的用户对同一对象拥有不同的访问权利,如Jive论坛系统中,就使用Proxy进行授权机制控制,访问论坛有两种人:注册用户和游客(未注册用户),Jive中就通过类似ForumProxy这样的代理来控制这两种用户对论坛的访问权限.

（2）某个客户端不能直接操作到某个对象,但又必须和那个对象有所互动.
     举例两个具体情况: 
     如果那个对象是一个是很大的图片,需要花费很长时间才能显示出来,那么当这个图片包含在文档中时,使用编辑器或浏览器打开这个文档,打开文档必须很迅速,不能等待大图片处理完成,这时需要做个图片Proxy来代替真正的图片.
     
     如果那个对象在Internet的某个远端服务器上,直接操作这个对象因为网络速度原因可能比较慢,那我们可以先用Proxy来代替那个对象.
     
     总之原则是,对于开销很大的对象,只有在使用它时才创建,这个原则可以为我们节省很多宝贵的Java内存. 所以,有些人认为Java耗费资源内存,我以为这和程序编制思路也有一定的关系.

（3）现实中，Proxy应用范围很广,现在流行的分布计算方式RMI和Corba等都是Proxy模式的应用