AOP实现（一）——Advice

在Spring1.2或之前的版本中，实现AOP的传统方式就是通过实现Spring的AOP API来定义Advice，并设置代理对象。Spring根据Adivce加入到业务流程的时机的不同，提供了四种不同的Advice：Before Advice、After Advice、Around Advice、Throw Advice。
1、Before Advice
顾名思义，Before Advice会在目标对象的方法执行之前被调用，您可以通过实现org.springframework.aop.MethodBeforeAdvice接口来实现Before Advice的逻辑，接口定义如下：

java 代码

1. package org.springframework.aop;
3. public interface MethodBeforeAdvice extends BeforeAdvice {
4.    void before(Method method, Object[] args, Object target) throws Throwable;
5. }

其中BeforeAdvice继承自Adivce接口，这两者都是标签接口，并没有定义任何具体的方法。before方法会在目标对象的指定方法执行之前被执行，在before方法种，你可以取得指定方法的Method实例、参数列表和目标对象，在before方法执行完后，目标对象上的方法将会执行，除非在before方法种抛出异常。
下面通过例子来说明Before Advice的使用方法。首先定义目标对象所要实现的接口：

java 代码

1. package com.savage.aop
3. public interface MessageSender {
4.    void send(String message);
5. }

接着实现MessageSender接口：

java 代码

1. package com.savage.aop;
3. public class HttpMessageSender implements MessageSender {
4. public void send(String message) {
5. System.out.println("Send Message[" + message + "] by http.");
6. }
7. }

OK，我们的业务代码实现完了，现在如果要在不改变我们的业务代码的前提下，在执行业务代码前要记录一些日志，这时就可以通过实现MethodBeforeAdvice接口来实现，如：

java 代码

1. package com.savage.aop;
3. import java.lang.reflect.Method;
5. import org.springframework.aop.framework.MethodBeforeAdvice;
7. public class LogBeforeAdvice implements MethodAdvice {
8.    public void before(Method method, Object[] args, Object target) throws Throwable {
9.       System.out.println("Log before " + method + " by LogBeforeAdvice.");
10.    }
11. }

然后再在XML进行如下定义：

xml 代码

 

1. <?xml version="1.0" encoding="UTF-8"?>    
2. <beans xmlns="http://www.springframework.org/schema/beans"    
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
4. xsi:schemaLocation="http://www.springframework.org/schema/beans    
5. http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">    
6.   
7.     <bean id="messageSenderImpl" class="com.savage.aop.HttpMessageSender"></bean>    
8.       
9.     <bean id="logBeforeAdvice" class="com.savage.aop.LogBeforeAdvice"></bean>    
10.       
11.     <bean id="messageSender" class="org.springframework.aop.framework.ProxyFactoryBean">    
12.         <property name="proxyInterfaces" value="com.savage.aop.MessageSender"/>    
13.         <property name="target" ref="messageSenderImpl"/>    
14.         <property name="interceptorNames">    
15.             <list>    
16.                 <value>logBeforeAdvice</value>    
17.             </list>    
18.         </property>    
19.     </bean>    
20. </beans>   

这样我们就为MessageSender对象指定了Before Advice对象。在这里，我们分别定义了一个MessageSender对象（messageSenderImpl）和一个Before Advice对象（logBeforeAdvice），并定义了一个org.springframework.aop.framework.ProxyFactoryBean对象（messageSender），FactoryBean或ApplicationContext将使用ProxyFactoryBean来建立代理对象，在这里就是messageSenderImpl建立代理对象。在ProxyFactoryBean的定义中，proxyInterfaces属性指定了要代理的接口；target指定了要建立代理的目标对象；interceptorNames则指定了应用与指定接口上的Advices对象列表，spring将根据列表中定义的顺序在执行目标对象的方法前、后执行Advice中定义的方法。
现在我们写一个程序来验证下：

java 代码

1. package com.savage.aop;
3. import org.springframework.context.ApplicationContext;
4. import org.springframework.context.support.ClassPathXmlApplication;
6. public class AdviceDemo {
7.    public void main(String[] args) {
8.       ApplicationContext context = new ClassPathXmlApplicationContext("beans-config.xml");
9.       MessageSender sender = (MessageSender)context.getBean("messageSender");
10.       sender.send("message");
11.   }
12. }

执行结果：
Log before public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogBeforeAdvice.
Send Message[message] by http.
正如你所看到的，在执行 MessageSender 的 send 方法前先执行了 LogBeforeAdvice 的方法！在这个例子中，记录日志的代码并没有横切到我们的业务代码中， LogBeforeAdvice 和 HttpMessageSender 彼此不知道对方的存在，而且我们的应用程序 AdviceDemo 对 LogBeforeAdvice 的存在也是一无所知。假如有一天我们的应用程序不需要再业务代码执行前记录日志了，只需要修改 XML 文件中的定义，而不用更改 AdviceDemo 的代码：

