Java實(shí)現(xiàn)JDK動(dòng)態(tài)代理的原理詳解

更新時(shí)間：2022年07月01日 09:57:09 作者：??下崗碼農(nóng)大飛????

這篇文章主要介紹了Java實(shí)現(xiàn)JDK動(dòng)態(tài)代理的原理詳解，Java常用的動(dòng)態(tài)代理模式有JDK動(dòng)態(tài)代理，也有cglib動(dòng)態(tài)代理，本文重點(diǎn)講解JDK的動(dòng)態(tài)代理，需要的小伙伴可以參考一下的相關(guān)資料

概念

代理：為控制A對(duì)象，而創(chuàng)建出新B對(duì)象，由B對(duì)象代替執(zhí)行A對(duì)象所有操作，稱之為代理。一個(gè)代理體系建立涉及到3個(gè)參與角色：真實(shí)對(duì)象(A)，代理對(duì)象(B)，客戶端。

其中的代理對(duì)象(B)起到中介作用，連通真實(shí)對(duì)象(A)與客戶端，如果進(jìn)一步拓展，代理對(duì)象可以實(shí)現(xiàn)更加復(fù)雜邏輯，比如對(duì)真實(shí)對(duì)象進(jìn)行訪問(wèn)控制。

案例

需求：?jiǎn)T工業(yè)務(wù)層接口調(diào)用save需要admin權(quán)限，調(diào)用list不需要權(quán)限，沒(méi)權(quán)限調(diào)用時(shí)拋出異常提示。

靜態(tài)代理

/**
 * 代理接口
 */
public interface IEmployeeService {
    void save();
 
    void list();
}

/**
 * 真實(shí)對(duì)象
 */
public class EmployeeServiceImpl implements IEmployeeService {
    @Override
    public void save() {
        System.out.println("EmployeeServiceImpl-正常的save....");
    }
    @Override
    public void list() {
        System.out.println("EmployeeServiceImpl-正常的list....");
    }
}

/**
 * 模擬當(dāng)前登錄用戶對(duì)象
 */
public class SessionHolder {
    private static String currentUser;
    public static String  getCurrentUser(){
        return currentUser;
    }
    public static void   setCurrentUser(String currentUser){
        SessionHolder.currentUser = currentUser;
    }
}

/**
 * 代理對(duì)象
 */
public class EmployeeProxy implements IEmployeeService {
    //真實(shí)對(duì)象
    private EmployeeServiceImpl employeeService;
    public EmployeeProxy(EmployeeServiceImpl employeeService){
        this.employeeService = employeeService;
    }
    @Override
    public void save() {
        //權(quán)限判斷
        if("admin".equals(SessionHolder.getCurrentUser())){
            employeeService.save();
        }else{
            throw new RuntimeException("當(dāng)前非admin用戶，不能執(zhí)行save操作");
        }
    }
    @Override
    public void list() {
        employeeService.list();
    }
}

public class App {
    public static void main(String[] args) {
        System.out.println("----------------真實(shí)對(duì)象--------------------");
        EmployeeServiceImpl employeeService = new EmployeeServiceImpl();
        employeeService.list();
        employeeService.save();
        System.out.println("----------------代理對(duì)象--------------------");
        SessionHolder.setCurrentUser("dafei");  //設(shè)置權(quán)限(當(dāng)前登錄用戶)
        EmployeeProxy employeeProxy = new EmployeeProxy(employeeService);
        employeeProxy.list();
        employeeProxy.save();
    }
}

----------------真實(shí)對(duì)象--------------------
EmployeeServiceImpl-正常的list....
EmployeeServiceImpl-正常的save....
----------------代理對(duì)象--------------------
EmployeeServiceImpl-正常的list....
Exception in thread "main" java.lang.RuntimeException: 當(dāng)前非admin用戶，不能執(zhí)行save操作
	at com.langfeiyes.pattern.proxy.demo.EmployeeProxy.save(EmployeeProxy.java:20)
	at com.langfeiyes.pattern.proxy.demo.App.main(App.java:16)

使用真實(shí)對(duì)象EmployeeServiceImpl 直接調(diào)用時(shí)，不管是list 還是save都能直接訪問(wèn)，但不符合需求上的admin權(quán)限限制。如果使用代理對(duì)象EmployeeProxy，可以完成需求實(shí)現(xiàn)。

通過(guò)直接創(chuàng)建新類新類代理對(duì)象方式完成代理邏輯，這種方式稱之為靜態(tài)代理模式。

JDK動(dòng)態(tài)代理模式

Java常用的動(dòng)態(tài)代理模式有JDK動(dòng)態(tài)代理，也有cglib動(dòng)態(tài)代理，此處重點(diǎn)講解JDK的動(dòng)態(tài)代理

還是原來(lái)的需求，前面的IEmployeeService EmployeeServiceImpl SessionHolder 都沒(méi)變，新加一個(gè)JDK代理控制器-EmployeeInvocationHandler

/**
 * jdk動(dòng)態(tài)代理控制類，由它牽頭代理類獲取，代理方法的執(zhí)行
 */
public class EmployeeInvocationHandler  implements InvocationHandler {
    //真實(shí)對(duì)象-EmployeeServiceImpl
    private Object target;
    public EmployeeInvocationHandler(Object target){
        this.target = target;
    }
    //獲取jvm在內(nèi)存中生成代理對(duì)象
    public Object getProxy(){
        return  Proxy.newProxyInstance(
                target.getClass().getClassLoader(),
                target.getClass().getInterfaces(),
                this);
    }
    //代理對(duì)象控制執(zhí)行方法
    //參數(shù)1：代理對(duì)象
    //參數(shù)2：真實(shí)對(duì)象的方法（使用方式得到方法對(duì)象）
    //參數(shù)3：真實(shí)對(duì)象方法參數(shù)列表
    //此處是代理對(duì)象對(duì)外暴露的可編輯的方法處理場(chǎng)所，代理對(duì)象每調(diào)用一個(gè)次方法，就會(huì)執(zhí)行一次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("當(dāng)前非admin用戶，不能執(zhí)行save操作");
        }
        return method.invoke(target, args);
    }
}

