深入理解【代理模式】原理與技術

本文主要講解靜態代理，動態代理的原理，以及如何使用JDK動態代理，cglib動態代理，最後帶大家手寫jdk動態代理源碼！真正理解動態代理的原理與技術！含Git完整項目地址！ ...

代理模式的定義：為其他對象提供一種代理以控制對這個對象的訪問。

23種常用的面向對象軟體的設計模式之一。代理模式分為靜態代理、動態代理。

如何理解代理模式？

思考抽象問題最好的辦法就是具體化！

比如我們需要為一個業務方法在執行前後記錄日誌，為了達到解耦的目的，我們可以再新建一個類並定義一個新的業務方法，該方法既可以調用原業務方法，又可以在調用前後進行日誌處理，例如：

    CarProxy.class

    public void move() {
        System.out.println("日誌開始記錄....");
        new Car().move();
        System.out.println("日誌記錄完成....");
    }

代理模式的應用很多，比如Spring容器的延遲載入，AOP增強處理等。

一：靜態代理

靜態代理是由程式員創建或工具生成代理類的源碼，再編譯代理類。

所謂靜態也就是在程式運行前就已經存在代理類的位元組碼文件，代理類和委托類的關係在運行前就確定了。

一句話，自己手寫代理類就是靜態代理。

基於繼承的靜態代理

目標對象

public class Car {

    public void move() {
        System.out.println("1.汽車開始跑步");
        System.out.println("2.汽車跑到了終點");
    }

}

代理對象

public class CarProxy extends Car {

    @Override
    public void move() {
        System.out.println("日誌開始記錄....");
        super.move();
        System.out.println("日誌記錄完成....");
    }

}

測試方法

    public static void main(String[] args) {
        Car car = new CarProxy();
        car.move();
    }

基於介面的靜態代理

共同介面

public interface Moveable {
    void move();
}

目標對象

public class Car implements Moveable {

    @Override
    public void move() {
        System.out.println("汽車行駛中....");
    }

}

代理對象

public class CarProxy implements Moveable{
    private Moveable move;
    
    @Override
    public void move() {
        if(move==null){
            move = new Car();
        }
        System.out.println("開始記錄日誌：");
        move.move();
        System.out.println("記錄日誌結束！");
         
    }
}

測試方法

    public static void main(String[] args) throws Exception {
        Moveable m =new CarProxy();
        m.move();
    }

靜態代理的優缺點

優點：

業務類只需要關註業務邏輯本身，保證了業務類的重用性。這是代理的共有優點。

缺點：

1）代理對象的一個介面只服務於一種類型的對象，如果要代理的類型很多，勢必要為每一種類型的方法都進行代理，靜態代理在程式規模稍大時就無法勝任了。

比如Car類的move()方法需要記錄日誌，如果還有汽車，火車，自行車的move()方法也需要記錄日誌，我們都要一個個的去為它們生成代理類，太麻煩了。

2）如果介面增加一個方法，除了所有實現類需要實現這個方法外，所有代理類也需要實現此方法。增加了代碼維護的複雜度。

二：動態代理

動態代理是在實現階段不用關心代理類，而在運行階段才指定哪一個對象。

動態代理類的源碼是在程式運行期間由JVM根據反射等機制動態的生成。

簡單來說，動態代理就是交給程式去生成代理類。

JDK的動態代理

JDK動態代理實現步驟：

創建被代理的類以及實現的介面；
創建一個實現介面InvocationHandler的類，它必須實現invoke方法；

調用Proxy的靜態方法，創建一個代理類：

newProxyInstance(ClassLoader loader,Class[] interface,InvocationHandler h);

通過代理對象調用目標方法。

代碼示例

共同介面

public interface Moveable {
    String move();
}

目標對象

public class Car implements Moveable {

    @Override
    public String move() {
        return "汽車行駛中";
    }

}

每個代理對象都有一個關聯的調用處理程式。當在代理對象上調用目標方法時，將對方法調用進行編碼並將其分配給其實現InvocationHandler介面的invoke方法。

實現InvocationHandler介面步驟：

