Proxy-代理模式(转载动态生成代理对象那块挺有意思)

程序员文章站 2022-04-22 16:39:58

...

Java动态代理模式
1. 代理:一个角色代表别一个角色来完成某些特定的功能。
比如：生产商，中间商，客户这三者这间的关系
客户买产品并不直接与生产商打交道，也不用知道产品是如何产生的，客户只与中间商打交道，而中间商就可以对产品进行一些包装，提供一些售后的服务。

代理模式有三个角色: 1. 抽象主题角色 2. 代理主题角色 3. 实际被代理角色
其它类通过访问代理主题角色来访问实际被代理角色。

2. 下面我们来个一个静态代理的实现。
我以一个坦克为例。
抽象主题角色：Moveable

Java代码

Proxy-代理模式(转载动态生成代理对象那块挺有意思)

博客分类：设计模式 javapatternproxy

package com.gjy.proxy;
blic interface Moveable {
void move();

代理主题角色：TanktimeProxy

Java代码

package com.gjy.proxy;
public class TanktimeProxy implements Moveable{
private Moveable t;
public TanktimeProxy(Moveable t) {
super();
this.t = t;
}
@Override
public void move() {
long time1 = System.currentTimeMillis();
System.out.println("time1="+time1);
t.move();
long time2 = System.currentTimeMillis();
System.out.println("time2="+time2);
System.out.println("运行时间为:"+(time2-time1));
}
}

实际被代理对象：Tank

Java代码

package com.gjy.proxy;
public class Tank implements Moveable{
@Override
public void move() {
System.out.println("TanK moving........");
}
}

测试：

Java代码

package com.gjy.proxy;
public class TestTank {
public static void main(String[] args) {
Tank t = new Tank();
Moveable move = new TanktimeProxy(t);
move.move();
}
}

从上例可以看到代理主题角色：TanktimeProxy实现了对Tank的move()方法运行时间的计算，而TanktimeProxy，Tank都实现了Moveable接口，通过调用TanktimeProxy的move()方法我们可以实现对Tank的move()方法的运行时间的计算，而不用在Tank的move()方法中作任何实现，这就是代理的作用。代理实现时TanktimeProxy，Tank必需实现Moveable接口。

下面我想在TanK的move()方法前后加上日志：
我必需再写一个类来实现这一功能：

Java代码

package com.gjy.proxy;
public class TanklogProxy implements Moveable{
private Moveable t;
public TanklogProxy(Moveable t) {
super();
this.t = t;
}
@Override
public void move() {
System.out.println("start move........");
t.move();
System.out.println("end move......");
}
}

测试：

Java代码

package com.gjy.proxy;
public class TestTank {
public static void main(String[] args) {
Tank t = new Tank();
Moveable move = new TanktimeProxy(t);
Moveable movet = new TanklogProxy(move);
movet.move();
}
}

这样我通过代理在Tank的move()方法前后加入了日志和时间统计的功能，由于TanktimeProxy，TanklogProxy都实现了Moveable接口，所以TanklogProxy可以代理TanktimeProxy，反过来也可以，它们对Tank的代理顺序是可以交换的。

如果我想在Tank的move()方法调用的前后加入更多的功能，是不是要写更多的代理主题角色，这样子会使得代码过于臃肿，不易于维护，那有没有什么办法可以解决呢，答案是可以的，我们可以动态的来生成代理主题角色，来代理所有的被代理对象，这就是动态代理。

下面是一个简单的动态代理的实现：
类图如下：
Proxy-代理模式(转载动态生成代理对象那块挺有意思)

博客分类：设计模式 javapatternproxy

首先编写一个生成代理主题角色的类：Proxy

Java代码

package com.gjy.DynamicProxy;
import java.io.File;
import java.io.FileWriter;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.net.URL;
import java.net.URLClassLoader;
import javax.tools.JavaCompiler;
import javax.tools.StandardJavaFileManager;
import javax.tools.ToolProvider;
import javax.tools.JavaCompiler.CompilationTask;
public class Proxy {
public static Object newProxyIntenct(Class infac,InvocationHandler h) throws Exception{
String br ="\r\n";
String methString ="";
Method[] method = infac.getMethods();
for(Method m: method){
methString = " @Override"+ br +
" public void "+m.getName()+"() {"+ br +
" try {" + br +
" Method md ="+ infac.getName()+".class.getMethod(\""+m.getName()+"\");"+ br +
" h.invoke(this,md);" + br +
" }catch (Exception e){ "+ br+
" e.printStackTrace();" + br +
" }" + br +
" }";
}
String src =
"package com.gjy.DynamicProxy;" + br +
"import java.lang.reflect.Method;" + br +
"public class $Proxy implements "+infac.getName()+"{" + br +
" private com.gjy.DynamicProxy.InvocationHandler h;" + br +
" public $Proxy(InvocationHandler h) {" + br +
" super();" + br +
" this.h = h;" + br +
" }" + br + br +
methString +br +
"}";
MakFileUtil.createFile("D:/src/com/gjy/DynamicProxy");
//生成java文件
String fileName ="D:\\src\\com\\gjy\\DynamicProxy\\$Proxy.java";
System.out.println(fileName);
File file = new File(fileName);
FileWriter fWriter = new FileWriter(file);
fWriter.write(src);
fWriter.flush();
fWriter.close();
//生成class文件,jdk6提供的工具类
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
//System.out.println(compiler.getClass().getName());
StandardJavaFileManager fileManager = compiler.getStandardFileManager(null, null, null);
Iterable units = fileManager.getJavaFileObjects(fileName);
CompilationTask task = compiler.getTask(null, fileManager, null, null, null, units);
task.call();
fileManager.close();
//装载到内存,生成新对象
URL[] urls = new URL[]{new URL("file:/"+"D:\\src\\")};
URLClassLoader loader = new URLClassLoader(urls);
Class c = loader.loadClass("com.gjy.DynamicProxy.$Proxy");
//通过有参的构造器反射生成代理类的实例
Constructor ctr = c.getConstructor(InvocationHandler.class);
Object obj = (Object) ctr.newInstance(h);
return obj;
}
}

代理对象的操作接口：

Java代码

package com.gjy.DynamicProxy;
import java.lang.reflect.Method;
public interface InvocationHandler {
void invoke(Object o,Method m);
}

通过实现代理对象的操作接口实现对被代理对象的方法调用前后的逻辑操作。

TimeInvocationHandler实现InvocationHandler接口：

Java代码

package com.gjy.DynamicProxy;
import java.lang.reflect.Method;
public class TimeInvocationHandler implements InvocationHandler {
private Object target;
public TimeInvocationHandler(Object target) {
super();
this.target = target;
}
@Override
public void invoke(Object o, Method m) {
long time1 = System.currentTimeMillis();
System.out.println("time1="+time1);
try {
m.invoke(target);
} catch (Exception e) {
e.printStackTrace();
}
long time2 = System.currentTimeMillis();
System.out.println("time2="+time2);
System.out.println("Tank 的启动时间:"+(time2-time1));
}
}

实际被代理对象：Tank

Java代码

package com.gjy.DynamicProxy;
ublic class Tank implements Moveable{
@Override
public void move() {
int a = 5;
int b = 6;
int c = 0;
int d = 0;
for (int i = 0; i < 1000; i++) {
d = i;
}
c = ((a+b)/2)*12;
System.out.println("TanK moving..Tank 的速度是"+c);
}

抽象代理主题：Moveable

Java代码

package com.gjy.DynamicProxy;
public interface Moveable {
void move();
}
}

测试：

Java代码

package com.gjy.DynamicProxy;
public class TestTank {
public static void main(String[] args) throws Exception{
Tank t = new Tank();
Moveable moveable = (Moveable) Proxy.newProxyIntenct(Moveable.class,new TimeInvocationHandler(t));
moveable.move();
}
}

创建文件夹工具类：MakFileUtil

Java代码

package com.gjy.DynamicProxy;
import java.io.File;
import java.io.IOException;
import java.util.StringTokenizer;
public class MakFileUtil {
public static void createFile(String pathstr) throws IOException{
// File dirFile;
// boolean bFile;
// bFile = false;
//
// dirFile = new File("E:\\test");
// bFile = dirFile.exists();
//
// if( bFile == true ){
// System.out.println("The folder exists.");
// }else{
// System.out.println("The folder do not exist,now trying to create a one...");
// bFile = dirFile.mkdir();
// if( bFile == true ){
// System.out.println("Create successfully!");
// }else{
// System.out.println("Disable to make the folder,please check the disk is full or not.");
// System.exit(1);
// }
//创建多级目录
String path = pathstr;
//为指定字符串构造一个 string tokenizer。 "/"字符是分隔标记的分隔符。分隔符字符本身不作为标记。
StringTokenizer st = new StringTokenizer(path,"/");
String path1 = st.nextToken()+"/";
String path2 = path1;
while(st.hasMoreTokens())
{
path1 = st.nextToken()+"/";
path2 += path1;
File inbox = new File(path2);
if(!inbox.exists())
inbox.mkdir();
}
}
}

以上就是动态代理的一个模拟实现，测试时我们不管Proxy和InvocationHandler是怎么实现的，我们只要实现InvocationHandler接口完成相应的逻辑，然后调用Proxy
的newProxyIntenct(Class infac, InvocationHandler h) 传入相应的接口，和InvocationHandler的实现类就可以实现对被代理对象的代理。也就是说Proxy和InvocationHandler写好之后永远不变。

在运行过程中Proxy会动态生成代理主题角色，示例中生成的代理主题角色的代码如下：

Java代码

import java.lang.reflect.Method;
public class $Proxy implements com.gjy.DynamicProxy.Moveable{
private com.gjy.DynamicProxy.InvocationHandler h;
public $Proxy(MakFileUtil h) {
super();
this.h = h;
}
@Override
public void move() {
try {
Method md =com.gjy.DynamicProxy.Moveable.class.getMethod("move");
h.invoke(this,md);
}catch (Exception e){
e.printStackTrace();
}
}
}

如果我们想在Tank的move()方法被调用的前后加入其它的逻辑处理，我们只需实现InvocationHandler接口，下面是给move()加日志:

Java代码

package com.gjy.DynamicProxy;
import java.lang.reflect.Method;
public class LogInvocationHandler implements InvocationHandler {
private Object target;
public LogInvocationHandler(Object target) {
super();
this.target = target;
}
@Override
public void invoke(Object o, Method m) {
System.out.println("Tank start...........");
try {
m.invoke(target);
} catch (Exception e) {
e.printStackTrace();
}
System.out.println("Tank stop..............");
}
}

测试：

Java代码

package com.gjy.DynamicProxy;
public class TestTank {
public static void main(String[] args) throws Exception{
Tank t = new Tank();
Moveable moveable = (Moveable) Proxy.newProxyIntenct(Moveable.class,new TimeInvocationHandler(t));
Moveable moveable2 = (Moveable) Proxy.newProxyIntenct(Moveable.class, new LogInvocationHandler(moveable));
moveable2.move();
}
}

同样代理顺序可以交换，这就是动态代理的实现过程。

第二部分进行下补充，主要是动态代理那部分可以一览：

1.代理模式

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

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

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

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

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

以下以《Java与模式》中的示例为例：

代码：

//抽象角色：
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.动态代理

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模式的应用

Proxy-代理模式(转载 动态生成代理对象那块挺有意思)