Java動態代理&&源碼分析

Java動態代理&&源碼分析

要了解動態代理，肯定跳不過靜態代理，下面將介紹一下靜態代理

1 靜態代理

1.1 繼承

假設一個系統中有一個Person接口，你需要使用這個接口來實現你自己需要的實體類

Person接口

public interface Person {
    void show();
}

系統中出現了一個警察，那我就定義一個警察類實現Person接口

PoliceMan類

public class PoliceMan implements Person{

    @Override
    public void show() {
        System.out.println("我是一名警察");
    }
}

又出現了一名商人，嗯，還是按照老方法，定義一個商人類實現Person接口

Trader

public class Trader implements Person {

    @Override
    public void show() {
        System.out.println("我是一個商人");
    }
}

突然出現了一個經歷豐富的人，他以前是一個商人，但現在是程序員o(￣︶￣)o，那沒辦法只能新建一個類了

TraderAndProgrammer

public class TraderAndProgrammer extends Trader{
    @Override
    public void show() {
        super.show();
        System.out.println("我現在是程序員");
    }
}

但是如果照這樣下去，出現了一個以前是程序員，現在是商人的人怎麼辦？如果我們還想增加一個描述，描述他們都是一個普通人怎麼辦？難道還是新建一個類繼承（或實現）父類嗎？這樣類不是越來越多嗎（類爆炸）？

1.2 聚合

OrdinaryPerson

public class OrdinaryPerson implements Person {

    private Person person;

    //持有一個Person類，根據具體傳入的類進行代理
    public OrdinaryPerson(Person person) {
        this.person = person;
    }

    @Override
    public void show() {
        System.out.println("我曾經是一個普通人");
        person.show();
    }
}

測試類

public class PersonTest {

    public static void main(String[] args) {
        OrdinaryPerson ordinaryPerson = new OrdinaryPerson(new PoliceMan());
        ordinaryPerson.show();
        System.out.println("---------------");
        OrdinaryPerson ordinaryPerson1 = new OrdinaryPerson(new Trader());
        ordinaryPerson1.show();
    }
}

使用這種聚合的方式，我就可以給所有人都增加一個描述（一個普通人），而不用重新寫類來繼承了。

但是如果需要新的功能，還是需要寫新的類，還是存在着類爆炸的問題。

並且只能代理一種類型，如果其他類型需要代理還需要寫新的代理類。

代理類和委託類實現了相同的接口，代理類通過委託類實現了相同的方法。如果接口增加一個方法，除了所有實現類需要實現這個方法外，所有代理類也需要實現此方法。增加了代碼維護的複雜度

2 動態代理

2.1 動態代理例子

interface Subject{
    void action(String action);
}

class RealSubject implements Subject {
    @Override
    public void action(String action) {
        System.out.println(action);
    }
}

class MyInvocationHandler implements InvocationHandler {

    Object object;

    public Object bind(Object obj) {
        this.object = obj;
        return Proxy.newProxyInstance(obj.getClass().getClassLoader(),obj.getClass().getInterfaces(),this);
    }

    //傳遞進來的代理對象，用來區分請求的來源
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        
        //注意這裏參數是object,使用戶傳入的實際對象
        //如果寫成proxy，會循環的調用代理對象的相應方法，會報錯
        Object invoke = method.invoke(object, args);
        return invoke;
    }
}

public class TestProxy {

    public static void main(String[] args) {
        RealSubject realSubject = new RealSubject();

        MyInvocationHandler myInvocationHandler = new MyInvocationHandler();

        //這裏傳入的類並不侷限於Subject的實現類，也可以是其他接口的實現類
        //返回的對象是一個動態生成的代理對象
        Subject bind = (Subject)myInvocationHandler.bind(realSubject);
        bind.action("action方法執行");
    }

}

如果method.invoke()傳入proxy,會出現下面這種情況

通過調用靜態方法Proxy.newProxyInstance()可以創建動態代理，這個方法需要的到一個類加載器，一個希望該代理實現的接口列表（不是類或抽象類）（動態生成的代理類繼承了Proxy這個類，根據Java的單繼承機制，所以不能再通過繼承來實現代理了），以及InvocationHandler接口的一個實現。動態代理可以將所有調用重定向到調用處理器，因此會向調用處理器的構造器傳遞一個“實際”對象的引用，從而使得調用處理器在執行中介任務時，可以將請求轉發給實際對象。

2.2 源碼分析

跟蹤Proxy.newProxyInstance()方法

@CallerSensitive
    public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)
        throws IllegalArgumentException
    {
        Objects.requireNonNull(h);

        final Class<?>[] intfs = interfaces.clone();
        final SecurityManager sm = System.getSecurityManager();
        if (sm != null) {
            checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
        }

        /*
         * Look up or generate the designated proxy class.
         */
         
         //得到代理類的Class,後面根據Class反射生成相應的實例
        Class<?> cl = getProxyClass0(loader, intfs);

        /*
         * Invoke its constructor with the designated invocation handler.
         */
        try {
            if (sm != null) {
                checkNewProxyPermission(Reflection.getCallerClass(), cl);
            }

			//得到相應的構造方法
            final Constructor<?> cons = cl.getConstructor(constructorParams);
            //將傳入的InvocationHandler複製給變量
            final InvocationHandler ih = h;
            if (!Modifier.isPublic(cl.getModifiers())) {
                AccessController.doPrivileged(new PrivilegedAction<Void>() {
                    public Void run() {
                        cons.setAccessible(true);
                        return null;
                    }
                });
            }
            
            //根據構造方法創建相應的實例
            return cons.newInstance(new Object[]{h});
        } catch (IllegalAccessException|InstantiationException e) {
            throw new InternalError(e.toString(), e);
        } catch (InvocationTargetException e) {
            Throwable t = e.getCause();
            if (t instanceof RuntimeException) {
                throw (RuntimeException) t;
            } else {
                throw new InternalError(t.toString(), t);
            }
        } catch (NoSuchMethodException e) {
            throw new InternalError(e.toString(), e);
        }
    }

