如何使用Proxy模式及Java内建的动态代理机制

Posted 2023-05-11

参考技术A 在学习Spring的时候，我们知道Spring主要有两大思想，一个是IoC，另一个就是AOP，对于IoC，依赖注入就不用多说了，而对于Spring的核心AOP来说，我们不但要知道怎么通过AOP来满足的我们的功能，我们更需要学习的是其底层是怎么样的一个原理，而AOP的原理就是java的动态代理机制，所以本篇随笔就是对java的动态机制进行一个回顾。
在java的动态代理机制中，有两个重要的类或接口，一个是 InvocationHandler(Interface)、另一个则是 Proxy(Class)，这一个类和接口是实现我们动态代理所必须用到的。首先我们先来看看java的API帮助文档是怎么样对这两个类进行描述的：
InvocationHandler:
InvocationHandler is the interface implemented by the invocation handler of a proxy instance.

Each proxy instance has an associated invocation handler. When a method is invoked on a proxy instance, the method invocation is encoded and dispatched to the invoke method of its invocation handler.

每一个动态代理类都必须要实现InvocationHandler这个接口，并且每个代理类的实例都关联到了一个handler，当我们通过代理对象调用一个方法的时候，这个方法的调用就会被转发为由InvocationHandler这个接口的 invoke 方法来进行调用。我们来看看InvocationHandler这个接口的唯一一个方法 invoke 方法：
Object invoke(Object proxy, Method method, Object[] args) throws Throwable

我们看到这个方法一共接受三个参数，那么这三个参数分别代表什么呢？
Object invoke(Object proxy, Method method, Object[] args) throws Throwable

proxy:　　指代我们所代理的那个真实对象
method:　　指代的是我们所要调用真实对象的某个方法的Method对象
args:　　指代的是调用真实对象某个方法时接受的参数

如果不是很明白，等下通过一个实例会对这几个参数进行更深的讲解。
接下来我们来看看Proxy这个类：
Proxy provides static methods for creating dynamic proxy classes and instances, and it is also the superclass of all dynamic proxy classes created by those methods.

Proxy这个类的作用就是用来动态创建一个代理对象的类，它提供了许多的方法，但是我们用的最多的就是 newProxyInstance 这个方法：
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) throws IllegalArgumentException
Returns an instance of a proxy class for the specified interfaces that dispatches method invocations to the specified invocation handler.

这个方法的作用就是得到一个动态的代理对象，其接收三个参数，我们来看看这三个参数所代表的含义：

public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) throws IllegalArgumentException

loader:　　一个ClassLoader对象，定义了由哪个ClassLoader对象来对生成的代理对象进行加载

interfaces:　　一个Interface对象的数组，表示的是我将要给我需要代理的对象提供一组什么接口，如果我提供了一组接口给它，那么这个代理对象就宣称实现了该接口(多态)，这样我就能调用这组接口中的方法了

h:　　一个InvocationHandler对象，表示的是当我这个动态代理对象在调用方法的时候，会关联到哪一个InvocationHandler对象上

好了，在介绍完这两个接口(类)以后，我们来通过一个实例来看看我们的动态代理模式是什么样的：
首先我们定义了一个Subject类型的接口，为其声明了两个方法：
public interface Subject

public void rent();

public void hello(String str);


接着，定义了一个类来实现这个接口，这个类就是我们的真实对象，RealSubject类：

public class RealSubject implements Subject

@Override
public void rent()

System.out.println("I want to rent my house");


@Override
public void hello(String str)

System.out.println("hello: " + str);



下一步，我们就要定义一个动态代理类了，前面说个，每一个动态代理类都必须要实现 InvocationHandler 这个接口，因此我们这个动态代理类也不例外：

public class DynamicProxy implements InvocationHandler

//　这个就是我们要代理的真实对象
private Object subject;

// 构造方法，给我们要代理的真实对象赋初值
public DynamicProxy(Object subject)

this.subject = subject;


@Override
public Object invoke(Object object, Method method, Object[] args)
throws Throwable

//　　在代理真实对象前我们可以添加一些自己的操作
System.out.println("before rent house");

System.out.println("Method:" + method);

