java進(jìn)階系列-CLassLoader詳解
java進(jìn)階系列-反射詳解
java進(jìn)階系列-動(dòng)態(tài)代理
動(dòng)態(tài)代理的應(yīng)用十分廣泛男摧，很多有名的框架都用到了動(dòng)態(tài)代理刑棵，比如spring aop漆际，mybatis柠新，Hibernate，rpc等等，甚至我們?nèi)粘ｉ_發(fā)中一些非功能性需求--監(jiān)控殊者、 統(tǒng)計(jì)、鑒權(quán)验夯、限流猖吴、事務(wù)、冪等挥转、日志--也是基于動(dòng)態(tài)代理實(shí)現(xiàn)的海蔽。由此可見，掌握動(dòng)態(tài)代理對(duì)我們的開發(fā)工作或閱讀框架源碼是非常有幫助的绑谣。
本文主要介紹Java中兩種常見的動(dòng)態(tài)代理方式：JDK動(dòng)態(tài)代理和CGLIB動(dòng)態(tài)代理党窜。
Java動(dòng)態(tài)代理與java反射關(guān)系緊密，若讀者對(duì)Java反射機(jī)制有些疑問借宵，可參考上一篇文章《java進(jìn)階系列-反射詳解》幌衣。
本文概要：
- 簡(jiǎn)單介紹代理模式
- 比較靜態(tài)代理與動(dòng)態(tài)代理
- JDK動(dòng)態(tài)代理
- CGLIB動(dòng)態(tài)代理
引入需求
UserServiceImpl代碼如下：
public class UserServiceImpl implements UserService {
@Override
public void login(String username, String password) {
System.out.println("歡迎" + username + "登錄！");
}
}
可以看到UserServiceImpl實(shí)現(xiàn)了UserService壤玫，有一個(gè)login方法豁护。
請(qǐng)你設(shè)想一下，現(xiàn)在我們面臨這樣一個(gè)新需求：收集接口請(qǐng)求的原始數(shù)據(jù)欲间，比如記錄方法的訪問時(shí)間楚里，及處理時(shí)長(zhǎng)。
首先分析一下需求猎贴，很明顯這樣的需求與業(yè)務(wù)代碼本身并沒有什么關(guān)系班缎，任何業(yè)務(wù)代碼都可能面臨這種需求，所以直接在login方法中添加代碼的方法她渴，破壞了業(yè)務(wù)類的單一原則达址，也增加了代碼的冗余程度。
為了將框架代碼和業(yè)務(wù)代碼解耦惹骂，代理模式就派上用場(chǎng)了苏携。
代理模式
代理模式(Proxy Design Pattern)：在不改變?cè)碱?(或叫被代理類)代碼的情況下，通過引入代理類來給原始類附加功能对粪。
如果根據(jù)代理類字節(jié)碼的創(chuàng)建時(shí)機(jī)來分類右冻，可以分為靜態(tài)代理和動(dòng)態(tài)代理：
- 靜態(tài)：在程序運(yùn)行前就已經(jīng)存在代理類的字節(jié)碼文件，代理類和原始類的關(guān)系在運(yùn)行前就確定了著拭。
- 動(dòng)態(tài)：代理類源碼是在程序運(yùn)行期間由JVM根據(jù)反射等機(jī)制動(dòng)態(tài)的生成纱扭，所以在運(yùn)行前并不存在代理類的字節(jié)碼文件
靜態(tài)代理
我們首先實(shí)現(xiàn)靜態(tài)代理，添加代理類UserServiceProxy儡遮，同樣實(shí)現(xiàn)UserService接口乳蛾，代理類 UserServiceProxy 負(fù)責(zé)在業(yè)務(wù)代碼執(zhí)行前后附加其他邏輯代碼，并通過委托的方式調(diào)用原始類來執(zhí)行業(yè)務(wù)代碼。具體的代碼實(shí)現(xiàn)如下所示:
public class UserServiceProxy implements UserService {
private UserServiceImpl userService;
public UserServiceProxy(UserServiceImpl userService) {
this.userService = userService;
}
@Override
public void login(String username, String password) {
long startTimestamp = System.currentTimeMillis();
userService.login(username, password);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
System.out.printf("method:%s, startTime:%s, responseTime:%s", "login", startTimestamp, responseTime);
}
}
下面調(diào)用一下試試：
public class DynamicProxyDemo {
public static void main(String[] args) {
staticProxy();
}
private static void staticProxy() {
UserServiceImpl userService = new UserServiceImpl();
UserServiceProxy userServiceProxy = new UserServiceProxy(userService);
userServiceProxy.login("rex", "123");
}
}
執(zhí)行結(jié)果如下：
歡迎rex登錄肃叶！
method:login, startTime:1605756985465, responseTime:1
雖然靜態(tài)代理實(shí)現(xiàn)簡(jiǎn)單蹂随，且不侵入原代碼，但缺點(diǎn)也是很明顯的因惭，試想一下岳锁，隨著我們業(yè)務(wù)系統(tǒng)的逐漸發(fā)展，代碼越來越多蹦魔，難道我們要為每個(gè)原始類都添加一個(gè)代理類嗎激率？
優(yōu)缺點(diǎn)
- 優(yōu)點(diǎn)：代碼結(jié)構(gòu)簡(jiǎn)單，較容易實(shí)現(xiàn)
- 缺點(diǎn)：無法適配所有代理場(chǎng)景勿决，如果有新的需求乒躺，需要修改代理類，「不符合軟件工程的開閉原則」
我們可以使用動(dòng)態(tài)代理(Dynamic Proxy)來解決這個(gè)問題低缩。
動(dòng)態(tài)代理
JDK動(dòng)態(tài)代理嘉冒，有兩個(gè)關(guān)鍵類：java.lang.reflect.InvocationHandler 和 java.lang.reflect.Proxy。
具體的代碼如下所示表制。
package dynamicproxy;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
public class DynamicProxyHandler implements InvocationHandler {
// 原始類
private Object proxied;
public DynamicProxyHandler(Object proxied) {
this.proxied = proxied;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
long startTimestamp = System.currentTimeMillis();
Object obj = method.invoke(proxied, args);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
System.out.printf("method:%s, startTime:%s, responseTime:%s", method.getName(), startTimestamp, responseTime);
return obj;
}
}
invoke() 方法有3個(gè)參數(shù)：
- Object proxy：代理對(duì)象
- Method method：真正執(zhí)行的方法
- Object[] agrs：調(diào)用第二個(gè)參數(shù) method 時(shí)傳入的參數(shù)列表值
生成代理對(duì)象需要用到Proxy類健爬，它可以幫助我們生成任意一個(gè)代理對(duì)象，里面提供一個(gè)靜態(tài)方法newProxyInstance么介。
Proxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h);
實(shí)例化代理對(duì)象時(shí)娜遵，需要傳入3個(gè)參數(shù)：
- ClassLoader loader：加載動(dòng)態(tài)代理類的類加載器
- Class<?>[] interfaces：代理類實(shí)現(xiàn)的接口，可以傳入多個(gè)接口
- InvocationHandler h：指定代理類的「調(diào)用處理程序」壤短，即調(diào)用接口中的方法時(shí)设拟，會(huì)找到該代理工廠h，執(zhí)行invoke()方法
public class DynamicProxyDemo {
public static void main(String[] args) {
dynamicProxy();
}
private static void dynamicProxy() {
// 設(shè)置變量可以保存動(dòng)態(tài)代理類久脯，默認(rèn)名稱以 $Proxy0 格式命名
System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
UserServiceImpl userServiceImpl = new UserServiceImpl();
UserService proxyInstance = (UserService) Proxy.newProxyInstance(UserServiceImpl.class.getClassLoader(),
userServiceImpl.getClass().getInterfaces(), new DynamicProxyHandler(userServiceImpl));
proxyInstance.login("jack", "456");
}
}
執(zhí)行結(jié)果如下：
歡迎jack登錄纳胧！
method:login, startTime:1605759941043, responseTime:0
以上就是我們實(shí)現(xiàn)的動(dòng)態(tài)代理了，相比靜態(tài)代理帘撰，我們不需要重復(fù)實(shí)現(xiàn)代理類跑慕，jdk會(huì)幫助我們動(dòng)態(tài)的實(shí)現(xiàn)代理類。
看下上述代碼的調(diào)用棧信息：
其中摧找，
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//
package com.sun.proxy;
import dynamicproxy.UserService;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
public final class $Proxy0 extends Proxy implements UserService {
private static Method m1;
private static Method m2;
private static Method m3;
private static Method m0;
public $Proxy0(InvocationHandler var1) throws {
super(var1);
}
public final boolean equals(Object var1) throws {
try {
return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
} catch (RuntimeException | Error var3) {
throw var3;
} catch (Throwable var4) {
throw new UndeclaredThrowableException(var4);
}
}
public final String toString() throws {
try {
return (String)super.h.invoke(this, m2, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
public final void login(String var1, String var2) throws {
try {
super.h.invoke(this, m3, new Object[]{var1, var2});
} catch (RuntimeException | Error var4) {
throw var4;
} catch (Throwable var5) {
throw new UndeclaredThrowableException(var5);
}
}
public final int hashCode() throws {
try {
return (Integer)super.h.invoke(this, m0, (Object[])null);
} catch (RuntimeException | Error var2) {
throw var2;
} catch (Throwable var3) {
throw new UndeclaredThrowableException(var3);
}
}
static {
try {
m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
m2 = Class.forName("java.lang.Object").getMethod("toString");
m3 = Class.forName("dynamicproxy.UserService").getMethod("login", Class.forName("java.lang.String"), Class.forName("java.lang.String"));
m0 = Class.forName("java.lang.Object").getMethod("hashCode");
} catch (NoSuchMethodException var2) {
throw new NoSuchMethodError(var2.getMessage());
} catch (ClassNotFoundException var3) {
throw new NoClassDefFoundError(var3.getMessage());
}
}
}
從 $Proxy0 的代碼中我們可以發(fā)現(xiàn)：
- $Proxy0 繼承了 Proxy 類（這也是JDK動(dòng)態(tài)代理為什么不能代理類的直接原因）芝雪，并且實(shí)現(xiàn)了被代理的所有接口，以及equals综苔、hashCode惩系、toString等方法
- $Proxy0 繼承了 Proxy 類位岔， 每個(gè)代理類都有一個(gè)參數(shù)為 InvocationHandler的構(gòu)造方法
- 類和所有方法都被 public final 修飾，所以代理類只可被使用堡牡，不可以再被繼承
- 每個(gè)方法都有一個(gè) Method 對(duì)象來描述抒抬，Method 對(duì)象在static靜態(tài)代碼塊中創(chuàng)建，以 m + 數(shù)字 的格式命名
- 調(diào)用方法的時(shí)候通過 super.h.invoke(this, m1, (Object[])null); 調(diào)用晤柄，其中的 super.h.invoke 實(shí)際上是在創(chuàng)建代理的時(shí)候傳遞給 Proxy.newProxyInstance 的 DynamicProxyHandler 對(duì)象瞧剖，它繼承 InvocationHandler 類，負(fù)責(zé)實(shí)際的調(diào)用處理邏輯
而 DynamicProxyHandler 的 invoke 方法接收到 method可免、args 等參數(shù)后，進(jìn)行一些處理做粤，然后通過反射讓被代理的對(duì)象 proxied 執(zhí)行方法浇借。
Proxy源碼
下面開始分析JDK動(dòng)態(tài)代理生成proxy class流程源碼，Proxy.newProxyInstance() 是生成動(dòng)態(tài)代理對(duì)象的關(guān)鍵怕品，我們可來看看它里面到底干了些什么妇垢，以下代碼分析只貼出主要流程代碼。
/** parameter types of a proxy class constructor */
private static final Class<?>[] constructorParams =
{ InvocationHandler.class };
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)
throws IllegalArgumentException
{
// 省略檢驗(yàn)部分代碼
/*
* 這里是為了得到動(dòng)態(tài)生成的代理類肉康，具體過程稍后分析
* Look up or generate the designated proxy class.
*/
Class<?> cl = getProxyClass0(loader, intfs);
/*
* Invoke its constructor with the designated invocation handler.
*/
try {
/*
* 因?yàn)閯?dòng)態(tài)生成的代理類都繼承了Proxy闯估，所以都有一個(gè)參數(shù)為InvocationHandler的構(gòu)造器
* 通過這個(gè)構(gòu)造器生成代理類的實(shí)例
*/
final Constructor<?> cons = cl.getConstructor(constructorParams);
return cons.newInstance(new Object[]{h});
}
// 省略catch部分代碼
}
可以看到代理類是getProxyClass0方法獲取的：
/**
* Generate a proxy class. Must call the checkProxyAccess method
* to perform permission checks before calling this.
*/
private static Class<?> getProxyClass0(ClassLoader loader,
Class<?>... interfaces) {
if (interfaces.length > 65535) {
throw new IllegalArgumentException("interface limit exceeded");
}
// If the proxy class defined by the given loader implementing
// the given interfaces exists, this will simply return the cached copy;
// otherwise, it will create the proxy class via the ProxyClassFactory
return proxyClassCache.get(loader, interfaces);
}
發(fā)現(xiàn)里面用到一個(gè)緩存 「proxyClassCache」，從結(jié)構(gòu)來看類似于是一個(gè) map 結(jié)構(gòu)吼和，根據(jù)類加載器loader和真實(shí)對(duì)象實(shí)現(xiàn)的接口interfaces查找是否有對(duì)應(yīng)的 Class 對(duì)象涨薪，我們接著往下看 get() 方法。
public V get(K key, P parameter) {
...
Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
...
}
在 get() 方法中炫乓，如果沒有從緩存中獲取到 Class 對(duì)象刚夺，則需要利用 「subKeyFactory」 去實(shí)例化一個(gè)動(dòng)態(tài)代理對(duì)象，subKeyFactory 在這里是「Proxy」 類中「ProxyClassFactory」 內(nèi)部類末捣，由它來創(chuàng)建一個(gè)動(dòng)態(tài)代理類侠姑，所以我們接著去看 ProxyClassFactory 中的 apply() 方法。
public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {
//自動(dòng)生成一個(gè)proxy class箩做，序號(hào)+1
long num = nextUniqueNumber.getAndIncrement();
// 動(dòng)態(tài)代理對(duì)象名拼接莽红！包名 + "$Proxy" + 數(shù)字
String proxyName = proxyPkg + proxyClassNamePrefix + num;
// 生成字節(jié)碼文件，返回一個(gè)字節(jié)數(shù)組
byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
proxyName, interfaces, accessFlags);
try {
// 利用字節(jié)碼文件創(chuàng)建該字節(jié)碼的 Class 類對(duì)象
return defineClass0(loader, proxyName,
proxyClassFile, 0, proxyClassFile.length);
} catch (ClassFormatError e) {
throw new IllegalArgumentException(e.toString());
}
}
apply() 方法中注意有兩個(gè)非常重要的方法：
- ProxyGenerator.generateProxyClass()：它是生成字節(jié)碼文件的方法邦邦，它返回了一個(gè)字節(jié)數(shù)組安吁，字節(jié)碼文件本質(zhì)上就是一個(gè)字節(jié)數(shù)組，所以 proxyClassFile數(shù)組就是一個(gè)字節(jié)碼文件
- defineClass0()：生成字節(jié)碼文件的 Class 對(duì)象圃酵，它是一個(gè) native 本地方法柳畔，調(diào)用操作系統(tǒng)底層的方法創(chuàng)建類對(duì)象
CGLIB動(dòng)態(tài)代理
CGLIB（Code generation Library） 不是 JDK 自帶的動(dòng)態(tài)代理，它需要導(dǎo)入第三方依賴郭赐，它是一個(gè)字節(jié)碼生成類庫(kù)薪韩，能夠在運(yùn)行時(shí)動(dòng)態(tài)生成代理類确沸。
與 JDK 動(dòng)態(tài)代理不同的是，CGLIB不僅能夠?yàn)?Java接口 做代理俘陷，而且能夠?yàn)?strong>普通的 Java類 做代理罗捎。
添加maven依賴：
<dependency>
<groupId>cglib</groupId>
<artifactId>cglib-nodep</artifactId>
<version>3.3.0</version>
</dependency>
CGLIB 代理，有兩個(gè)核心的類：MethodInterceptor接口和Enhancer類拉盾，MethodInterceptor類似于上述的InvocationHandler桨菜，Enhancer類似于Proxy。
下面是具體實(shí)現(xiàn)：
package dynamicproxy;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class DynamicInterceptor implements MethodInterceptor {
/**
* @param o 表示原始類
* @param method 表示被攔截的方法
* @param objects 數(shù)組表示參數(shù)列表捉偏，基本數(shù)據(jù)類型需要傳入其包裝類型倒得，如int-->Integer、long-Long夭禽、double-->Double
* @param methodProxy 表示對(duì)方法的代理霞掺，invokeSuper方法表示對(duì)原始對(duì)象方法的調(diào)用
* @return 執(zhí)行結(jié)果
* @throws Throwable
*/
@Override
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
long startTimestamp = System.currentTimeMillis();
// 注意這里是調(diào)用 invokeSuper 而不是 invoke，否則死循環(huán)讹躯，
// methodProxy.invokeSuper執(zhí)行的是原始類的方法菩彬，
// method.invoke執(zhí)行的是子類的方法
Object result = methodProxy.invokeSuper(o, objects);
long endTimeStamp = System.currentTimeMillis();
long responseTime = endTimeStamp - startTimestamp;
System.out.printf("method:%s, startTime:%s, responseTime:%s", method.getName(), startTimestamp, responseTime);
return result;
}
}
在演示Enhancer前，我們先添加UserServiceWithoutImpl（不再實(shí)現(xiàn)UserService接口）：
package dynamicproxy;
public class UserServiceWithoutImpl {
public void login(String username, String password) {
System.out.println("歡迎" + username + "登錄潮梯！");
}
}
測(cè)試
public class DynamicProxyDemo {
public static void main(String[] args) {
cglibProxy();
}
private static void cglibProxy() {
DynamicInterceptor interceptor = new DynamicInterceptor();
Enhancer enhancer = new Enhancer();
// 設(shè)置超類骗灶，cglib是通過繼承來實(shí)現(xiàn)的
enhancer.setSuperclass(UserServiceWithoutImpl.class);
enhancer.setCallback(interceptor);
UserServiceWithoutImpl userService = (UserServiceWithoutImpl)enhancer.create();
userService.login("mary", "789");
}
}
結(jié)果：
歡迎mary登錄！
method:login, startTime:1605775483020, responseTime:10
CGLIB 創(chuàng)建動(dòng)態(tài)代理類的模式是：
- 查找目標(biāo)類上的所有非final 的public類型的方法定義秉馏；
- 將這些方法的定義轉(zhuǎn)換成字節(jié)碼耙旦；
- 將組成的字節(jié)碼轉(zhuǎn)換成相應(yīng)的代理的class對(duì)象；
- 實(shí)現(xiàn) MethodInterceptor接口萝究，用來處理對(duì)代理類上所有方法的請(qǐng)求
JDK 動(dòng)態(tài)代理 和 CGLIB動(dòng)態(tài)代理 的對(duì)比
| JDK Proxy | CGLIB | |
|---|---|---|
| 代理工廠實(shí)現(xiàn)接口 | InvocationHandler | MethodInterceptor |
| 動(dòng)態(tài)生成代理類 | Proxy | Enhancer |
JDK動(dòng)態(tài)代理：基于Java反射機(jī)制實(shí)現(xiàn)母廷，必須要實(shí)現(xiàn)了接口的業(yè)務(wù)類才能用這種辦法生成代理對(duì)象。
cglib動(dòng)態(tài)代理：基于ASM機(jī)制實(shí)現(xiàn)糊肤，通過生成業(yè)務(wù)類的子類作為代理類琴昆。
JDK Proxy 的優(yōu)勢(shì)：
- 最小化依賴關(guān)系，減少依賴意味著簡(jiǎn)化開發(fā)和維護(hù)馆揉，JDK 本身的支持业舍，可能比 cglib 更加可靠。
- 平滑進(jìn)行 JDK 版本升級(jí)升酣，而字節(jié)碼類庫(kù)通常需要進(jìn)行更新以保證在新版 Java 上能夠使用舷暮。
- 代碼實(shí)現(xiàn)簡(jiǎn)單。
基于 cglib 框架的優(yōu)勢(shì)：
- 無需實(shí)現(xiàn)接口噩茄，達(dá)到代理類無侵入
- 只操作我們關(guān)心的類下面，而不必為其他相關(guān)類增加工作量。
- 高性能
以上代碼已上傳至：github