xml 代码

1. <bean id="messageSender" class="com.savage.aop.HttpMessageSender">bean>

2 、 After Advice
After Advice 会在目标对象的方法执行完后执行，你可以通过实现 org.springframework.aop.AfterReturingAdvice 接口来实现 After Advice 的逻辑， AfterReturingAdvice 接口定义如下：

java 代码

1. package org.springframework.aop;
3. public interface AfterReturningAdvice {
4.    void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable;
5. }

在 afterReturning 方法中，你可以获得目标方法执行后的返回值、目标方法对象、目标方法的参数以及目标对象。
继续以上面的例子为例，如果要在 MessageSender 的 send 方法执行完后，要再记录日志，那么我们可以先实现 AfterReturningAdvice 接口：

java 代码

1. package com.savage.aop;
3. import org.springframework.aop;
5. public LogAfterAdvice implements AfterReturningAdvice {
6.    public void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable {
7.       System.out.println("Log after " + method + " by LogAfterAdvice.");
8.    }
9. }

然后在 XML 文件中指定 LogAfterAdvice 的实例：

xml 代码

 

1. <?xml version="1.0" encoding="UTF-8"?>    
2. <beans xmlns="http://www.springframework.org/schema/beans"    
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
4. xsi:schemaLocation="http://www.springframework.org/schema/beans    
5. http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">    
6.   
7.     <bean id="messageSenderImpl" class="com.savage.aop.HttpMessageSender"></bean>    
8.       
9.     <bean id="logBeforeAdvice" class="com.savage.aop.LogBeforeAdvice"></bean>    
10.       
11.     <bean id="messageSender" class="org.springframework.aop.framework.ProxyFactoryBean">    
12.         <property name="proxyInterfaces" value="com.savage.aop.MessageSender"/>    
13.         <property name="target" ref="messageSenderImpl"/>    
14.         <property name="interceptorNames">    
15.             <list>     
16.                 <value>logAfterAdvice</value>  
17.             </list>    
18.         </property>    
19.     </bean>    
20. </beans>   

在前面 Before Advice 的基础上，我们为 MessageSender 再指定了一个 LogAfterAdvice 的服务。运行前面的 AdviceDemo ，结果如下：
Send Message[message] by http.
Log after public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogAfterAdvice.

3 、 Around Advice
在上面的 LogAfterAdvice 例子中，我们通过指定 BeforeAdvice 和 AfterReturingAdvice ，在 MessageSender 的 send 方法前后执行额外的业务。实际上，如果需要在业务代码执行前后增加额外的服务，你可以直接通过实现 org.aopalliance.intercept.MethodInterceptor 接口来达到这一目的， MethodInterceptor 定义如下：

java 代码

1. package org.aopalliance.intercept;
3. public interface MethodInterceptor {
4.    public Object invoke(MethodInvocation methodInvocation) throws Throwable;
5. }

例如：

java 代码

1. package com.savage.aop;
3. import org.aopalliance.intercept.MethodInterceptor;
4. import org.aopalliance.intercept.MethodInvocation;
6. public class LogAdvice implements MethodInterceptor {
7.    public Object invoke(MethodInvocation methodInvocation) throws Throwable {
8.       System.out.println("Log before " + methodInvocation.getMethod() + " by LogAdvice.");
9.       Object retValue = methodInvocation.proceed();
10.       System.out.println("Log after " + methodInvocation.getMethod() + " by LogAdvice.");
11.       return retValue;
12.    }
13. }

正如上面所示，在 MethodInterceptor 中你得自行决定是否调用 MethodInvocation 的 proceed() 方法来执行目标对象上的方法， proceed() 方法在执行完后会返回目标对象上方法的执行结果。
MethodInterceptor 在 XML 文件中的定义如下：

xml 代码

 

1. <?xml version="1.0" encoding="UTF-8"?>    
2. <beans xmlns="http://www.springframework.org/schema/beans"    
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
4. xsi:schemaLocation="http://www.springframework.org/schema/beans    
5. http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">    
6.   
7.     <bean id="messageSenderImpl" class="com.savage.aop.HttpMessageSender"></bean>    
8.       
9.     <bean id="logAdvice" class="com.savage.aop.LogAdvice"></bean>    
10.       
11.     <bean id="messageSender" class="org.springframework.aop.framework.ProxyFactoryBean">  
12.         <property id="proxyInterfaces" value="com.savage.aop.MessageSender"/>    
13.         <property id="target" ref="messageSenderImpl"/>  
14.         <property id="interceptorNames">  
15.             <list>  
16.                 <value>logAdvice</value>  
17.             </list>  
18.         </property>  
19.     </bean>  
20. </beans>  

