java动态代理机制小结

Posted 2020-09-01 陈驰字新宇

因为最近学习hadoop中用到了动态代理的相关知识，之前AOP编程也碰到过，所以在这里特地总结一下。

在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.java是一个接口。

package com.darrenchan.entity;

public interface Subject {
    public void rent();

    public void hello(String str);
}

RealSubject.java实现了Subject接口。

package com.darrenchan.entity;

public class RealSubject implements Subject {

    @Override
    public void rent() {
        System.out.println("我想租房子");
    }

    @Override
    public void hello(String str) {
        System.out.println("hello: " + str);
    }

}

下面我们就要实现动态代理类了，DynamicProxy.java。

package com.darrenchan.dynamic;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;

public class DynamicProxy implements InvocationHandler {

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

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

    @Override
    public Object invoke(Object proxy, Method method, Object[] args)
            throws Throwable {
        // 在代理真实对象前我们可以添加一些自己的操作
        System.out.println("租房之前的操作...");

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

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

        // 在代理真实对象后我们也可以添加一些自己的操作
        System.out.println("租房之后的操作...");
        return null;
    }

}

实际上，调用代理对象的所有方法，这时候都会被转化成调用该invoke()方法。

下面我们要生成动态代理实例了，为了使代码更具有普遍性，这里写一个工厂类吧，NewProxyInstanceFactory.java。

package com.darrenchan.factory;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;

import com.darrenchan.dynamic.DynamicProxy;

public class NewProxyInstanceFactory {
    // 为指定的subject生成动态代理对象
    public static Object getProxyInstance(Object subject) {
        // 我们要代理哪个真实对象，就将该对象传进去，最后是通过该真实对象来调用其方法的
        InvocationHandler handler = new DynamicProxy(subject);
        /*
         * 通过Proxy的newProxyInstance方法来创建我们的代理对象，我们来看看其三个参数
         * 第一个参数subject.getClass().getClassLoader()，我们这里使用subject这个类的ClassLoader对象来加载我们的代理对象
         * 第二个参数subject.getClass().getInterfaces()，我们这里为代理对象提供的接口是真实对象所实行的接口，
         * 表示我要代理的是该真实对象，这样我就能调用这组接口中的方法了
         * 第三个参数handler， 我们这里将这个代理对象关联到了上方的InvocationHandler 这个对象上
         */
        return Proxy.newProxyInstance(subject.getClass().getClassLoader(),
                subject.getClass().getInterfaces(), handler);
    }
}

最后我们进行一下测试吧，Client.java。

package com.darrenchan.test;

import com.darrenchan.entity.RealSubject;
import com.darrenchan.entity.Subject;
import com.darrenchan.factory.NewProxyInstanceFactory;

public class Client {
    public static void main(String[] args) {
        // 我们要代理的真实对象
        Subject realSubject = new RealSubject();
    
        Subject subject = (Subject) NewProxyInstanceFactory.getProxyInstance(realSubject);

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

运行结果：

可以看到，执行每个方法之前和之后都插入了相应的操作“租房之前的操作”和“租房之后的操作”。这很有意思，因为我们在程序中并没有以硬编码的方式进行调用，实现了解耦！这就是Spring AOP的核心思想！如图所示：