首頁 > 軟體

Java 靜態代理與動態代理解析

2022-02-18 16:00:46

靜態代理: 由我們開發者自己手動建立或者在程式執行前就已經存在的代理類,靜態代理通常只代理一個類,動態代理是代理一個介面下的多個實現類。

動態代理: 在程式執行時,運用java反射機制動態建立而成,靜態代理事先知道要代理的是什麼,而動態代理不知道要代理什麼東西,只有在執行時才知道,通常動態代理實現方式是通過實現 jdk 的 InvocationHandler 介面的 ​​invoke​​ 方法

一、程式碼實踐

需要代理的介面:

interface IBook {
    fun toBookName(name: String)
}

靜態代理

class BookImpl : IBook {
    override fun toBookName(name: String) {
        println("書名|$name")
    }
}
// TODO: 2020/11/25 靜態代理最大的特點就是,對於具體的代理提前宣告
class BookProxy(
    private val iBook: IBook,
    private var objStart: () -> Unit = { println("開始前的操作") },
    private var objStop: () -> Unit = { println("結束時的操作") }
) : IBook {
    override fun toBookName(name: String) {
        //我們可以在具體的實現前做一些處理操作
        objStart.invoke()
        iBook.toBookName(name)
        //具體的處理後做一些操作
        objStop.invoke()
    }
}

fun main() {
    val bookProxy = BookProxy(BookImpl())
    bookProxy.toBookName("Android&Petterp")
}

靜態代理相對簡單,也有侷限性,對於代理類我們需要提前宣告,而且每一個代理都需要提前建立好。

動態代理

class BookImpl : IBook {
    override fun toBookName(name: String) {
        println("測試輸出文字$name")
    }
}

/** 用於幫助代理的類
 * BookImplHandler看起來很像一個比較奇怪的代理,實際上其只是用於幫助代理的類,我們最終生產的代理類會把呼叫發給它讓其處理。
 * 代理類本身是通過 Proxy.newProxyInstance() 方法在執行時動態建立
 * */
class BookImplHandler(
    private val book: IBook,
    private var objStart: () -> Unit = { println("開始前的操作") },
    private var objStop: () -> Unit = { println("結束時的操作") }
) :
    InvocationHandler {
    // TODO: 2020/11/25
    //  (1)在invoke方法中接收可變長引數,在Kotlin語法中,陣列是array,可變長引數型別是vararg,型別不匹配。
    //  (2)Kotlin中陣列轉為可變長引數,通過前面加*符號。
    //  (3)如果方法沒有任何引數,args將為null,並將其傳播到Kotlin將導致NullPointerException.
    //  作為一種解決方法,使用*(args?:arrayOfNulls< Any>(0)),並在所描述的極端情況下選擇正確的部分並將其擴充套件為零引數.
    override fun invoke(proxy: Any, method: Method?, args: Array<out Any>?): Any? {
        objStart.invoke()
        val invoke = method?.invoke(book, *(args ?: emptyArray()))
        objStop.invoke()
        return invoke
    }
}

fun main() {
    val bookImplHandler = BookImplHandler(BookImplDynamic())
    val iBook = Proxy.newProxyInstance(
        BookImpl::class.java.classLoader,
        BookImpl::class.java.interfaces, bookImplHandler
    ) as IBook
    iBook.toBookName("測試的文字")
}

二、常見的動態代理場景

Retrofit中的動態代理

使用Retrofit時,當我們使用Retrofit.Builder().create() 時,傳入了我們的介面類,其 ​​create​​ 方法內部就使用了動態代理,從而生成了相應的代理類。

public <T> T create(final Class<T> service) {
  //判斷是否為介面
  validateServiceInterface(service);
  return (T)
      //代理實現
      Proxy.newProxyInstance(
          service.getClassLoader(),
          new Class<?>[] {service},
          new InvocationHandler() {
            ...

            @Override
            public @Nullable Object invoke(Object proxy, Method method, @Nullable Object[] args)
                throws Throwable {
              //如果是object方法,則直接觸發
              if (method.getDeclaringClass() == Object.class) {
                return method.invoke(this, args);
              }
              ...
            }
          });
}

