天天看點
傳回

Spring AOP 中 advice 的四種類型 before after throwing advice around

Spring  AOP(Aspect-oriented programming) 是用于切面程式設計，簡單的來說：AOP相當于一個攔截器，去攔截一些處理，例如：當一個方法執行的時候，Spring 能夠攔截正在執行的方法，在方法執行的前或者後增加額外的功能和處理。

在Spring AOP中支援4中類型的通知：

1：before advice 在方法執行前執行。

2：after  returning  advice 在方法執行後傳回一個結果後執行。

3：after  throwing advice 在方法執行過程中抛出異常的時候執行。

4：Around  advice 在方法執行前後和抛出異常時執行，相當于綜合了以上三種通知。

下面是一個簡單的AOP  advice 的例子：

 首先給出一個簡單的Spring 注入的例子，

定義一個Book類：

[java]  view plain  copy  

  1. package com.myapp.core.aop.advice;  
  2. public class Book {  
  3.    private  String  name;  
  4.    private  String  url;  
  5.    private   int    pages;  
  6.     public String getName() {  
  7.         return name;  
  8.     }  
  9.     public void setName(String name) {  
  10.         this.name = name;  
  11.     }  
  12.     public String getUrl() {  
  13.         return url;  
  14.     }  
  15.     public void setUrl(String url) {  
  16.         this.url = url;  
  17.     }  
  18.     public int getPages() {  
  19.         return pages;  
  20.     }  
  21.     public void setPages(int pages) {  
  22.         this.pages = pages;  
  23.     }  
  24.     public  void  printName(){  
  25.         System.out.println("Book name "+ this.name);  
  26.     }  
  27.     public  void  printUrl(){  
  28.         System.out.println("Book URL "+this.url);  
  29.     }  
  30.     public  void  printThrowException(){  
  31.         throw  new  IllegalArgumentException();  
  32.     }  
  33. }  

相應的配置檔案：

[html]  view plain  copy  

  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-3.0.xsd">  
  6.   <!-- more bean definitions for data access objects go here -->  
  7.     <bean id="book" class="com.myapp.core.aop.advice.Book">  
  8.         <property name="name" value="Effective java" />  
  9.         <property name="url" value="www.google.cn"/>  
  10.         <property name="pages" value="300" />  
  11.     </bean>  
  12. </beans>  

對應的測試類：

[java]  view plain  copy  

  1. package com.myapp.core.aop.advice;  
  2. import org.springframework.context.ApplicationContext;  
  3. import org.springframework.context.support.ClassPathXmlApplicationContext;  
  4. public class MainTest {  
  5.    public static void main(String[] args) {  
  6.        ApplicationContext  context  = new  ClassPathXmlApplicationContext("resource/aop.xml");  
  7.        Book   book  =   (Book) context.getBean("book");  
  8.        System.out.println("---------------------");  
  9.        book.printName();  
  10.        System.out.println("---------------------");  
  11.        book.printUrl();  
  12.        System.out.println("----------------------");  
  13.        try{  
  14.           book.printThrowException();  
  15.        }catch(Exception e){  
  16.          //  e.printStackTrace();  
  17.        }  
  18. }  
  19. }  

輸出結果：

[plain]  view plain  copy  

  1. 三月 20, 2013 11:01:01 上午 org.springframework.context.support.AbstractApplicationContext prepareRefresh  
  2. INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@11e831: startup date [Wed Mar 20 11:01:01 CST 2013]; root of context hierarchy  
  3. 三月 20, 2013 11:01:01 上午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions  
  4. INFO: Loading XML bean definitions from class path resource [resource/aop.xml]  
  5. 三月 20, 2013 11:01:01 上午 org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons  
  6. INFO: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFac[email protected]: defining beans [book]; root of factory hierarchy  
  7. ---------------------  
  8. Book name Effective java  
  9. ---------------------  
  10. Book URL www.google.cn  
  11. ----------------------  

下面對以上的Book加上Spring   AOP   advices

1：before  advice

