Java 動態代理機制詳解

xiaoluo501395377發表於2016-07-27

在學習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

我們看到這個方法一共接受三個引數,那麼這三個引數分別代表什麼呢?

  • 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.

這個方法的作用就是得到一個動態的代理物件,其接收三個引數,我們來看看這三個引數所代表的含義:

  • 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動態代理機制。

本篇隨筆詳細的講解了java中的動態代理機制,這個知識點非常非常的重要,包括我們Spring的AOP其就是通過動態代理的機制實現的,所以我們必須要好好的理解動態代理的機制。

相關文章