定義含參構造方法，該參數為要代理的實例對象，目的是用於執行method.invoke()方法（也就是執行目標方法）
實現介面的invoke()方法，該方法用於對目標方法的增強處理，比如記錄日誌等。該方法的返回值就是代理對象執行目標方法的返回值。具體參數：

proxy 動態生成的代理對象

method 目標方法的實例

args 目標方法的參數

public class LogHandler implements InvocationHandler{
    private Object target;
    
    public LogHandler(Object object){
        super();
        this.target =  object;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        //增強處理
        Object o = method.invoke(target,args);
        //增強處理
        return o;
    }

}

通過調用Proxy.newProxyInstance方法生成代理對象，具體參數有：

loader 目標類的類載入器
interfaces 目標類實現的介面
InvocationHandler 調用處理程式的實現對象

public static void main(String[] args) {
    Moveable move =  (Moveable) Proxy.newProxyInstance(Car.class.getClassLoader(), Car.class.getInterfaces(), new LogHandler(new Car()));
    
    System.out.println("代理對象:"+move.getClass().getName());
    System.out.println("執行方法:"+move.move());
}

列印結果

代理對象:com.sun.proxy.$Proxy0
執行方法:汽車行駛中

總結

JDK的動態代理只能代理實現了介面的類，沒有實現介面的類不能實現動態代理。

cglib的動態代理

引用cglib的依賴包

<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib-nodep</artifactId>
    <version>2.2</version>
</dependency>

為了方便思考它的原理，我把執行步驟按順序寫下

    public static void main(String[] args) {
        Enhancer enhancer = new Enhancer();
        //設置父類，被代理類（這裡是Car.class）
        enhancer.setSuperclass(Car.class);
        //設置回調函數
        enhancer.setCallback(new MethodInterceptor() {
            @Override
            public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
                //增強處理...
                Object o= proxy.invokeSuper(obj, args);//代理類調用父類的方法
                //增強處理...
                return o;
            }
        });
        //創建代理類並使用回調（用父類Car去引用）
        Car car = (Car) enhancer.create();
        //執行目標方法
        System.out.println(car.move());
    }

方法攔截器

實現MethodInterceptor介面的intercept方法後，所有生成的代理方法都調用這個方法。

intercept方法的具體參數有

obj 目標類的實例
method 目標方法實例（通過反射獲取的目標方法實例）
args 目標方法的參數
proxy 代理類的實例

該方法的返回值就是目標方法的返回值。

總結

cglib的動態代理是針對類來實現代理。
對指定目標類產生一個子類，通過方法攔截技術攔截所有父類方法的調用。
因為是通過繼承實現，final類無法使用。

三：手寫JDK動態代理源碼

從上面可以看到JDK動態代理的核心代碼在於Proxy.newProxyInstance方法。

Moveable m = (Moveable)Proxy.newProxyInstance(Car.class,new InvocationHandler());

實現原理

聲明一段源碼，源碼動態產生動態代理
源碼產生java文件，對java文件進行編譯
得到編譯生成後的class文件
把class文件load到記憶體之中，產生代理類對象返回即可。

下麵附我手寫的源碼！

生產代理對象類，核心類！難點，思路都在這裡~

public class Proxy {

    /**
     * 生產代理對象
     * @param clazz
     * @param h
     * @return
     * @throws Exception
     */
    public static Object newProxyInstance(Class clazz,InvocationHandler h) throws Exception{
        //代理類類名
        String cname = clazz.getName().substring(clazz.getName().lastIndexOf(".")+1) + "$Proxy0";
        //手寫代理類源碼
        StringBuilder source = getSource(clazz, h, cname);
        //產生代理類的java文件
        String filename = Thread.currentThread().getContextClassLoader().getResource("").getPath()
                + clazz.getPackage().getName().replaceAll("\\.", "/") +"/"+cname+".java";
        System.out.println(filename);
        //把源碼寫入到文件中
        File file = new File(filename);
        FileUtil.writeStringToFile(file, source.toString());
        //編譯
        //拿到編譯器
        JavaCompiler complier = ToolProvider.getSystemJavaCompiler();
        //文件管理者
        StandardJavaFileManager fileMgr =
                complier.getStandardFileManager(null, null, null);
        //獲取文件
        Iterable units = fileMgr.getJavaFileObjects(filename);
        //編譯任務
        CompilationTask t = complier.getTask(null, fileMgr, null, null, null, units);
        //進行編譯
        t.call();
        fileMgr.close();
        //load 到記憶體
        ClassLoader cl = ClassLoader.getSystemClassLoader();
        Class<?> c = cl.loadClass(clazz.getPackage().getName() + "."+cname);
        //獲取構造函數Constructor
        Constructor<?> ctr = c.getConstructor(h.getClass());
        return ctr.newInstance(h);
    }

