反射实现 AOP 动态代理模式(Spring AOP 的实现 原理)
好长时间没有用过Spring了. 突然拿起书.我都发现自己对AOP都不熟悉了.
其实AOP的意思就是面向切面编程.
OO注重的是我们解决问题的方法(封装成Method),而AOP注重的是许多解决解决问题的方法中的共同点,是对OO思想的一种补充!
还是拿人家经常举的一个例子讲解一下吧:
比如说,我们现在要开发的一个应用里面有很多的业务方法,但是,我们现在要对这个方法的执行做全面监控,或部分监控.也许我们就会在要一些方法前去加上一条日志记录,
我们写个例子看看我们最简单的解决方案
我们先写一个接口IHello.java代码如下:
1
package sinosoft.dj.aop.staticaop;
2
3
public interface IHello {
4
/**
5
* 假设这是一个业务方法
6 * @param name
7
*/
8 void sayHello(String name);
9
}
10
package sinosoft.dj.aop.staticaop;2
3
public interface IHello {4
/**5
* 假设这是一个业务方法6
* @param name7
*/8
void sayHello(String name);9
}10
里面有个方法,用于输入"Hello" 加传进来的姓名;我们去写个类实现IHello接口
package sinosoft.dj.aop.staticaop;public class Hello implements IHello { public void sayHello(String name) { System.out.println("Hello " + name); }}现在我们要为这个业务方法加上日志记录的业务,我们在不改变原代码的情况下,我们会去怎么做呢?也许,你会去写一个类去实现IHello接口,并依赖Hello这个类.代码如下:
1package sinosoft.dj.aop.staticaop;
2
3public class HelloProxy implements IHello {
4 private IHello hello;
5
6 public HelloProxy(IHello hello) {
7 this.hello = hello;
8 }
9
10 public void sayHello(String name) {
11 Logger.logging(Level.DEBUGE, "sayHello method start
.");
12 hello.sayHello(name);
13 Logger.logging(Level.INFO, "sayHello method end!");
14
15 }
16
17}
18
package sinosoft.dj.aop.staticaop;2
3
public class HelloProxy implements IHello {4
private IHello hello;5
6
public HelloProxy(IHello hello) {7
this.hello = hello;8
}9
10
public void sayHello(String name) {11
Logger.logging(Level.DEBUGE, "sayHello method start.");12
hello.sayHello(name);13
Logger.logging(Level.INFO, "sayHello method end!");14
15
}16
17
}18
其中.Logger类和Level枚举代码如下:
Logger.java
1package sinosoft.dj.aop.staticaop;
2
3import java.util.Date;
4
5public class Logger{
6 /**
7 * 根据等级记录日志
8 * @param level
9 * @param context
10 */
11 public static void logging(Level level, String context) {
12 if (level.equals(Level.INFO)) {
13 System.out.println(new Date().toLocaleString() + " " + context);
14 }
15 if (level.equals(Level.DEBUGE)) {
16 System.err.println(new Date() + " " + context);
17 }
18 }
19
20}
21
Level.javapackage sinosoft.dj.aop.staticaop;2
3
import java.util.Date;4
5
public class Logger{6
/**7
* 根据等级记录日志8
* @param level9
* @param context10
*/11
public static void logging(Level level, String context) {12
if (level.equals(Level.INFO)) {13
System.out.println(new Date().toLocaleString() + " " + context);14
}15
if (level.equals(Level.DEBUGE)) {16
System.err.println(new Date() + " " + context);17
}18
}19
20
}21
1package sinosoft.dj.aop.staticaop;
2
3public enum Level {
4 INFO,DEBUGE;
5}
6
那我们去写个测试类看看,代码如下:package sinosoft.dj.aop.staticaop;2
3
public enum Level {4
INFO,DEBUGE;5
}6
Test.java
1package sinosoft.dj.aop.staticaop;
2
3public class Test {
4 public static void main(String[] args) {
5 IHello hello = new HelloProxy(new Hello());
6 hello.sayHello("Doublej");
7 }
8}
9
运行以上代码我们可以得到下面结果:package sinosoft.dj.aop.staticaop;2
3
public class Test {4
public static void main(String[] args) {5
IHello hello = new HelloProxy(new Hello());6
hello.sayHello("Doublej");7
}8
}9
Tue Mar 04 20:57:12 CST 2008 sayHello method start.Hello Doublej2008-3-4 20:57:12 sayHello method end!从上面的代码我们可以看出,hello对象是被HelloProxy这个所谓的代理态所创建的.这样,如果我们以后要把日志记录的功能去掉.那我们只要把得到hello对象的代码改成以下:
1package sinosoft.dj.aop.staticaop;
2
3public class Test {
4 public static void main(String[] args) {
5 IHello hello = new Hello();
6 hello.sayHello("Doublej");
7 }
8}
9
package sinosoft.dj.aop.staticaop;2
3
public class Test {4
public static void main(String[] args) {5
IHello hello = new Hello();6
hello.sayHello("Doublej");7
}8
}9
上面代码,可以说是AOP最简单的实现!
但是我们会发现一个问题,如果我们像Hello这样的类很多,那么,我们是不是要去写很多个HelloProxy这样的类呢.没错,是的.其实也是一种很麻烦的事.在jdk1.3以后.jdk跟我们提供了一个API java.lang.reflect.InvocationHandler的类. 这个类可以让我们在JVM调用某个类的方法时动态的为些方法做些什么事.让我们把以上的代码改一下来看看效果.
同样,我们写一个IHello的接口和一个Hello的实现类.在接口中.我们定义两个方法;代码如下 :
IHello.java
1package sinosoft.dj.aop.proxyaop;
2
3public interface IHello {
4 /**
5 * 业务处理A方法
6 * @param name
7 */
8 void sayHello(String name);
9 /**
10 * 业务处理B方法
11 * @param name
12 */
13 void sayGoogBye(String name);
14}
15
package sinosoft.dj.aop.proxyaop;2
3
public interface IHello {4
/**5
* 业务处理A方法6
* @param name7
*/8
void sayHello(String name);9
/**10
* 业务处理B方法11
* @param name12
*/13
void sayGoogBye(String name);14
}15
Hello.java
1package sinosoft.dj.aop.proxyaop;
2
3public class Hello implements IHello {
4
5 public void sayHello(String name) {
6 System.out.println("Hello " + name);
7 }
8 public void sayGoogBye(String name) {
9 System.out.println(name+" GoodBye!");
10 }
11}
12
package sinosoft.dj.aop.proxyaop;2
3
public class Hello implements IHello {4
5
public void sayHello(String name) {6
System.out.println("Hello " + name);7
}8
public void sayGoogBye(String name) {9
System.out.println(name+" GoodBye!");10
}11
}12
我们一样的去写一个代理类.只不过.让这个类去实现java.lang.reflect.InvocationHandler接口,代码如下:
1package sinosoft.dj.aop.proxyaop;
2
3import java.lang.reflect.InvocationHandler;
4import java.lang.reflect.Method;
5import java.lang.reflect.Proxy;
6
7public class DynaProxyHello implements InvocationHandler {
8
9 /**
10 * 要处理的对象(也就是我们要在方法的前后加上业务逻辑的对象,如例子中的Hello)
11 */
12 private Object delegate;
13
14 /**
15 * 动态生成方法被处理过后的对象 (写法固定)
16 *
17 * @param delegate
18 * @param proxy
19 * @return
20 */
21 public Object bind(Object delegate) {
22 this.delegate = delegate;
23 return Proxy.newProxyInstance(
24 this.delegate.getClass().getClassLoader(), this.delegate
25 .getClass().getInterfaces(), this);
26 }
27 /**
28 * 要处理的对象中的每个方法会被此方法送去JVM调用,也就是说,要处理的对象的方法只能通过此方法调用
29 * 此方法是动态的,不是手动调用的
30 */
31 public Object invoke(Object proxy, Method method, Object[] args)
32 throws Throwable {
33 Object result = null;
34 try {
35 //执行原来的方法之前记录日志
36 Logger.logging(Level.DEBUGE, method.getName() + " Method end .");
37
38 //JVM通过这条语句执行原来的方法(反射机制)
39 result = method.invoke(this.delegate, args);
40 //执行原来的方法之后记录日志
41 Logger.logging(Level.INFO, method.getName() + " Method Start!");
42 } catch (Exception e) {
43 e.printStackTrace();
44 }
45 //返回方法返回值给调用者
46 return result;
47 }
48
49}
50
package sinosoft.dj.aop.proxyaop;2
3
import java.lang.reflect.InvocationHandler;4
import java.lang.reflect.Method;5
import java.lang.reflect.Proxy;6
7
public class DynaProxyHello implements InvocationHandler {8
9
/**10
* 要处理的对象(也就是我们要在方法的前后加上业务逻辑的对象,如例子中的Hello)11
*/12
private Object delegate;13
14
/**15
* 动态生成方法被处理过后的对象 (写法固定)16
* 17
* @param delegate18
* @param proxy19
* @return20
*/21
public Object bind(Object delegate) {22
this.delegate = delegate;23
return Proxy.newProxyInstance(24
this.delegate.getClass().getClassLoader(), this.delegate25
.getClass().getInterfaces(), this);26
}27
/**28
* 要处理的对象中的每个方法会被此方法送去JVM调用,也就是说,要处理的对象的方法只能通过此方法调用29
* 此方法是动态的,不是手动调用的30
*/31
public Object invoke(Object proxy, Method method, Object[] args)32
throws Throwable {33
Object result = null;34
try {35
//执行原来的方法之前记录日志36
Logger.logging(Level.DEBUGE, method.getName() + " Method end .");37
38
//JVM通过这条语句执行原来的方法(反射机制)39
result = method.invoke(this.delegate, args);40
//执行原来的方法之后记录日志41
Logger.logging(Level.INFO, method.getName() + " Method Start!");42
} catch (Exception e) {43
e.printStackTrace();44
}45
//返回方法返回值给调用者46
return result;47
}48
49
}50
上面类中出现的Logger类和Level枚举还是和上一上例子的实现是一样的.这里就不贴出代码了.
让我们写一个Test类去测试一下.代码如下:
Test.java
1package sinosoft.dj.aop.proxyaop;
2
3public class Test {
4 public static void main(String[] args) {
5 IHello hello = (IHello)new DynaProxyHello().bind(new Hello());
6 hello.sayGoogBye("Double J");
7 hello.sayHello("Double J");
8
9 }
10}
11
package sinosoft.dj.aop.proxyaop;2
3
public class Test {4
public static void main(String[] args) {5
IHello hello = (IHello)new DynaProxyHello().bind(new Hello());6
hello.sayGoogBye("Double J");7
hello.sayHello("Double J");8
9
}10
}11
运行输出的结果如下:
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 J2008-3-4 21:24:03 sayHello Method Start!由于线程的关系,第二个方法的开始出现在第一个方法的结束之前.这不是我们所关注的!
从上面的例子我们看出.只要你是采用面向接口编程,那么,你的任何对象的方法执行之前要加上记录日志的操作都是可以的.他(DynaPoxyHello)自动去代理执行被代理对象(Hello)中的每一个方法,一个java.lang.reflect.InvocationHandler接口就把我们的代理对象和被代理对象解藕了.但是,我们又发现还有一个问题,这个DynaPoxyHello对象只能跟我们去在方法前后加上日志记录的操作.我们能不能把DynaPoxyHello对象和日志操作对象(Logger)解藕呢?
结果是肯定的.让我们来分析一下我们的需求.
我们要在被代理对象的方法前面或者后面去加上日志操作代码(或者是其它操作的代码),
那么,我们可以抽象出一个接口,这个接口里就只有两个方法,一个是在被代理对象要执行方法之前执行的方法,我们取名为start,第二个方法就是在被代理对象执行方法之后执行的方法,我们取名为end .接口定义如下 :
1package sinosoft.dj.aop.proxyaop;
2
3import java.lang.reflect.Method;
4
5public interface IOperation {
6 /**
7 * 方法执行之前的操作
8 * @param method
9 */
10 void start(Method method);
11 /**
12 * 方法执行之后的操作
13 * @param method
14 */
15 void end(Method method);
16}
17
package sinosoft.dj.aop.proxyaop;2
3
import java.lang.reflect.Method;4
5
public interface IOperation {6
/**7
* 方法执行之前的操作8
* @param method9
*/10
void start(Method method);11
/**12
* 方法执行之后的操作13
* @param method14
*/15
void end(Method method);16
}17
我们去写一个实现上面接口的类.我们把作他真正的操作者,如下面是日志操作者的一个类:
LoggerOperation.java
package sinosoft.dj.aop.proxyaop;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!"); }}然后我们要改一下代理对象DynaProxyHello中的代码.如下:
1package sinosoft.dj.aop.proxyaop;
2
3import java.lang.reflect.InvocationHandler;
4import java.lang.reflect.Method;
5import java.lang.reflect.Proxy;
6
7public class DynaProxyHello implements InvocationHandler {
8 /**
9 * 操作者
10 */
11 private Object proxy;
12 /**
13 * 要处理的对象(也就是我们要在方法的前后加上业务逻辑的对象,如例子中的Hello)
14 */
15 private Object delegate;
16
17 /**
18 * 动态生成方法被处理过后的对象 (写法固定)
19 *
20 * @param delegate
21 * @param proxy
22 * @return
23 */
24 public Object bind(Object delegate,Object proxy) {
25
26 this.proxy = proxy;
27 this.delegate = delegate;
28 return Proxy.newProxyInstance(
29 this.delegate.getClass().getClassLoader(), this.delegate
30 .getClass().getInterfaces(), this);
31 }
32 /**
33 * 要处理的对象中的每个方法会被此方法送去JVM调用,也就是说,要处理的对象的方法只能通过此方法调用
34 * 此方法是动态的,不是手动调用的
35 */
36 public Object invoke(Object proxy, Method method, Object[] args)
37 throws Throwable {
38 Object result = null;
39 try {
40 //反射得到操作者的实例
41 Class clazz = this.proxy.getClass();
42 //反射得到操作者的Start方法
43 Method start = clazz.getDeclaredMethod("start",
44 new Class[] { Method.class });
45 //反射执行start方法
46 start.invoke(this.proxy, new Object[] { method });
47 //执行要处理对象的原本方法
48 result = method.invoke(this.delegate, args);
49// 反射得到操作者的end方法
50 Method end = clazz.getDeclaredMethod("end",
51 new Class[] { Method.class });
52// 反射执行end方法
53 end.invoke(this.proxy, new Object[] { method });
54
55 } catch (Exception e) {
56 e.printStackTrace();
57 }
58 return result;
59 }
60
61}
62
package sinosoft.dj.aop.proxyaop;2
3
import java.lang.reflect.InvocationHandler;4
import java.lang.reflect.Method;5
import java.lang.reflect.Proxy;6
7
public class DynaProxyHello implements InvocationHandler {8
/**9
* 操作者10
*/11
private Object proxy;12
/**13
* 要处理的对象(也就是我们要在方法的前后加上业务逻辑的对象,如例子中的Hello)14
*/15
private Object delegate;16
17
/**18
* 动态生成方法被处理过后的对象 (写法固定)19
* 20
* @param delegate21
* @param proxy22
* @return23
*/24
public Object bind(Object delegate,Object proxy) {25
26
this.proxy = proxy;27
this.delegate = delegate;28
return Proxy.newProxyInstance(29
this.delegate.getClass().getClassLoader(), this.delegate30
.getClass().getInterfaces(), this);31
}32
/**33
* 要处理的对象中的每个方法会被此方法送去JVM调用,也就是说,要处理的对象的方法只能通过此方法调用34
* 此方法是动态的,不是手动调用的35
*/36
public Object invoke(Object proxy, Method method, Object[] args)37
throws Throwable {38
Object result = null;39
try {40
//反射得到操作者的实例41
Class clazz = this.proxy.getClass();42
//反射得到操作者的Start方法43
Method start = clazz.getDeclaredMethod("start",44
new Class[] { Method.class });45
//反射执行start方法46
start.invoke(this.proxy, new Object[] { method });47
//执行要处理对象的原本方法48
result = method.invoke(this.delegate, args);49
// 反射得到操作者的end方法50
Method end = clazz.getDeclaredMethod("end",51
new Class[] { Method.class });52
// 反射执行end方法53
end.invoke(this.proxy, new Object[] { method });54
55
} catch (Exception e) {56
e.printStackTrace();57
}58
return result;59
}60
61
}62
然后我们把Test.java中的代码改一下.测试一下:
package sinosoft.dj.aop.proxyaop;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类改成如下:
1package sinosoft.dj.aop.proxyaop;
2
3import java.lang.reflect.Method;
4
5public class LoggerOperation implements IOperation {
6
7 public void end(Method method) {
8 //Logger.logging(Level.DEBUGE, method.getName() + " Method end .");
9 }
10
11 public void start(Method method) {
12 Logger.logging(Level.INFO, method.getName() + " Method Start!");
13 }
14
15}
16
package sinosoft.dj.aop.proxyaop;2
3
import java.lang.reflect.Method;4
5
public class LoggerOperation implements IOperation {6
7
public void end(Method method) {8
//Logger.logging(Level.DEBUGE, method.getName() + " Method end .");9
}10
11
public void start(Method method) {12
Logger.logging(Level.INFO, method.getName() + " Method Start!");13
}14
15
}16
运行一下.你就会发现,每个方法之后没有记录日志了. 这样,我们就把代理者和操作者解藕了!
下面留一个问题给大家,如果我们不想让所有方法都被日志记录,我们应该怎么去解藕呢.?
我的想法是在代理对象的public Object invoke(Object proxy, Method method, Object[] args)方法里面加上个if(),对传进来的method的名字进行判断,判断的条件存在XML里面.这样我们就可以配置文件时行解藕了.如果有兴趣的朋友可以把操作者,被代理者,都通过配置文件进行配置 ,那么就可以写一个简单的SpringAOP框架了.
本文转自：http://www.blogjava.net/DoubleJ/archive/2008/03/04/183796.html
如果你喜欢本文, 请长按二维码，关注公众号 分布式编程.
作者：分布式编程
出处：https://zthinker.com/
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。
浙公网安备 33010602011771号