Spring 在真正执行目标对象的方法前，会执行 interceptorNames 中执行的 Advice ，每个 Advice 在执行完自己的业务后，会调用 MethodInvocation 的 proceed() 方法，将执行的主动权移交给下一个 Advice ，直到没有下一个 Advice 为止，在执行完目标对象的方法后， Spring 会再以相反的顺序一层层的返回。例如：

xml 代码

 

1. <bean id="messageSender" class="org.springframework.aop.framework.ProxyFactoryBean">  
2.     <property id="proxyInterfaces" value="com.savage.aop.MessageSender"/>    
3.     <property id="target" ref="messageSenderImpl"/>  
4.     <property id="interceptorNames">  
5.         <list>  
6.             <value>logBeforeAdvice</value>  
7.             <value>logAdvice</value>  
8.             <value>logAfterAdvice</value>  
9.         </list>  
10.     </property>  
11. </bean>  

象上面这个例子， logBeforeAdvice 先会被执行，然后执行 logAdvice ，接着执行 logAfterAdvice ，最后又返回到了 logAdvice 。
现在我们把 LogAdvice 作一下简单的修改，增加一个 id 属性，用以在后面查看 Advice 的调用顺序：

java 代码

1. package com.savage.aop;
3. import org.aopalliance.intercept.MethodInterceptor;
4. import org.aopalliance.intercept.MethodInvocation;
6. public class LogAdvice implements MethodInterceptor {
7.    private static int INSTANCE_NUM = 0;
9.    private int id;
11.    public LogAdvice() {
12.       id = ++INSTANCE_NUM;
13.    }
15.    public Object invoke(MethodInvocation methodInvocation) throws Throwable {
16.       System.out.println("Log before " + methodInvocation.getMethod() + " by LogAdvice[" + id + "].");
17.       Object retValue = methodInvocation.proceed();
18.       System.out.println("Log after " + methodInvocation.getMethod() + " by LogAdvice[" + id + "].");
19.       return retValue;
20.    }
21. }

同时把 XML 中的定义改为：

xml 代码

 

1. <?xml version="1.0" encoding="UTF-8"?>    
2. <beans xmlns="http://www.springframework.org/schema/beans"    
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
4. xsi:schemaLocation="http://www.springframework.org/schema/beans    
5. http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">    
6.   
7.     <bean id="messageSenderImpl" class="com.savage.aop.HttpMessageSender"></bean>    
8.       
9.     <bean id="logBeforeAdvice" class="com.savage.aop.LogBeforeAdvice"></bean>    
10.     <bean id="logAfterAdvice" class="com.savage.aop.LogAfterAdvice"></bean>    
11.     <bean id="logAdvice1" class="com.savage.aop.LogAdvice"></bean>    
12.     <bean id="logAdvice2" class="com.savage.aop.LogAdvice"></bean>    
13.       
14.     <bean id="messageSender" class="org.springframework.aop.framework.ProxyFactoryBean">  
15.         <property id="proxyInterfaces" value="com.savage.aop.MessageSender"/>    
16.         <property id="target" ref="messageSenderImpl"/>  
17.         <property id="interceptorNames">  
18.             <list>  
19.                 <value>logBeforeAdvice</value>  
20.                 <value>logAdvice1</value>  
21.                 <value>logAfterAdvice</value>  
22.                 <value>logAdvice2</value>  
23.             </list>  
24.         </property>  
25.     </bean>  
26. </beans>  

现在再执行 AdviceDemo ，得到如下结果：
Log before public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogBeforeAdvice.
Log before public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogAdvice[1].
Log before public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogAdvice[2].
Send Message[message] by http.
Log after public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogAdvice[2].
Log after public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogAfterAdvice.
Log after public abstract void com.savage.simplespring.bean.MessageSender.send(java.lang.String) by LogAdvice[1].

4 、 Throw Advice
如果想要在异常发生时执行某些业务，你可以通过实现 org.springframework.aop.ThrowsAdvice 接口，这是一个标签接口，没有定义任何方法，你可以在当中为每个你需要处理的异常类定义 afterThrowing 方法，当程序出现异常时， spring 会根据异常的类型调用对应的 afterThrowing 方法。 AfterThrowing 的格式如下：

java 代码

1. afterThrowing([Method],[args],[target],subClassOfThrowable);

方括号 [] 中的参数为可选项，但方法中必须有 subClassOfThrowable ，且必须是 Throwable 的子类。
Spring 在调用完 afterThrowing 方法后，原先的异常会继续在程序中传播，如果象要终止程序对异常的处理，只能在 afterThrowing 方法中抛出其他异常。