跟蹤進getProxyClass0（），最後到達關鍵方法

Proxy類

@Override
        public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {

            Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
            for (Class<?> intf : interfaces) {
                /*
                 * Verify that the class loader resolves the name of this
                 * interface to the same Class object.
                 */
                Class<?> interfaceClass = null;
                try {
                    interfaceClass = Class.forName(intf.getName(), false, loader);
                } catch (ClassNotFoundException e) {
                }
                if (interfaceClass != intf) {
                    throw new IllegalArgumentException(
                        intf + " is not visible from class loader");
                }
                /*
                 * Verify that the Class object actually represents an
                 * interface.
                 */
                if (!interfaceClass.isInterface()) {
                    throw new IllegalArgumentException(
                        interfaceClass.getName() + " is not an interface");
                }
                /*
                 * Verify that this interface is not a duplicate.
                 */
                if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
                    throw new IllegalArgumentException(
                        "repeated interface: " + interfaceClass.getName());
                }
            }

            String proxyPkg = null;     // package to define proxy class in
            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;

            /*
             * Record the package of a non-public proxy interface so that the
             * proxy class will be defined in the same package.  Verify that
             * all non-public proxy interfaces are in the same package.
             */
            //如果不是public修飾的接口，則生成在與接口相同的包下面
            for (Class<?> intf : interfaces) {
                int flags = intf.getModifiers();
                if (!Modifier.isPublic(flags)) {
                    accessFlags = Modifier.FINAL;
                    String name = intf.getName();
                    int n = name.lastIndexOf('.');
                    String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
                    if (proxyPkg == null) {
                        proxyPkg = pkg;
                    } else if (!pkg.equals(proxyPkg)) {
                        throw new IllegalArgumentException(
                            "non-public interfaces from different packages");
                    }
                }
            }

            if (proxyPkg == null) {
                // if no non-public proxy interfaces, use com.sun.proxy package
                proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
            }

            /*
             * Choose a name for the proxy class to generate.
             */
            //代理類的名字
            long num = nextUniqueNumber.getAndIncrement();
            String proxyName = proxyPkg + proxyClassNamePrefix + num;

            /*
             * Generate the specified proxy class.
             */
            //生成代理類的字節碼
            byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
                proxyName, interfaces, accessFlags);
            try {
                return defineClass0(loader, proxyName,
                                    proxyClassFile, 0, proxyClassFile.length);
            } catch (ClassFormatError e) {
                /*
                 * A ClassFormatError here means that (barring bugs in the
                 * proxy class generation code) there was some other
                 * invalid aspect of the arguments supplied to the proxy
                 * class creation (such as virtual machine limitations
                 * exceeded).
                 */
                throw new IllegalArgumentException(e.toString());
            }
        }
    }

那我們就利用這個方法來看一下動態生成的代理類長什麼樣子，利用Java提供的ProxyGenerator.generateProxyClass（）方法生成代理類的字節碼

public class TestProxy {

    public static void main(String[] args) {
        RealSubject realSubject = new RealSubject();

        //關鍵的生成代理類字節碼的代碼
        //第一個參數：代理類的名字
        //第二個參數：目標類實現的接口(JDK動態代理時，這是用戶傳入的)
        byte[] $Proxy01s = ProxyGenerator.generateProxyClass("$Proxy01", realSubject.getClass().getInterfaces());
        
        try {
            FileOutputStream fileOutputStream = new FileOutputStream("E:\\$Proxy01.class");
            fileOutputStream.write($Proxy01s);
            fileOutputStream.flush();
            fileOutputStream.close();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

}

反編譯$Proxy01.class生成的代碼如下：

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;
import proxy.Subject;

public final class $Proxy01 extends Proxy implements Subject {
    private static Method m1;
    private static Method m2;
    private static Method m0;
    private static Method m3;

    //在得到$Proxy01的實例時，將InvocationHandler傳給了父類Proxy
    public $Proxy01(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 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);
        }
    }

    public final void action() throws  {
        try {
            //this指$Proxy01實例原本這個代理
            //m3方法就是實現了Subject這個接口後實現的方法
            //(Object[])null是方法的參數，參數可能有多個，用數組接收
            //如果參數不爲空，則new一個數組出來 new Object[]{var1}
            //調用父類Proxy的InvocationHandler的invoke方法，這個InvocationHandler是用戶自己實現
            //的，通過Proxy.newProxyInstance()傳入的。
            super.h.invoke(this, m3, (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");
            m0 = Class.forName("java.lang.Object").getMethod("hashCode");
            m3 = Class.forName("proxy.Subject").getMethod("action");
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}