使用動態代理實現 onClick注入

如下所示,我們宣告一個註解,其應用於方法,並加入了一個Activity的擴充套件函數,用於對Activity重所有使用了該註解的方法進行onclick注入, 其方法內部使用反射+動態代理,從而實現。

@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class InjectClick(@IdRes val ids: IntArray)

fun Activity.injectClicks() {
    javaClass.methods.asSequence().filter {
        it.isAnnotationPresent(InjectClick::class.java)
    }.forEach {
        it.isAccessible = true
        it.getAnnotation(InjectClick::class.java).ids.forEach { id ->
            findViewById<View>(id).apply {
                val clickProxy = Proxy.newProxyInstance(
                    javaClass.classLoader, arrayOf(View.OnClickListener::class.java)
                ) { _, _, _ ->
                    it.invoke(this@injectClicks)
                } as View.OnClickListener
                setOnClickListener(clickProxy)
            }
        }
    }
}

三、原始碼探索 Jdk 中的動態代理

動態代理的原始碼實現相對簡單,我們先進入Proxy.newProxyInstance 方法,一探究竟。

Proxy.newProxyInstance
public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
            throws IllegalArgumentException {
        Objects.requireNonNull(h);
        //先克隆一個傳遞過來的代理物件
        final Class<?>[] intfs = interfaces.clone();
        //拿到生成的代理類,內部維護了一個map
        Class<?> cl = getProxyClass0(loader, intfs);
        //獲取代理類建構函式
        final Constructor<?> cons = cl.getConstructor(constructorParams);
        //授予許可權
        if (!Modifier.isPublic(cl.getModifiers())) {
            cons.setAccessible(true);
        }
        //反射建立代理類,並傳入使用者自己實現的中間層介面
        return cons.newInstance(new Object[]{h});
}

具體如上述描述,然後我們自己生成一個代理類,來看看內部的呼叫:

生成代理類

fun writeFileProxy() {
    //IApple是我要代理的介面
    val name = IApple::class.java.name + "Proxy()"
    val bytes = ProxyGenerator.generateProxyClass(name, arrayOf(IApple::class.java))
    val fos = FileOutputStream("$name.class")
    fos.write(bytes)
    fos.close()
}

範例程式碼:

public final class IAppleProxy() extends Proxy implements IApple {

    private static Method m3;

    public IAppleProxy__/* $FF was: IAppleProxy()*/(InvocationHandler var1) throws  {
        super(var1);
    }

    public final void count() throws  {
        try {
            super.h.invoke(this, m3, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    static {
            m3 = Class.forName("com.android.readbook.proxy.IApple").getMethod("count")
    }
}

生成的代理類如上所示,其實現了我們的介面,並且代理了相應的所有方法,這裡做了一部分刪減。

觀察代理類具體方法的話,其具體實現裡,通過InvocationHandler物件,也就是我們自己實現的輔助了,並呼叫其invoke方法, 以介面回撥的方式回撥到我們具體的實現處。整個過程比較容易理解,也並沒有什麼太高深的難度。

四、總結

關於jdk中的動態代理,當我們呼叫 Proxy.newProxyInstance 時,傳入了一個當前類的classLoader以及要代理的介面陣列及實現了InvocationHandler 介面 的輔助類物件,其會在執行時在記憶體中生成一個代理類,這個代理類實現了我們的介面並接收 一個我們外部傳入的 InvocationHandler 輔助類物件,並在具體的方法實現位置通過呼叫輔助類的 ​​invoke​​ 方法,從而實現我們的介面方法代理。

到此這篇關於Java 靜態代理與動態代理解析的文章就介紹到這了,更多相關Java 靜態代理與動態代理內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com