代理
代理是英文 Proxy 翻譯過來的。我們在生活中見到過的代理，大概最常見的就是朋友圈中賣面膜的同學了。
她們從廠家拿貨，然后在朋友圈中宣傳，然后賣給熟人。
按理說，顧客可以直接從廠家購買產品，但是現實生活中，很少有這樣的銷售模式。一般都是廠家委托給代理商進行銷售，顧客跟代理商打交道，而不直接與產品實際生產者進行關聯。
所以，代理就有一種中間人的味道。
接下來，我們說說軟件中的代理模式。
代理模式
代理模式是面向對象編程中比較常見的設計模式。
這是常見代理模式常見的 UML 示意圖。
需要注意的有下面幾點：
1. 用戶只關心接口功能，而不在乎誰提供了功能。上圖中接口是 Subject。
2. 接口真正實現者是上圖的 RealSubject，但是它不與用戶直接接觸，而是通過代理。
3. 代理就是上圖中的 Proxy，由於它實現了 Subject 接口，所以它能夠直接與用戶接觸。
4. 用戶調用 Proxy 的時候，Proxy 內部調用了 RealSubject。所以，Proxy 是中介者，它可以增強 RealSubject 操作。
如果難於理解的話，我用事例說明好了。值得注意的是，代理可以分為靜態代理和動態代理兩種。先從靜態代理講起。
靜態代理
我們平常去電影院看電影的時候，在電影開始的階段是不是經常會放廣告呢？
電影是電影公司委托給影院進行播放的，但是影院可以在播放電影的時候，產生一些自己的經濟收益，比如賣爆米花、可樂等，然后在影片開始結束時播放一些廣告。
現在用代碼來進行模擬。
首先得有一個接口，通用的接口是代理模式實現的基礎。這個接口我們命名為 Movie，代表電影播放的能力。
1 package com.frank.test; 2 3 public interface Movie { 4 void play(); 5 }
然后，我們要有一個真正的實現這個 Movie 接口的類，和一個只是實現接口的代理類。
package com.frank.test; public class RealMovie implements Movie { @Override public void play() { // TODO Auto-generated method stub System.out.println("您正在觀看電影 《肖申克的救贖》"); } }
這個表示真正的影片。它實現了 Movie 接口，play() 方法調用時，影片就開始播放。那么 Proxy 代理呢？
1 package com.frank.test; 2 3 public class Cinema implements Movie { 4 5 RealMovie movie; 6 7 public Cinema(RealMovie movie) { 8 super(); 9 this.movie = movie; 10 } 11 12 13 @Override 14 public void play() { 15 16 guanggao(true); 17 18 movie.play(); 19 20 guanggao(false); 21 } 22 23 public void guanggao(boolean isStart){ 24 if ( isStart ) { 25 System.out.println("電影馬上開始了，爆米花、可樂、口香糖9.8折，快來買啊！"); 26 } else { 27 System.out.println("電影馬上結束了，爆米花、可樂、口香糖9.8折，買回家吃吧！"); 28 } 29 } 30 31 }
Cinema 就是 Proxy 代理對象，它有一個 play() 方法。不過調用 play() 方法時，它進行了一些相關利益的處理，那就是廣告。現在，我們編寫測試代碼。
package com.frank.test; public class ProxyTest { public static void main(String[] args) { RealMovie realmovie = new RealMovie(); Movie movie = new Cinema(realmovie); movie.play(); } }
然后觀察結果：
電影馬上開始了，爆米花、可樂、口香糖9.8折，快來買啊！
您正在觀看電影 《肖申克的救贖》
電影馬上結束了，爆米花、可樂、口香糖9.8折，買回家吃吧！
現在可以看到，代理模式可以在不修改被代理對象的基礎上，通過擴展代理類，進行一些功能的附加與增強。值得注意的是，代理類和被代理類應該共同實現一個接口，或者是共同繼承某個類。
上面介紹的是靜態代理的內容，為什么叫做靜態呢？因為它的類型是事先預定好的，比如上面代碼中的 Cinema 這個類。下面要介紹的內容就是動態代理。
動態代理
既然是代理，那么它與靜態代理的功能與目的是沒有區別的，唯一有區別的就是動態與靜態的差別。
那么在動態代理的中這個動態體現在什么地方？
上一節代碼中 Cinema 類是代理，我們需要手動編寫代碼讓 Cinema 實現 Movie 接口，而在動態代理中，我們可以讓程序在運行的時候自動在內存中創建一個實現 Movie 接口的代理，而不需要去定義 Cinema 這個類。這就是它被稱為動態的原因。
也許概念比較抽象。現在實例說明一下情況。
假設有一個大商場，商場有很多的櫃台，有一個櫃台賣茅台酒。我們進行代碼的模擬。
package com.frank.test; public interface SellWine { void mainJiu(); }
SellWine 是一個接口，你可以理解它為賣酒的許可證。
package com.frank.test; public class MaotaiJiu implements SellWine { @Override public void mainJiu() { // TODO Auto-generated method stub System.out.println("我賣得是茅台酒。"); } }
然后創建一個類 MaotaiJiu,對的，就是茅台酒的意思。
我們還需要一個櫃台來賣酒：
package com.frank.test; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Method; public class GuitaiA implements InvocationHandler { private Object pingpai; public GuitaiA(Object pingpai) { this.pingpai = pingpai; } @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { // TODO Auto-generated method stub System.out.println("銷售開始 櫃台是： "+this.getClass().getSimpleName()); method.invoke(pingpai, args); System.out.println("銷售結束"); return null; } }
GuitaiA 實現了 InvocationHandler 這個類，這個類是什么意思呢？大家不要慌張，待會我會解釋。
然后，我們就可以賣酒了。
package com.frank.test; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Proxy; public class Test { public static void main(String[] args) { // TODO Auto-generated method stub MaotaiJiu maotaijiu = new MaotaiJiu(); InvocationHandler jingxiao1 = new GuitaiA(maotaijiu); SellWine dynamicProxy = (SellWine) Proxy.newProxyInstance(MaotaiJiu.class.getClassLoader(), MaotaiJiu.class.getInterfaces(), jingxiao1); dynamicProxy.mainJiu(); } }
這里，我們又接觸到了一個新的概念，沒有關系，先別管，先看結果。
銷售開始 櫃台是： GuitaiA
我賣得是茅台酒。
銷售結束
看到沒有，我並沒有像靜態代理那樣為 SellWine 接口實現一個代理類，但最終它仍然實現了相同的功能，這其中的差別，就是之前討論的動態代理所謂“動態”的原因。
動態代理語法
放輕松，下面我們開始講解語法，語法非常簡單。
動態代碼涉及了一個非常重要的類 Proxy。正是通過 Proxy 的靜態方法 newProxyInstance 才會動態創建代理。
Proxy
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
下面講解它的 3 個參數意義。
- loader 自然是類加載器
- interfaces 代碼要用來代理的接口
- h 一個 InvocationHandler 對象
初學者應該對於 InvocationHandler 很陌生，我馬上就講到這一塊。
InvocationHandler
InvocationHandler 是一個接口，官方文檔解釋說，每個代理的實例都有一個與之關聯的 InvocationHandler 實現類，如果代理的方法被調用，那么代理便會通知和轉發給內部的 InvocationHandler 實現類，由它決定處理。
public interface InvocationHandler { public Object invoke(Object proxy, Method method, Object[] args) throws Throwable; }
InvocationHandler 內部只是一個 invoke() 方法，正是這個方法決定了怎么樣處理代理傳遞過來的方法調用。
- proxy 代理對象
- method 代理對象調用的方法
- args 調用的方法中的參數
因為，Proxy 動態產生的代理會調用 InvocationHandler 實現類，所以 InvocationHandler 是實際執行者。
public class GuitaiA implements InvocationHandler { private Object pingpai; public GuitaiA(Object pingpai) { this.pingpai = pingpai; } @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { // TODO Auto-generated method stub System.out.println("銷售開始 櫃台是： "+this.getClass().getSimpleName()); method.invoke(pingpai, args); System.out.println("銷售結束"); return null; } }
GuitaiA 就是實際上賣酒的地方。
現在，我們加大難度，我們不僅要賣茅台酒，還想賣五糧液。
package com.frank.test; public class Wuliangye implements SellWine { @Override public void mainJiu() { // TODO Auto-generated method stub System.out.println("我賣得是五糧液。"); } }
Wuliangye 這個類也實現了 SellWine 這個接口，說明它也擁有賣酒的許可證，同樣把它放到 GuitaiA 上售賣。
public class Test { public static void main(String[] args) { // TODO Auto-generated method stub MaotaiJiu maotaijiu = new MaotaiJiu(); Wuliangye wu = new Wuliangye(); InvocationHandler jingxiao1 = new GuitaiA(maotaijiu); InvocationHandler jingxiao2 = new GuitaiA(wu); SellWine dynamicProxy = (SellWine) Proxy.newProxyInstance(MaotaiJiu.class.getClassLoader(), MaotaiJiu.class.getInterfaces(), jingxiao1); SellWine dynamicProxy1 = (SellWine) Proxy.newProxyInstance(MaotaiJiu.class.getClassLoader(), MaotaiJiu.class.getInterfaces(), jingxiao2); dynamicProxy.mainJiu(); dynamicProxy1.mainJiu(); } }
我們來看結果：
銷售開始 櫃台是： GuitaiA
我賣得是茅台酒。
銷售結束
銷售開始 櫃台是： GuitaiA
我賣得是五糧液。
銷售結束
有人會問，dynamicProxy 和 dynamicProxy1 什么區別沒有？他們都是動態產生的代理，都是售貨員，都擁有賣酒的技術證書。
我現在擴大商場的經營，除了賣酒之外，還要賣煙。
首先，同樣要創建一個接口，作為賣煙的許可證。
package com.frank.test; public interface SellCigarette { void sell(); }
然后，賣什么煙呢？我是湖南人，那就芙蓉王好了。
public class Furongwang implements SellCigarette { @Override public void sell() { // TODO Auto-generated method stub System.out.println("售賣的是正宗的芙蓉王，可以掃描條形碼查證。"); } }
然后再次測試驗證：
package com.frank.test; import java.lang.reflect.InvocationHandler; import java.lang.reflect.Proxy; public class Test { public static void main(String[] args) { // TODO Auto-generated method stub MaotaiJiu maotaijiu = new MaotaiJiu(); Wuliangye wu = new Wuliangye(); Furongwang fu = new Furongwang(); InvocationHandler jingxiao1 = new GuitaiA(maotaijiu); InvocationHandler jingxiao2 = new GuitaiA(wu); InvocationHandler jingxiao3 = new GuitaiA(fu); SellWine dynamicProxy = (SellWine) Proxy.newProxyInstance(MaotaiJiu.class.getClassLoader(), MaotaiJiu.class.getInterfaces(), jingxiao1); SellWine dynamicProxy1 = (SellWine) Proxy.newProxyInstance(MaotaiJiu.class.getClassLoader(), MaotaiJiu.class.getInterfaces(), jingxiao2); dynamicProxy.mainJiu(); dynamicProxy1.mainJiu(); SellCigarette dynamicProxy3 = (SellCigarette) Proxy.newProxyInstance(Furongwang.class.getClassLoader(), Furongwang.class.getInterfaces(), jingxiao3); dynamicProxy3.sell(); } }
然后，查看結果：
銷售開始 櫃台是： GuitaiA
我賣得是茅台酒。
銷售結束
銷售開始 櫃台是： GuitaiA
我賣得是五糧液。
銷售結束
銷售開始 櫃台是： GuitaiA
售賣的是正宗的芙蓉王，可以掃描條形碼查證。
銷售結束
結果符合預期。大家仔細觀察一下代碼，同樣是通過 Proxy.newProxyInstance() 方法，卻產生了 SellWine 和 SellCigarette 兩種接口的實現類代理，這就是動態代理的魔力。
動態代理的秘密
一定有同學對於為什么 Proxy 能夠動態產生不同接口類型的代理感興趣，我的猜測是肯定通過傳入進去的接口然后通過反射動態生成了一個接口實例。
比如 SellWine 是一個接口，那么 Proxy.newProxyInstance() 內部肯定會有
new SellWine();
這樣相同作用的代碼，不過它是通過反射機制創建的。那么事實是不是這樣子呢？直接查看它們的源碼好了。需要說明的是，我當前查看的源碼是 1.8 版本。
public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) throws IllegalArgumentException { Objects.requireNonNull(h); final Class<?>[] intfs = interfaces.clone(); /* * Look up or generate the designated proxy class. */ Class<?> cl = getProxyClass0(loader, intfs); /* * Invoke its constructor with the designated invocation handler. */ try { final Constructor<?> cons = cl.getConstructor(constructorParams); 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); } }
newProxyInstance 的確創建了一個實例，它是通過 cl 這個 Class 文件的構造方法反射生成。cl 由 getProxyClass0() 方法獲取。
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); }
直接通過緩存獲取，如果獲取不到，注釋說會通過 ProxyClassFactory 生成。
/** * A factory function that generates, defines and returns the proxy class given * the ClassLoader and array of interfaces. */ private static final class ProxyClassFactory implements BiFunction<ClassLoader, Class<?>[], Class<?>> { // Proxy class 的前綴是 “$Proxy”， private static final String proxyClassNamePrefix = "$Proxy"; // next number to use for generation of unique proxy class names private static final AtomicLong nextUniqueNumber = new AtomicLong(); @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. */ 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()); } } }
這個類的注釋說，通過指定的 ClassLoader 和 接口數組 用工廠方法生成 proxy class。 然后這個 proxy class 的名字是：
// Proxy class 的前綴是 “$Proxy”， private static final String proxyClassNamePrefix = "$Proxy"; long num = nextUniqueNumber.getAndIncrement(); String proxyName = proxyPkg + proxyClassNamePrefix + num;
所以，動態生成的代理類名稱是包名+$Proxy+id序號。
生成的過程，核心代碼如下：
byte[] proxyClassFile = ProxyGenerator.generateProxyClass( proxyName, interfaces, accessFlags); return defineClass0(loader, proxyName, proxyClassFile, 0, proxyClassFile.length);
這兩個方法，我沒有繼續追蹤下去，defineClass0() 甚至是一個 native 方法。我們只要知道，動態創建代理這回事就好了。
現在我們還需要做一些驗證，我要檢測一下動態生成的代理類的名字是不是包名+$Proxy+id序號。
public class Test { public static void main(String[] args) { // TODO Auto-generated method stub MaotaiJiu maotaijiu = new MaotaiJiu(); Wuliangye wu = new Wuliangye(); Furongwang fu = new Furongwang(); InvocationHandler jingxiao1 = new GuitaiA(maotaijiu); InvocationHandler jingxiao2 = new GuitaiA(wu); InvocationHandler jingxiao3 = new GuitaiA(fu); SellWine dynamicProxy = (SellWine) Proxy.newProxyInstance(MaotaiJiu.class.getClassLoader(), MaotaiJiu.class.getInterfaces(), jingxiao1); SellWine dynamicProxy1 = (SellWine) Proxy.newProxyInstance(MaotaiJiu.class.getClassLoader(), MaotaiJiu.class.getInterfaces(), jingxiao2); dynamicProxy.mainJiu(); dynamicProxy1.mainJiu(); SellCigarette dynamicProxy3 = (SellCigarette) Proxy.newProxyInstance(Furongwang.class.getClassLoader(), Furongwang.class.getInterfaces(), jingxiao3); dynamicProxy3.sell(); System.out.println("dynamicProxy class name:"+dynamicProxy.getClass().getName()); System.out.println("dynamicProxy1 class name:"+dynamicProxy1.getClass().getName()); System.out.println("dynamicProxy3 class name:"+dynamicProxy3.getClass().getName()); } }
結果如下：
銷售開始 櫃台是： GuitaiA 我賣得是茅台酒。 銷售結束 銷售開始 櫃台是： GuitaiA 我賣得是五糧液。 銷售結束 銷售開始 櫃台是： GuitaiA 售賣的是正宗的芙蓉王，可以掃描條形碼查證。 銷售結束 dynamicProxy class name:com.sun.proxy.$Proxy0 dynamicProxy1 class name:com.sun.proxy.$Proxy0 dynamicProxy3 class name:com.sun.proxy.$Proxy1
SellWine 接口的代理類名是：com.sun.proxy.$Proxy0
SellCigarette 接口的代理類名是：com.sun.proxy.$Proxy1
這說明動態生成的 proxy class 與 Proxy 這個類同一個包。
下面用一張圖讓大家記住動態代理涉及到的角色。
紅框中 $Proxy0 就是通過 Proxy 動態生成的。
$Proxy0 實現了要代理的接口。
$Proxy0 通過調用 InvocationHandler 來執行任務。
代理的作用
可能有同學會問，已經學習了代理的知識，但是，它們有什么用呢？
主要作用，還是在不修改被代理對象的源碼上，進行功能的增強。
這在 AOP 面向切面編程領域經常見。
在軟件業，AOP為Aspect Oriented Programming的縮寫，意為：面向切面編程，通過預編譯方式和運行期動態代理實現程序功能的統一維護的一種技術。AOP是OOP的延續，是軟件開發中的一個熱點，也是Spring框架中的一個重要內容，是函數式編程的一種衍生范型。利用AOP可以對業務邏輯的各個部分進行隔離，從而使得業務邏輯各部分之間的耦合度降低，提高程序的可重用性，同時提高了開發的效率。
主要功能
日志記錄，性能統計，安全控制，事務處理，異常處理等等。
上面的引用是百度百科對於 AOP 的解釋，至於，如何通過代理來進行日志記錄功能、性能統計等等，這個大家可以參考 AOP 的相關源碼，然后仔細琢磨。
同注解一樣，很多同學可能會有疑惑，我什么時候用代理呢？
這取決於你自己想干什么。你已經學會了語法了，其他的看業務需求。對於實現日志記錄功能的框架來說，正合適。
至此，靜態代理和動態代理者講完了。
總結
- 代理分為靜態代理和動態代理兩種。
- 靜態代理，代理類需要自己編寫代碼寫成。
- 動態代理，代理類通過 Proxy.newInstance() 方法生成。
- 不管是靜態代理還是動態代理，代理與被代理者都要實現兩樣接口，它們的實質是面向接口編程。
- 靜態代理和動態代理的區別是在於要不要開發者自己定義 Proxy 類。
- 動態代理通過 Proxy 動態生成 proxy class，但是它也指定了一個 InvocationHandler 的實現類。
- 代理模式本質上的目的是為了增強現有代碼的功能。