深入理解［代理模式］原理與技術
如何理解代理模式？
思考抽象問題最好的辦法就是具體化！
比如我們需要為一個業務方法在執行前後記錄日誌，為了達到解耦的目的，我們可以再新建一個類並定義一個新的業務方法，該方法既可以呼叫原業務方法，又可以在呼叫前後進行日誌處理，例如：
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.汽車跑到了終點");
}
}
代理物件：主要作用是繼承目標物件，進行增強處理，並使用關鍵字super呼叫父類方法。
public class CarProxy extends Car {
@Override
public void move() {
System.out.println("日誌開始記錄....");
super.move();
System.out.println("日誌記錄完成....");
}
}
測試方法：實際上是呼叫代理物件的move()方法。
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("記錄日誌結束！");
}
}
測試方法：實際上是呼叫代理物件的move()方法。
public static void main(String[] args) throws Exception {
Moveable m =new CarProxy();
m.move();
}
靜態代理的優缺點
優點：
業務類只需要關注業務邏輯本身，保證了業務類的重用性。這是代理模式的共有優點。
缺點：
1）代理物件的一個介面只服務於一種型別的物件，如果要代理的型別很多，勢必要為每一種型別的方法都進行代理，靜態代理在程式規模稍大時就無法勝任了。
比如Car類的move()方法需要記錄日誌，如果還有汽車，火車，自行車類的move()方法也需要記錄日誌，我們都要一個個的去為它們生成代理類，太麻煩了。
2）如果介面增加一個方法，除了所有實現類需要實現這個方法外，所有代理類也需要實現此方法。顯而易見，增加了程式碼維護的複雜度。
二、動態代理
動態代理是在實現階段不用關心代理類，而在執行階段才指定哪一個物件。動態代理類的原始碼是在程式執行期間由JVM根據反射等機制動態的生成 。
簡單來說，動態代理就是交給程式去自動生成代理類。
1、JDK的動態代理
JDK動態代理實現步驟：
-
建立被代理的類以及實現的介面；
-
建立一個實現介面InvocationHandler的類，它必須實現invoke方法；
-
呼叫Proxy的newProxyInstance靜態方法，建立一個代理類。
-
通過代理物件呼叫目標方法。
程式碼示例
共同介面
public interface Moveable {
String move();
}
目標物件：正常實現介面方法
public class Car implements Moveable {
@Override
public String move() {
return "汽車行駛中";
}
}
對目標物件的增強處理：
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;
}
}
實現InvocationHandler介面步驟：
-
定義含參構造方法，該引數為要代理的例項物件，目的是用於執行method.invoke()方法（也就是執行目標方法）
-
實現介面的invoke()方法，該方法用於對目標方法的增強處理，比如記錄日誌等。該方法的返回值就是代理物件執行目標方法的返回值。
具體引數：
-
proxy 動態生成的代理物件
-
method 目標方法的例項
-
args 目標方法的引數
測試方法：
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());
}
通過呼叫Proxy.newProxyInstance方法生成代理物件，具體引數有：
-
loader 目標類的類載入器
-
interfaces 目標類實現的介面
-
InvocationHandler 呼叫處理程式的實現物件
列印結果
代理物件:com.sun.proxy.$Proxy0
執行方法:汽車行駛中
值得一提的是，JDK動態代理針對每個代理物件都會有一個關聯的呼叫處理程式，即實現InvocationHandler介面。當在代理物件上呼叫目標方法時，將對方法呼叫進行編碼並將其分配給其實現 InvocationHandler 介面的 invoke 方法。
特點
JDK的動態代理只能代理實現了介面的類， 沒有實現介面的類不能實現動態代理。
2、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在所難免啦~~~！