before advice将在方法執行前執行，建立一個實作MethodBeforeAdvice接口的類能夠定義執行方法前的操作。 類如下： [java]  view plain  copy  

  1. package com.myapp.core.aop.advice;  
  2. import java.lang.reflect.Method;  
  3. import org.springframework.aop.MethodBeforeAdvice;  
  4. public class BeforeMethod  implements MethodBeforeAdvice {  
  5.     @Override  
  6.     public void before(Method arg0, Object[] arg1, Object arg2)  
  7.             throws Throwable {  
  8.         // TODO Auto-generated method stub  
  9.         System.out.println("Before  Method");  
  10.         System.out.println("--------------------");  
  11.     }  
  12. }  

配置對應的bean： 在aop.xml中配置，建立一個BeforeMethod類，一個新的代理命名為：bookProxy 1： target 設定你想攔截的bean 2：interceptorNames設定通知，你想作用于proxy/target上的 對應的配置檔案如下： [html]  view plain  copy  

  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-3.0.xsd">  
  6.   <!-- more bean definitions for data access objects go here -->  
  7.     <bean id="book" class="com.myapp.core.aop.advice.Book">  
  8.         <property name="name" value="Effective java" />  
  9.         <property name="url" value="www.google.cn"/>  
  10.         <property name="pages" value="300" />  
  11.     </bean>  
  12.     <bean id="beforeMethodBean" class="com.myapp.core.aop.advice.BeforeMethod" />  
  13.     <bean id="bookProxy" class="org.springframework.aop.framework.ProxyFactoryBean">  
  14.      <property name="target" ref="book"/>  
  15.      <property name="interceptorNames">  
  16.        <list>  
  17.         <value>beforeMethodBean</value>  
  18.        </list>  
  19.      </property>  
  20.      </bean>  
  21. </beans>  

注意：為了使用proxy（代理）我們需要引入 CGLIB2， pom.xml檔案中注入如下： [html]  view plain  copy  

  1. <dependency>  
  2.     <groupId>cglib</groupId>  
  3.     <artifactId>cglib</artifactId>  
  4.     <version>2.2.2</version>  
  5. </dependency>  

運作測試類： [java]  view plain  copy  

  1. package com.myapp.core.aop.advice;  
  2. import org.springframework.context.ApplicationContext;  
  3. import org.springframework.context.support.ClassPathXmlApplicationContext;  
  4. public class MainTest {  
  5.    public static void main(String[] args) {  
  6.        ApplicationContext  context  = new  ClassPathXmlApplicationContext("resource/aop.xml");  
  7.        Book   book  =   (Book) context.getBean("bookProxy");  
  8.        System.out.println("---------------------");  
  9.        book.printName();  
  10.        System.out.println("---------------------");  
  11.        book.printUrl();  
  12.        System.out.println("----------------------");  
  13.        try{  
  14.           book.printThrowException();  
  15.        }catch(Exception e){  
  16.          //  e.printStackTrace();  
  17.        }  
  18. }  
  19. }  

注意以上獲得的是代理bean； 運作結果如下： [plain]  view plain  copy  

  1. 三月 20, 2013 2:18:56 下午 org.springframework.context.support.AbstractApplicationContext prepareRefresh  
  2. INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@eb67e8: startup date [Wed Mar 20 14:18:55 CST 2013]; root of context hierarchy  
  3. 三月 20, 2013 2:18:56 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions  
  4. INFO: Loading XML bean definitions from class path resource [resource/aop.xml]  
  5. 三月 20, 2013 2:18:57 下午 org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons  
  6. INFO: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@157985: defining beans [book,beforeMethodBean,bookProxy]; root of factory hierarchy  
  7. ---------------------  
  8. Before  Method  
  9. --------------------  
  10. Book name Effective java  
  11. ---------------------  
  12. Before  Method  
  13. --------------------  
  14. Book URL www.google.cn  
  15. ----------------------  
  16. Before  Method  
  17. --------------------  

2： after  advice

在方法運作傳回結果後将執行這個 afterReturning方法，建立的這個類必須實作：AfterReturningAdvice接口 [java]  view plain  copy  

  1. package com.myapp.core.aop.advice;  
  2. import java.lang.reflect.Method;  
  3. import org.springframework.aop.AfterReturningAdvice;  
  4. public class AfterMethod  implements  AfterReturningAdvice {  
  5.     @Override  
  6.     public void afterReturning(Object arg0, Method arg1, Object[] arg2,  
  7.             Object arg3) throws Throwable {  
  8.         // TODO Auto-generated method stub  
  9.         System.out.println("-------------------");  
  10.         System.out.println("After  method ");  
  11.     }  
  12. }  

