AOP的實現原理—反射與動態代理
其實AOP的意思就是面向切面程式設計。OO注重的是我們解決問題的方法(封裝成Method),而AOP注重的是解決許多問題的方法中的共同點,是對OO思想的一種補充!還是拿人家經常舉的一個例子講解一下吧:比如說,我們現在要開發的一個應用裡面有很多的業務方法,但是,我們現在要對這個方法的執行做全面監控,或部分監控。也許我們就會在要一些方法前去加上一條日誌記錄,我們寫個例子看看我們最簡單的解決方案。
public interface IHello { /** * 假設這是一個業務方法 * @param name */ void sayHello(String name); }
裡面有一個方法,用於輸入"Hello"加傳進來的姓名。我們去寫個類實現IHello介面:
public class Hello implements IHello {
public void sayHello(String name) {
System.out.println("Hello " + name);
}
}
現在我們要為這個業務方法加上日誌記錄的業務,在不改變原始碼的情況下,我們會去怎麼做呢?也許,你會去寫一個類去實現IHello介面,並依賴Hello這個類。程式碼如下:
public class HelloProxy implements IHello { private IHello hello; public HelloProxy(IHello hello) { this.hello = hello; } public void sayHello(String name) { Logger.logging(Level.DEBUGE, "sayHello method start."); hello.sayHello(name); Logger.logging(Level.INFO, "sayHello method end!"); } }
其中Logger類程式碼如下:
public class Logger{ /** * 根據等級記錄日誌 * @param level * @param context */ public static void logging(Level level, String context) { if (level.equals(Level.INFO)) { System.out.println(new Date().toLocaleString() + " " + context); } if (level.equals(Level.DEBUGE)) { System.err.println(new Date() + " " + context); } } }
Level列舉程式碼如下:
public enum Level {
INFO,DEBUGE;
}
現在我們去寫個測試類看看,程式碼如下:
public class Test {
public static void main(String[] args) {
IHello hello = new HelloProxy(new Hello());
hello.sayHello("Doublej");
}
}
執行以上程式碼我們可以得到下面結果:
Tue Mar 04 20:57:12 CST 2008 sayHello method start.
Hello Doublej
2008-3-4 20:57:12 sayHello method end!
從上面的程式碼我們可以看出,hello物件是被HelloProxy這個所謂的代理類所建立的。這樣,如果我們以後要把日誌記錄的功能去掉。那我們只要把得到hello物件的程式碼改成以下:
public class Test {
public static void main(String[] args) {
IHello hello = new Hello();
hello.sayHello("Doublej");
}
}
上面的程式碼,可以說是AOP最簡單的實現!
但是我們會發現一個問題,如果我們像Hello這樣的類很多,那麼,我們是不是要去寫很多個HelloProxy這樣的類呢?沒錯,是的。其實也是一種很麻煩的事。在jdk1.3以後,jdk跟我們提供了一個API,即java.lang.reflect.InvocationHandler的類。 這個類可以讓我們在JVM呼叫某個類的方法時動態的為些方法做些什麼事,讓我們把以上的程式碼改一下來看看效果。同樣,我們寫一個IHello的介面和一個Hello的實現類。在介面中,我們定義兩個方法;程式碼如下 :
public interface IHello {
/**
* 業務處理A方法
* @param name
*/
void sayHello(String name);
/**
* 業務處理B方法
* @param name
*/
void sayGoogBye(String name);
}
Hello.java程式碼如下:
public class Hello implements IHello {
public void sayHello(String name) {
System.out.println("Hello " + name);
}
public void sayGoogBye(String name) {
System.out.println(name+" GoodBye!");
}
}
我們一樣的去寫一個代理類。只不過,讓這個類去實現java.lang.reflect.InvocationHandler介面,程式碼如下:
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
public class DynaProxyHello implements InvocationHandler {
/**
* 要處理的物件(也就是我們要在方法的前後加上業務邏輯的物件,如例子中的Hello)
*/
private Object delegate;
/**
* 動態生成方法被處理過後的物件 (寫法固定)
*
* @param delegate
* @param proxy
* @return
*/
public Object bind(Object delegate) {
this.delegate = delegate;
return Proxy.newProxyInstance(
this.delegate.getClass().getClassLoader(), this.delegate
.getClass().getInterfaces(), this);
}
/**
* 要處理的物件中的每個方法會被此方法送去JVM呼叫,也就是說,要處理的物件的方法只能通過此方法呼叫
* 此方法是動態的,不是手動呼叫的
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
Object result = null;
try {
//執行原來的方法之前記錄日誌
Logger.logging(Level.DEBUGE, method.getName() + " Method end .");
//JVM通過這條語句執行原來的方法(反射機制)
result = method.invoke(this.delegate, args);
//執行原來的方法之後記錄日誌
Logger.logging(Level.INFO, method.getName() + " Method Start!");
} catch (Exception e) {
e.printStackTrace();
}
//返回方法返回值給呼叫者
return result;
}
}
上面類中出現的Logger類和Level列舉還是和上一上例子的實現是一樣的,這裡就不貼出程式碼了。
public class Test {
public static void main(String[] args) {
IHello hello = (IHello)new DynaProxyHello().bind(new Hello());
hello.sayGoogBye("Double J");
hello.sayHello("Double J");
}
}
執行輸出的結果如下:
Tue Mar 04 21:24:03 CST 2008 sayGoogBye Method end .
Double J GoodBye!
2008-3-4 21:24:03 sayGoogBye Method Start!
Tue Mar 04 21:24:03 CST 2008 sayHello Method end .
Hello Double J
2008-3-4 21:24:03 sayHello Method Start!
由於執行緒的關係,第二個方法的開始出現在第一個方法的結束之前。這不是我們所關注的!從上面的例子我們看出,只要你是採用面向介面程式設計,那麼,你的任何物件的方法執行之前要加上記錄日誌的操作都是可以的。他(DynaPoxyHello)自動去代理執行被代理物件(Hello)中的每一個方法,一個java.lang.reflect.InvocationHandler介面就把我們的代理物件和被代理物件解藕了。但是,我們又發現還有一個問題,這個DynaPoxyHello物件只能跟我們去在方法前後加上日誌記錄的操作。我們能不能把DynaPoxyHello物件和日誌操作物件(Logger)解藕呢?
結果是肯定的,讓我們來分析一下我們的需求。我們要在被代理物件的方法前面或者後面去加上日誌操作程式碼(或者是其它操作的程式碼),那麼,我們可以抽象出一個介面,這個接口裡就只有兩個方法,一個是在被代理物件要執行方法之前執行的方法,我們取名為start,第二個方法就是在被代理物件執行方法之後執行的方法,我們取名為end 。介面定義如下 :
public interface IOperation {
/**
* 方法執行之前的操作
* @param method
*/
void start(Method method);
/**
* 方法執行之後的操作
* @param method
*/
void end(Method method);
}
我們去寫一個實現上面介面的類,我們把它作為真正的操作者,如下面是日誌操作者類,它實現了上面的介面:
public class LoggerOperation implements IOperation {
public void end(Method method) {
Logger.logging(Level.DEBUGE, method.getName() + " Method end .");
}
public void start(Method method) {
Logger.logging(Level.INFO, method.getName() + " Method Start!");
}
}
然後我們要改一下代理物件DynaProxyHello中的程式碼,如下:
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
public class DynaProxyHello implements InvocationHandler {
/**
* 操作者
*/
private Object proxy;
/**
* 要處理的物件(也就是我們要在方法的前後加上業務邏輯的物件,如例子中的Hello)
*/
private Object delegate;
/**
* 動態生成方法被處理過後的物件 (寫法固定)
*
* @param delegate
* @param proxy
* @return
*/
public Object bind(Object delegate,Object proxy) {
this.proxy = proxy;
this.delegate = delegate;
return Proxy.newProxyInstance(
this.delegate.getClass().getClassLoader(), this.delegate
.getClass().getInterfaces(), this);
}
/**
* 要處理的物件中的每個方法會被此方法送去JVM呼叫,也就是說,要處理的物件的方法只能通過此方法呼叫
* 此方法是動態的,不是手動呼叫的
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
Object result = null;
try {
//反射得到操作者的例項
Class clazz = this.proxy.getClass();
//反射得到操作者的Start方法
Method start = clazz.getDeclaredMethod("start",new Class[] { Method.class });
//反射執行start方法
start.invoke(this.proxy, new Object[] { method });
//執行要處理物件的原本方法
result = method.invoke(this.delegate, args);
//反射得到操作者的end方法
Method end = clazz.getDeclaredMethod("end",new Class[] { Method.class });
//反射執行end方法
end.invoke(this.proxy, new Object[] { method });
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
}
然後我們把Test.java中的程式碼改一下,測試一下:
public class Test {
public static void main(String[] args) {
IHello hello = (IHello)new DynaProxyHello().bind(new Hello(),new LoggerOperation());
hello.sayGoogBye("Double J");
hello.sayHello("Double J");
}
}
結果還是一樣的吧。如果你想在每個方法之前加上日誌記錄,而不在方法後加上日誌記錄,你就把LoggerOperation類改成如下:
import java.lang.reflect.Method;
public class LoggerOperation implements IOperation {
public void end(Method method) {
//Logger.logging(Level.DEBUGE, method.getName() + " Method end .");
}
public void start(Method method) {
Logger.logging(Level.INFO, method.getName() + " Method Start!");
}
}
執行一下,你就會發現,每個方法之後沒有記錄日誌了。 這樣,我們就把代理者和操作者解藕了!
如果我們不想讓所有方法都被日誌記錄,我們應該怎麼去解藕呢?我的想法是在代理物件的public Object invoke(Object proxy, Method method, Object[] args)方法裡面加上個if(),對傳進來的method的名字進行判斷,判斷的條件存在XML裡面。這樣我們就可以通過配置檔案進行解藕了。如果有興趣的朋友可以把操作者、被代理者都通過配置檔案進行配置,那麼就可以寫一個簡單的Spring AOP框架了。