    /**
     * 手寫代理類源碼
     * @param clazz
     * @param h
     * @param cname
     * @return
     */
    private static StringBuilder getSource(Class clazz, InvocationHandler h, String cname) {
        //調用處理介面
        String handler = h.getClass().getName();
        //換行符號
        String line = "\r\n";
        String space = " ";
        //代理類源碼
        StringBuilder source = new StringBuilder();
        //包聲明
        source.append("package" + space + clazz.getPackage().getName() + ";").append(line);
        //獲取類的名稱
        source.append(Modifier.toString(clazz.getModifiers()) + space + "class" + space + cname + space);
        //繼承介面
        source.append("implements" + space);
        Class[] interfaces = clazz.getInterfaces();
        for (int i = 0; i < interfaces.length; i++) {
            source.append(interfaces[i].getName());
            if (i != interfaces.length - 1) {
                source.append(",");
            }
        }
        source.append("{").append(line);
        //聲明變數
        source.append("private " + handler + " h;").append(line);
        //構造方法
        source.append("public " + cname + "(" + handler + " h){").append(line);
        source.append("this.h=h;").append(line).append("}").append(line);
        //實現所有方法
        Method[] methods = clazz.getDeclaredMethods();
        for (Method method : methods) {
            //獲取方法返回類型
            Class returnType = method.getReturnType();
            //獲取方法上的所有註釋
            Annotation[] annotations = method.getDeclaredAnnotations();
            for (Annotation annotation : annotations) {
                //列印註釋類型
                source.append("@" + annotation.annotationType().getName()).append(line);
            }
            //列印方法聲明
            source.append(Modifier.toString(method.getModifiers()) + " " + returnType.getName() + " " + method.getName() + "(");
            //獲取方法的所有參數
            Parameter[] parameters = method.getParameters();
            //參數字元串
            StringBuilder args = new StringBuilder();
            for (int i = 0; i < parameters.length; i++) {
                //參數的類型，形參（全是arg123..）
                source.append(parameters[i].getType().getName() + " " + parameters[i].getName());
                args.append(parameters[i].getName());
                if (i != parameters.length - 1) {
                    source.append(",");
                    args.append(",");
                }
            }
            source.append("){").append(line);
            //方法邏輯
            source.append("Object obj=null; \n try {").append(line);
            source.append("Class[] args = new Class[]{" + args + "};").append(line);
            source.append(Method.class.getName()+" method = " + clazz.getName() + ".class.getMethod(\"" + method.getName() + "\",args);").append(line);
            source.append("obj = h.invoke(this,method,args);").append(line);
            source.append("} catch (Exception e) {\n" + "e.printStackTrace();\n" + "}catch (Throwable throwable) {\n" +
                    "throwable.printStackTrace();\n" + "}").append(line);
            //方法結束
            source.append("return (obj!=null)?("+returnType.getName()+")obj:null;\n}").append(line);
        }
        //類結束
        source.append("}");
        return source;
    }


}

單元測試

    public static void main(String[] args) throws Exception {
        Moveable m = (Moveable) Proxy.newProxyInstance(Car.class, new TimeHandler(new Car()));
        String s = m.move();
        System.out.println(s);
    }

測試結果

/D:/IDEA/workSpace/myJdkProxy/target/classes/cn/zyzpp/client/Car$Proxy0.java
開始記錄時間
汽車行駛中....
耗時：481毫秒！
success

我只測試了部分，有bug在所難免啦~~~！

項目地址：Github