xml配置檔案： [html]  view plain  copy  

  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-3.0.xsd">  
  6.   <!-- more bean definitions for data access objects go here -->  
  7.     <bean id="book" class="com.myapp.core.aop.advice.Book">  
  8.         <property name="name" value="Effective java" />  
  9.         <property name="url" value="www.google.cn"/>  
  10.         <property name="pages" value="300" />  
  11.     </bean>  
  12.     <bean id="beforeMethodBean" class="com.myapp.core.aop.advice.BeforeMethod" />  
  13.       <bean id="afterMethodBean" class="com.myapp.core.aop.advice.AfterMethod" />  
  14.     <bean id="bookProxy" class="org.springframework.aop.framework.ProxyFactoryBean">  
  15.      <property name="target" ref="book"/>  
  16.      <property name="interceptorNames">  
  17.        <list>  
  18.         <value>beforeMethodBean</value>  
  19.         <value>afterMethodBean</value>  
  20.        </list>  
  21.      </property>  
  22.      </bean>  
  23. </beans>  

運作結果如下： [plain]  view plain  copy  

  1. 三月 20, 2013 2:22:19 下午 org.springframework.context.support.AbstractApplicationContext prepareRefresh  
  2. INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@eb67e8: startup date [Wed Mar 20 14:22:19 CST 2013]; root of context hierarchy  
  3. 三月 20, 2013 2:22:19 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions  
  4. INFO: Loading XML bean definitions from class path resource [resource/aop.xml]  
  5. 三月 20, 2013 2:22:20 下午 org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons  
  6. INFO: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@157985: defining beans [book,beforeMethodBean,afterMethodBean,bookProxy]; root of factory hierarchy  
  7. ---------------------  
  8. Before  Method  
  9. --------------------  
  10. Book name Effective java  
  11. -------------------  
  12. After  method   
  13. ---------------------  
  14. Before  Method  
  15. --------------------  
  16. Book URL www.google.cn  
  17. -------------------  
  18. After  method   
  19. ----------------------  
  20. Before  Method  
  21. --------------------  

3：after  throwing  advice 

當方法執行抛出一個異常後，會執行這個方法，建立一個類實作：ThrowsAdvice接口，建立一個afterThrowing攔截：IllegalArgumentException異常。 類如下： [java]  view plain  copy  

  1. package com.myapp.core.aop.advice;  
  2. import org.springframework.aop.ThrowsAdvice;  
  3. public class ThrowException  implements ThrowsAdvice{  
  4.     public  void  afterThrowing(IllegalArgumentException e)  throws  Throwable{  
  5.         System.out.println("after Throwing  Exception");  
  6.     }  
  7. }  

xml中配置檔案如下： [html]  view plain  copy  

  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-3.0.xsd">  
  6.   <!-- more bean definitions for data access objects go here -->  
  7.     <bean id="book" class="com.myapp.core.aop.advice.Book">  
  8.         <property name="name" value="Effective java" />  
  9.         <property name="url" value="www.google.cn"/>  
  10.         <property name="pages" value="300" />  
  11.     </bean>  
  12.     <!-- before  advice -->  
  13.     <bean id="beforeMethodBean" class="com.myapp.core.aop.advice.BeforeMethod" />  
  14.     <!-- after  advice -->  
  15.       <bean id="afterMethodBean" class="com.myapp.core.aop.advice.AfterMethod" />  
  16.       <!-- throwing  advice -->  
  17.       <bean id="throwException" class="com.myapp.core.aop.advice.ThrowException" />  
  18.     <bean id="bookProxy" class="org.springframework.aop.framework.ProxyFactoryBean">  
  19.      <property name="target" ref="book"/>  
  20.      <property name="interceptorNames">  
  21.        <list>  
  22.         <value>beforeMethodBean</value>  
  23.         <value>afterMethodBean</value>  
  24.         <value>throwException</value>  
  25.        </list>  
  26.      </property>  
  27.      </bean>  
  28. </beans>  

