Java實現JDK動態代理的原理詳解
概念
代理：為控制A對象，而創建出新B對象，由B對象代替執行A對象所有操作，稱之為代理。一個代理體系建立涉及到3個參與角色：真實對象(A)，代理對象(B)，客戶端。
其中的代理對象(B)起到中介作用，連通真實對象(A)與客戶端，如果進一步拓展，代理對象可以實現更加復雜邏輯，比如對真實對象進行訪問控制。
案例
需求：員工業務層接口調用save需要admin權限，調用list不需要權限，沒權限調用時拋出異常提示。
靜態代理
/**
* 代理接口
*/
public interface IEmployeeService {
void save();
void list();
}
/**
* 真實對象
*/
public class EmployeeServiceImpl implements IEmployeeService {
@Override
public void save() {
System.out.println("EmployeeServiceImpl-正常的save....");
}
@Override
public void list() {
System.out.println("EmployeeServiceImpl-正常的list....");
}
}
/**
* 模擬當前登錄用戶對象
*/
public class SessionHolder {
private static String currentUser;
public static String getCurrentUser(){
return currentUser;
}
public static void setCurrentUser(String currentUser){
SessionHolder.currentUser = currentUser;
}
}
/**
* 代理對象
*/
public class EmployeeProxy implements IEmployeeService {
//真實對象
private EmployeeServiceImpl employeeService;
public EmployeeProxy(EmployeeServiceImpl employeeService){
this.employeeService = employeeService;
}
@Override
public void save() {
//權限判斷
if("admin".equals(SessionHolder.getCurrentUser())){
employeeService.save();
}else{
throw new RuntimeException("當前非admin用戶，不能執行save操作");
}
}
@Override
public void list() {
employeeService.list();
}
}
public class App {
public static void main(String[] args) {
System.out.println("----------------真實對象--------------------");
EmployeeServiceImpl employeeService = new EmployeeServiceImpl();
employeeService.list();
employeeService.save();
System.out.println("----------------代理對象--------------------");
SessionHolder.setCurrentUser("dafei"); //設置權限(當前登錄用戶)
EmployeeProxy employeeProxy = new EmployeeProxy(employeeService);
employeeProxy.list();
employeeProxy.save();
}
}
----------------真實對象-------------------- EmployeeServiceImpl-正常的list.... EmployeeServiceImpl-正常的save.... ----------------代理對象-------------------- EmployeeServiceImpl-正常的list.... Exception in thread "main" java.lang.RuntimeException: 當前非admin用戶，不能執行save操作 at com.langfeiyes.pattern.proxy.demo.EmployeeProxy.save(EmployeeProxy.java:20) at com.langfeiyes.pattern.proxy.demo.App.main(App.java:16)
使用真實對象EmployeeServiceImpl 直接調用時，不管是list 還是save都能直接訪問，但不符合需求上的admin權限限制。如果使用代理對象EmployeeProxy，可以完成需求實現。
通過直接創建新類新類代理對象方式完成代理邏輯，這種方式稱之為靜態代理模式。
JDK動態代理模式
Java常用的動態代理模式有JDK動態代理，也有cglib動態代理，此處重點講解JDK的動態代理
還是原來的需求，前面的IEmployeeService EmployeeServiceImpl SessionHolder 都沒變，新加一個JDK代理控制器-EmployeeInvocationHandler
/**
* jdk動態代理控制類，由它牽頭代理類獲取，代理方法的執行
*/
public class EmployeeInvocationHandler implements InvocationHandler {
//真實對象-EmployeeServiceImpl
private Object target;
public EmployeeInvocationHandler(Object target){
this.target = target;
}
//獲取jvm在內存中生成代理對象
public Object getProxy(){
return Proxy.newProxyInstance(
target.getClass().getClassLoader(),
target.getClass().getInterfaces(),
this);
}
//代理對象控制執行方法
//參數1：代理對象
//參數2：真實對象的方法（使用方式得到方法對象）
//參數3：真實對象方法參數列表
//此處是代理對象對外暴露的可編輯的方法處理場所，代理對象每調用一個次方法，就會執行一次invoke
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
String name = method.getName();
if("save".equals(name) && !"admin".equals(SessionHolder.getCurrentUser())){
throw new RuntimeException("當前非admin用戶，不能執行save操作");
}
return method.invoke(target, args);
}
}
測試App類稍微改動下：
public class App {
public static void main(String[] args) {
System.out.println("----------------真實對象--------------------");
EmployeeServiceImpl employeeService = new EmployeeServiceImpl();
employeeService.list();
employeeService.save();
System.out.println("----------------代理對象--------------------");
SessionHolder.setCurrentUser("dafei");
EmployeeInvocationHandler handler =
new EmployeeInvocationHandler(employeeService);
IEmployeeService proxy = (IEmployeeService) handler.getProxy();
proxy.list();
proxy.save();
}
}
上面代碼一樣可以實現需求，跟靜態代理區別就在於少創建瞭代理對象。此時存在疑問點，沒有創建代理對象，為啥可以實現代理類調用呢？？
原理分析
先拋出結論JDK動態代理底層實現原理：使用接口實現方式，運行時，在內存中動態構建出一個類，然後編譯，執行。這個類是一次性的，JVM停止，代理類就消失。
參與角色 要理解JDK動態代理原理，首先得瞭解JDK動態代理涉及到的類
InvocationHandler：真實對象方法調用處理器，內置invoke方法，其功能：為真實對象定制代理邏輯
EmployeeInvocationHandler：員工服務真實對象方法調用處理器，此類有3個用途： 1>設置真實對象
//真實對象-EmployeeServiceImpl
private Object target;
public EmployeeInvocationHandler(Object target){
this.target = target;
}
2>定制代理方法實現邏輯
為真實對象save方法添加瞭權限校驗邏輯
//代理對象控制執行方法
//參數1：代理對象
//參數2：真實對象的方法（使用方式得到方法對象）
//參數3：真實對象方法參數列表
//此處是代理對象對外暴露的可編輯的方法處理場所，代理對象每調用一個次方法，就會執行一次invoke
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
String name = method.getName();
if("save".equals(name) && !"admin".equals(SessionHolder.getCurrentUser())){
throw new RuntimeException("當前非admin用戶，不能執行save操作");
}
return method.invoke(target, args);
}
3>返回代理對象
方法執行完之後，返回一個名為：$ProxyX的代理類(其中的X是序號，一般默認為0)，這代理類由JDK動態構建出來。
//獲取jvm在內存中生成代理對象
public Object getProxy(){
return Proxy.newProxyInstance(
target.getClass().getClassLoader(),
target.getClass().getInterfaces(),
this);
}
Proxy：動態代理控制類，是JDK動態生成的$ProxyX類的父類，它作用如下：
1>通過調用ProxyBuilder 類builder方法構建代理對象類
private static Constructor<?> getProxyConstructor(Class<?> caller,
ClassLoader loader,
Class<?>... interfaces){
return proxyCache.sub(intf).computeIfAbsent(
loader,
(ld, clv) -> new ProxyBuilder(ld, clv.key()).build()
);
}
2>通過newProxyInstance方法返回$ProxyX類的實例
public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h) {
//...
}
$Proxy0：App類運行時，JDK動態構建出來的代理類，繼承至Proxy類
public class App {
public static void main(String[] args) {
//System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
System.setProperty("jdk.proxy.ProxyGenerator.saveGeneratedFiles", "true");
System.out.println("----------------真實對象--------------------");
EmployeeServiceImpl employeeService = new EmployeeServiceImpl();
employeeService.list();
employeeService.save();
System.out.println("----------------代理對象--------------------");
SessionHolder.setCurrentUser("dafei");
EmployeeInvocationHandler handler =
new EmployeeInvocationHandler(employeeService);
IEmployeeService proxy = (IEmployeeService) handler.getProxy();
proxy.list();
proxy.save();
}
}
默認情況下JVM是不保存動態創建代理類字節碼對象的，可以在main方法中配置代理參數讓字節碼保留
//JDK8之前
System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
//JDK8之後
System.setProperty("jdk.proxy.ProxyGenerator.saveGeneratedFiles", "true");
執行完之後，會在項目根目錄生成代理類字節碼對象。
為瞭方便解讀，將一些不需要的方法剔除之後
$Proxy0類
public class $Proxy0 extends Proxy implements IEmployeeService {
private static Method m4;
private static Method m3;
static {
try {
m4 = Class.forName("com.langfeiyes.proxy.demo.IEmployeeService")
.getMethod("save");
m3 = Class.forName("com.langfeiyes.proxy.demo.IEmployeeService")
.getMethod("list");
} catch (Exception e) {
e.printStackTrace();
}
}
public $Proxy0(InvocationHandler var1) throws Throwable {
super(var1);
}
public final void save() throws Throwable {
super.h.invoke(this, m4, (Object[])null);
}
public final void list() throws Throwable{
super.h.invoke(this, m3, (Object[])null);
}
}
從源碼上看，$Proxy0的特點：
- 1>繼承瞭Proxy類，實現瞭IEmployeeService 接口
- 2>通過靜態塊的方式反射IEmployeeService接口save與list方法，得到他們的方法對象Method
- 3>調用父類構造器，需要傳入InvocationHandler 參數
- 4>重寫IEmployeeService接口的save list方法靠的是父類Proxy的h屬性.invoke方法
真相大白
下圖所有參與動態代理的類：
下圖是上圖的操作時序圖，跟著走就對瞭
到這，JDK動態代理就ok瞭。