測(cè)試App類稍微改動(dòng)下：

public class App {
    public static void main(String[] args) {
        System.out.println("----------------真實(shí)對(duì)象--------------------");
        EmployeeServiceImpl employeeService = new EmployeeServiceImpl();
        employeeService.list();
        employeeService.save();
 
        System.out.println("----------------代理對(duì)象--------------------");
        SessionHolder.setCurrentUser("dafei");
        EmployeeInvocationHandler handler = 
            new EmployeeInvocationHandler(employeeService);
        IEmployeeService proxy = (IEmployeeService) handler.getProxy();
        proxy.list();
        proxy.save();
 
    }
}

上面代碼一樣可以實(shí)現(xiàn)需求，跟靜態(tài)代理區(qū)別就在于少創(chuàng)建了代理對(duì)象。此時(shí)存在疑問(wèn)點(diǎn)，沒(méi)有創(chuàng)建代理對(duì)象，為啥可以實(shí)現(xiàn)代理類調(diào)用呢？？

原理分析

先拋出結(jié)論JDK動(dòng)態(tài)代理底層實(shí)現(xiàn)原理：使用接口實(shí)現(xiàn)方式，運(yùn)行時(shí)，在內(nèi)存中動(dòng)態(tài)構(gòu)建出一個(gè)類，然后編譯，執(zhí)行。這個(gè)類是一次性的，JVM停止，代理類就消失。

參與角色 要理解JDK動(dòng)態(tài)代理原理，首先得了解JDK動(dòng)態(tài)代理涉及到的類

InvocationHandler：真實(shí)對(duì)象方法調(diào)用處理器，內(nèi)置invoke方法，其功能：為真實(shí)對(duì)象定制代理邏輯

EmployeeInvocationHandler：?jiǎn)T工服務(wù)真實(shí)對(duì)象方法調(diào)用處理器，此類有3個(gè)用途： 1>設(shè)置真實(shí)對(duì)象

     //真實(shí)對(duì)象-EmployeeServiceImpl
    private Object target;
    public EmployeeInvocationHandler(Object target){
        this.target = target;
    }

2>定制代理方法實(shí)現(xiàn)邏輯

為真實(shí)對(duì)象save方法添加了權(quán)限校驗(yàn)邏輯

    //代理對(duì)象控制執(zhí)行方法
    //參數(shù)1：代理對(duì)象
    //參數(shù)2：真實(shí)對(duì)象的方法（使用方式得到方法對(duì)象）
    //參數(shù)3：真實(shí)對(duì)象方法參數(shù)列表
    //此處是代理對(duì)象對(duì)外暴露的可編輯的方法處理場(chǎng)所，代理對(duì)象每調(diào)用一個(gè)次方法，就會(huì)執(zhí)行一次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("當(dāng)前非admin用戶，不能執(zhí)行save操作");
        }
        return method.invoke(target, args);
    }

3>返回代理對(duì)象

方法執(zhí)行完之后，返回一個(gè)名為：$ProxyX的代理類(其中的X是序號(hào)，一般默認(rèn)為0)，這代理類由JDK動(dòng)態(tài)構(gòu)建出來(lái)。

    //獲取jvm在內(nèi)存中生成代理對(duì)象
    public Object getProxy(){
        return  Proxy.newProxyInstance(
                target.getClass().getClassLoader(),
                target.getClass().getInterfaces(),
                this);
    }

Proxy：動(dòng)態(tài)代理控制類，是JDK動(dòng)態(tài)生成的$ProxyX類的父類，它作用如下：
1>通過(guò)調(diào)用ProxyBuilder 類builder方法構(gòu)建代理對(duì)象類

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>通過(guò)newProxyInstance方法返回$ProxyX類的實(shí)例

   public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h) {
    //...
   }

$Proxy0：App類運(yùn)行時(shí)，JDK動(dòng)態(tài)構(gòu)建出來(lái)的代理類，繼承至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("----------------真實(shí)對(duì)象--------------------");
        EmployeeServiceImpl employeeService = new EmployeeServiceImpl();
        employeeService.list();
        employeeService.save();
        System.out.println("----------------代理對(duì)象--------------------");
        SessionHolder.setCurrentUser("dafei");
        EmployeeInvocationHandler handler = 
                     new EmployeeInvocationHandler(employeeService);
        IEmployeeService proxy = (IEmployeeService) handler.getProxy();
        proxy.list();
        proxy.save();
 
    }
}

默認(rèn)情況下JVM是不保存動(dòng)態(tài)創(chuàng)建代理類字節(jié)碼對(duì)象的，可以在main方法中配置代理參數(shù)讓字節(jié)碼保留

//JDK8之前
System.setProperty("sun.misc.ProxyGenerator.saveGeneratedFiles", "true");
//JDK8之后
System.setProperty("jdk.proxy.ProxyGenerator.saveGeneratedFiles", "true");

執(zhí)行完之后，會(huì)在項(xiàng)目根目錄生成代理類字節(jié)碼對(duì)象。

為了方便解讀，將一些不需要的方法剔除之后

$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的特點(diǎn)：