執行結果如下： [plain]  view plain  copy  

  1. 三月 20, 2013 2:37:36 下午 org.springframework.context.support.AbstractApplicationContext prepareRefresh  
  2. INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@eb67e8: startup date [Wed Mar 20 14:37:36 CST 2013]; root of context hierarchy  
  3. 三月 20, 2013 2:37:36 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions  
  4. INFO: Loading XML bean definitions from class path resource [resource/aop.xml]  
  5. 三月 20, 2013 2:37:36 下午 org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons  
  6. INFO: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@157985: defining beans [book,beforeMethodBean,afterMethodBean,throwException,bookProxy]; root of factory hierarchy  
  7. ---------------------  
  8. Before  Method  
  9. --------------------  
  10. Book name Effective java  
  11. -------------------  
  12. After  method   
  13. ---------------------  
  14. Before  Method  
  15. --------------------  
  16. Book URL www.google.cn  
  17. -------------------  
  18. After  method   
  19. ----------------------  
  20. Before  Method  
  21. --------------------  
  22. after Throwing  Exception  

4：Around  advice

這個advice 聯合了上面的三個advices，在方法執行期間執行，建立一個類實作MethodInterceptor接口，需要在方法中執行Object result = methodInvocation.proceed();方法才能得到執行，否則方法不會執行。 類如下： [java]  view plain  copy  

  1. package com.myapp.core.aop.advice;  
  2. import java.util.Arrays;  
  3. import org.aopalliance.intercept.MethodInterceptor;  
  4. import org.aopalliance.intercept.MethodInvocation;  
  5. public class AroundMethod  implements MethodInterceptor{  
  6.     @Override  
  7.     public Object invoke(MethodInvocation methodInvocation) throws Throwable {  
  8.         // TODO Auto-generated method stub  
  9.         System.out.println("method  name:" + methodInvocation.getMethod().getName());  
  10.         System.out.println("method  arguments" + Arrays.toString(methodInvocation.getArguments()));  
  11.         System.out.println("Around  method : before ");  
  12.         try{  
  13.             Object result = methodInvocation.proceed();  
  14.             System.out.println("Around method : after ");  
  15.             return  result;  
  16.         }catch(IllegalArgumentException e){  
  17.             System.out.println("Around method : throw  an  exception ");  
  18.             throw  e;  
  19.         }  
  20.     }  
  21. }  

配置檔案如下： [html]  view plain  copy  

  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-3.0.xsd">  
  6.   <!-- more bean definitions for data access objects go here -->  
  7.     <bean id="book" class="com.myapp.core.aop.advice.Book">  
  8.         <property name="name" value="Effective java" />  
  9.         <property name="url" value="www.google.cn"/>  
  10.         <property name="pages" value="300" />  
  11.     </bean>  
  12.     <bean id="aroundMethod"  class="com.myapp.core.aop.advice.AroundMethod" />  
  13.     <bean id="bookProxy" class="org.springframework.aop.framework.ProxyFactoryBean" >  
  14.      <property name="target" ref="book"/>  
  15.      <property name="interceptorNames">  
  16.        <list>  
  17.          <value>aroundMethod</value>  
  18.        </list>  
  19.      </property>  
  20.      </bean>  
  21. </beans>  

測試結果： [plain]  view plain  copy  

  1. 三月 20, 2013 3:02:19 下午 org.springframework.context.support.AbstractApplicationContext prepareRefresh  
  2. INFO: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@eb67e8: startup date [Wed Mar 20 15:02:19 CST 2013]; root of context hierarchy  
  3. 三月 20, 2013 3:02:19 下午 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions  
  4. INFO: Loading XML bean definitions from class path resource [resource/aop.xml]  
  5. 三月 20, 2013 3:02:19 下午 org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons  
  6. INFO: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@e29127: defining beans [book,aroundMethod,bookProxy]; root of factory hierarchy  
  7. ---------------------  
  8. method  name:printName  
  9. method  arguments[]  
  10. Around  method : before   
  11. Book name Effective java  
  12. Around method : after   
  13. ---------------------  
  14. method  name:printUrl  
  15. method  arguments[]  
  16. Around  method : before   
  17. Book URL www.google.cn  
  18. Around method : after   
  19. ----------------------  
  20. method  name:printThrowException  
  21. method  arguments[]  
  22. Around  method : before   
  23. Around method : throw  an  exception   
Spring AOP 中 advice 的四種類型 before after throwing advice around

around  advice得到實作。 over

Spring架構 java
上一篇: spring資料源配置四種方式配置Spring資料源
下一篇: linux終端系統聯網,ubuntu下使用終端指令行上網的方法

繼續閱讀