// 当代理对象调用真实对象的方法时，其会自动的跳转到代理对象关联的handler对象的invoke方法来进行调用
method.invoke(subject, args);

//　　在代理真实对象后我们也可以添加一些自己的操作
System.out.println("after rent house");

return null;




最后，来看看我们的Client类：

public class Client

public static void main(String[] args)

// 我们要代理的真实对象
Subject realSubject = new RealSubject();

// 我们要代理哪个真实对象，就将该对象传进去，最后是通过该真实对象来调用其方法的
InvocationHandler handler = new DynamicProxy(realSubject);

/*
* 通过Proxy的newProxyInstance方法来创建我们的代理对象，我们来看看其三个参数
* 第一个参数 handler.getClass().getClassLoader() ，我们这里使用handler这个类的ClassLoader对象来加载我们的代理对象
* 第二个参数realSubject.getClass().getInterfaces()，我们这里为代理对象提供的接口是真实对象所实行的接口，表示我要代理的是该真实对象，这样我就能调用这组接口中的方法了
* 第三个参数handler， 我们这里将这个代理对象关联到了上方的 InvocationHandler 这个对象上
*/
Subject subject = (Subject)Proxy.newProxyInstance(handler.getClass().getClassLoader(), realSubject
.getClass().getInterfaces(), handler);

System.out.println(subject.getClass().getName());
subject.rent();
subject.hello("world");



我们先来看看控制台的输出：

$Proxy0
before rent house
Method:public abstract void com.xiaoluo.dynamicproxy.Subject.rent()
I want to rent my house
after rent house
before rent house
Method:public abstract void com.xiaoluo.dynamicproxy.Subject.hello(java.lang.String)
hello: world
after rent house

我们首先来看看 $Proxy0 这东西，我们看到，这个东西是由 System.out.println(subject.getClass().getName()); 这条语句打印出来的，那么为什么我们返回的这个代理对象的类名是这样的呢？
Subject subject = (Subject)Proxy.newProxyInstance(handler.getClass().getClassLoader(), realSubject
.getClass().getInterfaces(), handler);

可能我以为返回的这个代理对象会是Subject类型的对象，或者是InvocationHandler的对象，结果却不是，首先我们解释一下为什么我们这里可以将其转化为Subject类型的对象？原因就是在newProxyInstance这个方法的第二个参数上，我们给这个代理对象提供了一组什么接口，那么我这个代理对象就会实现了这组接口，这个时候我们当然可以将这个代理对象强制类型转化为这组接口中的任意一个，因为这里的接口是Subject类型，所以就可以将其转化为Subject类型了。
同时我们一定要记住，通过 Proxy.newProxyInstance 创建的代理对象是在jvm运行时动态生成的一个对象，它并不是我们的InvocationHandler类型，也不是我们定义的那组接口的类型，而是在运行是动态生成的一个对象，并且命名方式都是这样的形式，以$开头，proxy为中，最后一个数字表示对象的标号。
接着我们来看看这两句
subject.rent();
subject.hello("world");
这里是通过代理对象来调用实现的那种接口中的方法，这个时候程序就会跳转到由这个代理对象关联到的 handler 中的invoke方法去执行，而我们的这个 handler 对象又接受了一个 RealSubject类型的参数，表示我要代理的就是这个真实对象，所以此时就会调用 handler 中的invoke方法去执行：

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

//　　在代理真实对象前我们可以添加一些自己的操作
System.out.println("before rent house");

System.out.println("Method:" + method);

// 当代理对象调用真实对象的方法时，其会自动的跳转到代理对象关联的handler对象的invoke方法来进行调用
method.invoke(subject, args);

//　　在代理真实对象后我们也可以添加一些自己的操作
System.out.println("after rent house");

return null;


我们看到，在真正通过代理对象来调用真实对象的方法的时候，我们可以在该方法前后添加自己的一些操作，同时我们看到我们的这个 method 对象是这样的：
public abstract void com.xiaoluo.dynamicproxy.Subject.rent()

public abstract void com.xiaoluo.dynamicproxy.Subject.hello(java.lang.String)

正好就是我们的Subject接口中的两个方法，这也就证明了当我通过代理对象来调用方法的时候，起实际就是委托由其关联到的 handler 对象的invoke方法中来调用，并不是自己来真实调用，而是通过代理的方式来调用的。
这就是我们的java动态代理机制

动态代理Dynamic Proxy

　　代理模式是常用的Java设计模式，他的特征是代理类与委托类有同样的接口，代理类主要负责为委托类

预处理消息，过滤消息，把消息转发给委托类，以及事后处理消息等。

　　代理类与委托类之间通常会存在关联关系，一个代理类的对象与一个委托类的对象关联，代理类的对象本身

并不真正实现服务，而是通过调用委托类的对象的相关方法，来提供特定服务。

 

动态代理类的字节码在程序运行时由Java反射机制动态生成，无需程序员手工编写它的源代码。

Java反射机制可以生成任意类型的动态代理类。java.lang.reflect包中的Proxy类和invocationHandler接口提供了

生成动态代理类的能力。

InvocationHandler接口：

public interface InvocationHandler{

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

　　//　　返回值null　　　　　 1.指被代理的对象2.要调用的方法3.方法调用时所需要的参数

}

 

Proxy类：

是专门完成代理的操作类，可以通过此类为一个或多个接口动态地生成实现类，此类提供了（静态方法）如下的操作方法：

public sattic Object newProxyInstance（ClassLoader  loader,Class<?>[]  interfaces,  InvocationHandler  h）throws IllegalArgumentException

参数说明：ClassLoader  loader：类加载器

　　　　　Class<?>[]  interfaces: 得到全部的接口

　　　　　InvocationHandler  h:得到InvocationHandler接口的子类实例

 

类对象.getClass.getClassLoader();---获得类加载器

 

举例：一个吃饭的例子，我们只管吃饭，把饭前洗手，饭后刷碗的重复事情交给代理类来完成

Dinner.java-----接口

1 package Jun.Proxy;
2 
3 public interface Dinner {
4     public String haveDinner();
5 }

MyDinner.java------自己的实现类-------委托类

 1 package Jun.Proxy;
 2 
 3 public class MyDinner implements Dinner{
 4 
 5     @Override
 6     public String haveDinner() {
 7         System.out.println("妈妈做的饭真好吃。。。。。");
 8         return "真得好吃====";
 9     }
10 
11 }

MyDinnerProxy.java--------代理类

功能就是，给它一个委托类对象，会返回一个代理类对象，使用的是Proxy类的方法

Proxy.newProxyInstance----得到代理类对象（实例）

 1 package Jun.Proxy;
 2 
 3 import java.lang.reflect.InvocationHandler;
 4 import java.lang.reflect.Method;
 5 import java.lang.reflect.Proxy;
 6 
 7 public class MyDinnerProxy implements InvocationHandler{
 8 
 9     private Object originalObject;//被代理的原始对象
10     
11     //绑定原始对象，返回一个代理对象
12     public Object bind(Object obj) {
13         this.originalObject=obj;
14         //里面的参数1：类加载器2：得到全部的接口3：得到InvocationHandler接口的实例---当前对象本身实现的这个接口
15         return Proxy.newProxyInstance(obj.getClass().getClassLoader(), obj.getClass().getInterfaces(), this);
16     }
17     
18     //吃饭之前要执行的方法
19     private void preMethod() {
20         System.out.println("吃饭之前要洗手。。。");
21     }
22     //吃饭之后要执行的方法
23     private void afterMethod() {
24         System.out.println("吃饭之后要刷碗。。。。");
25     }
26     @Override
27     public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
28         preMethod();
29         Object result=method.invoke(this.originalObject, args);
30         afterMethod();
31         //invoke方法返回一个对象
32         System.out.println("hahahahahhaha----"+result);
33         return result;
34     }    
35 }

 

MyDinnerProxyDemo.java-----测试

 1 package Jun.Proxy;
 2 
 3 public class MyDinnerProxyDemo {
 4 
 5     public static void main(String[] args) {
 6         Dinner din=new MyDinner();
 7 //        din.haveDinner();
 8         //代理类的实列
 9         MyDinnerProxy pro=new MyDinnerProxy();
10         //返回了一个代理对象
11         din=(Dinner) pro.bind(din);
12         String str=din.haveDinner();
13         System.out.println("----------------------");
14         System.out.println(str);
15     }
16 }