7、AOP註解

　上一篇博客咱們講解了 AspectJ 框架如何實現 AOP，而後具體的實現方式咱們是經過 xml 來進行配置的。xml 方式思路清晰，便於理解，可是書寫過於麻煩。這篇博客咱們將用 註解 的方式來進行 AOP 配置。

　　爲了便於你們理解，講解方式是這樣的，咱們先給出 xml 的配置，而後介紹如何經過 註解 來進行替代。

 

一、xml 的方式實現 AOP 

　　①、接口 UserService

1 2 3 4 5 6 7 8

package  com.ys.aop;   public  interface  UserService {      //添加 user      public  void  addUser();      //刪除 user      public  void  deleteUser(); }

　　②、實現類 UserServiceImpl

1 2 3 4 5 6 7 8 9 10 11 12

package  com.ys.aop;   public  class  UserServiceImpl  implements  UserService{      @Override      public  void  addUser() {          System.out.println( "增長 User" );      }      @Override      public  void  deleteUser() {          System.out.println( "刪除 User" );      } }

　　③、切面類，也就是通知類 MyAspect

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

package  com.ys.aop;   import  org.aspectj.lang.JoinPoint;     public  class  MyAspect {      /**       * JoinPoint 能獲取目標方法的一些基本信息       * @param joinPoint       */      public  void  myBefore(JoinPoint joinPoint){          System.out.println( "前置通知 ： "  + joinPoint.getSignature().getName());      }            public  void  myAfterReturning(JoinPoint joinPoint,Object ret){          System.out.println( "後置通知 ： "  + joinPoint.getSignature().getName() +  " , -->"  + ret);      }            public  void  myAfterThrowing(JoinPoint joinPoint,Throwable e){          System.out.println( "拋出異常通知 ： "  + e.getMessage());      }            public  void  myAfter(){          System.out.println( "最終通知" );      }   }

　　④、AOP配置文件 applicationContext.xml

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

<?xml version= "1.0"  encoding= "UTF-8" ?> <beans xmlns= "http://www.springframework.org/schema/beans"         xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"         xmlns:context= "http://www.springframework.org/schema/context"         xmlns:aop= "http://www.springframework.org/schema/aop"         xsi:schemaLocation="http: //www.springframework.org/schema/beans                             http: //www.springframework.org/schema/beans/spring-beans.xsd                             http: //www.springframework.org/schema/aop                             http: //www.springframework.org/schema/aop/spring-aop.xsd                             http: //www.springframework.org/schema/context                             http: //www.springframework.org/schema/context/spring-context.xsd">         <!-- 1 、建立目標類 -->      <bean id= "userService"  class = "com.ys.aop.UserServiceImpl" ></bean>        <!-- 2 、建立切面類（通知）  -->      <bean id= "myAspect"  class = "com.ys.aop.MyAspect" ></bean>            <!-- 3 、aop編程           3.1  導入命名空間          3.2  使用 <aop:config>進行配置                  proxy-target- class = "true"  聲明時使用cglib代理                  若是不聲明，Spring 會自動選擇cglib代理仍是JDK動態代理              <aop:pointcut> 切入點 ，從目標對象得到具體方法              <aop:advisor> 特殊的切面，只有一個通知 和 一個切入點                  advice-ref 通知引用                  pointcut-ref 切入點引用          3.3  切入點表達式              execution(* com.ys.aop.*.*(..))              選擇方法         返回值任意   包             類名任意   方法名任意   參數任意            -->      <aop:config>          <aop:aspect ref= "myAspect" >          <!-- 切入點表達式 -->          <aop:pointcut expression= "execution(* com.ys.aop.*.*(..))"  id= "myPointCut" />          <!--  3.1  前置通知                  <aop:before method= ""  pointcut= ""  pointcut-ref= "" />                      method : 通知，及方法名                      pointcut :切入點表達式，此表達式只能當前通知使用。                      pointcut-ref ： 切入點引用，能夠與其餘通知共享切入點。                  通知方法格式： public  void  myBefore(JoinPoint joinPoint){                      參數 1 ：org.aspectj.lang.JoinPoint  用於描述鏈接點（目標方法），得到目標方法名等          -->          <aop:before method= "myBefore"  pointcut-ref= "myPointCut" />                              <!--  3.2 後置通知  ,目標方法後執行，得到返回值                  <aop:after-returning method= ""  pointcut-ref= ""  returning= "" />                      returning 通知方法第二個參數的名稱                  通知方法格式： public  void  myAfterReturning(JoinPoint joinPoint,Object ret){                      參數 1 ：鏈接點描述                      參數 2 ：類型Object，參數名 returning= "ret"  配置的          -->          <aop:after-returning method= "myAfterReturning"  pointcut-ref= "myPointCut"  returning= "ret"  />                        <!--  3.3  最終通知 -->                  <aop:after method= "myAfter"  pointcut-ref= "myPointCut" />                          </aop:aspect>      </aop:config> </beans>

　　⑤、測試

1 2 3 4 5 6 7

@Test public  void  testAop(){      ApplicationContext context =  new  ClassPathXmlApplicationContext( "applicationContext.xml" );      UserService useService = (UserService) context.getBean( "userService" );      useService.addUser();      useService.deleteUser(); }

　　⑥、控制檯打印結果

　　

 

　　上面的例子很簡單，就是在 UserService 的 addUser()方法和 deleteUser()方法增長前置通知和後置通知，這在實際操做中很好理解。好比這是和數據庫打交道的話，那麼咱們在 addUser() 或者 deleteUser() 時，必需要在前面開始事務，操做完畢後提交事務。下面咱們就用註解的方式來配置。

 

回到頂部

二、註解實現 AOP

　　①、導入相應的 jar 包，以及在 applicationContext.xml 文件中導入相應的命名空間。這個在上面的源碼下載連接中都有

　　

1 2 3 4 5 6 7 8 9 10 11 12 13

<?xml version= "1.0"  encoding= "UTF-8" ?> <beans xmlns= "http://www.springframework.org/schema/beans"         xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"         xmlns:context= "http://www.springframework.org/schema/context"         xmlns:aop= "http://www.springframework.org/schema/aop"         xsi:schemaLocation="http: //www.springframework.org/schema/beans                             http: //www.springframework.org/schema/beans/spring-beans.xsd                             http: //www.springframework.org/schema/aop                             http: //www.springframework.org/schema/aop/spring-aop.xsd                             http: //www.springframework.org/schema/context                             http: //www.springframework.org/schema/context/spring-context.xsd">          </beans>

　　

　　②、註解配置 bean

　　xml配置：

1 2 3 4

<!-- 1 、建立目標類 --> <bean id= "userService"  class = "com.ys.aop.UserServiceImpl" ></bean>   <!-- 2 、建立切面類（通知）  --> <bean id= "myAspect"  class = "com.ys.aop.MyAspect" ></bean>

　　註解配置：

　　目標類：

　　

 

 　　切面類：

　　

 

 　　③、配置掃描註解識別

　　這個咱們在前面也講過，上面配置的註解，Spring 如何才能識別這些類上添加了註解呢？咱們必須告訴他。

　　在 applicationContext.xml 文件中添加以下配置：

1 2 3 4 5

<!-- 配置掃描註解類          base- package :表示含有註解類的包名。          若是掃描多個包，則下面的代碼書寫多行，改變 base- package  裏面的內容便可！      -->      <context:component-scan base- package = "com.ys.aop" ></context:component-scan>

　　

　　④、註解配置 AOP

　　1、咱們用xml配置過以下：

　　

　　這是告訴 Spring 哪一個是切面類。下面咱們用註解配置

　　咱們在切面類上添加 @Aspect 註解，以下：

　　

 

 　　2、如何讓 Spring 認識咱們所配置的 AOP 註解呢？光有前面的類註解掃描是不夠的，這裏咱們要額外配置 AOP 註解識別。

　　咱們在 applicationContext.xml 文件中增長以下配置：

1 2	<!-- 2 、肯定 aop 註解生效  --> <aop:aspectj-autoproxy></aop:aspectj-autoproxy>

　　

　　3、註解配置前置通知

　　咱們先看 xml 配置前置通知以下：

1 2 3 4 5 6 7 8 9 10 11

<!-- 切入點表達式 -->          <aop:pointcut expression= "execution(* com.ys.aop.*.*(..))"  id= "myPointCut" />          <!--  3.1  前置通知                  <aop:before method= ""  pointcut= ""  pointcut-ref= "" />                      method : 通知，及方法名                      pointcut :切入點表達式，此表達式只能當前通知使用。                      pointcut-ref ： 切入點引用，能夠與其餘通知共享切入點。                  通知方法格式： public  void  myBefore(JoinPoint joinPoint){                      參數 1 ：org.aspectj.lang.JoinPoint  用於描述鏈接點（目標方法），得到目標方法名等          -->          <aop:before method= "myBefore"  pointcut-ref= "myPointCut" />

　　那麼註解的方式以下：

　　

 

　　4、註解配置後置通知

　　xml 配置後置通知：

1 2 3 4 5 6 7 8

<!--  3.2 後置通知  ,目標方法後執行，得到返回值                  <aop:after-returning method= ""  pointcut-ref= ""  returning= "" />                      returning 通知方法第二個參數的名稱                  通知方法格式： public  void  myAfterReturning(JoinPoint joinPoint,Object ret){                      參數 1 ：鏈接點描述                      參數 2 ：類型Object，參數名 returning= "ret"  配置的          -->          <aop:after-returning method= "myAfterReturning"  pointcut-ref= "myPointCut"  returning= "ret"  />

　　注意看，後置通知有個 returning="ret" 配置，這是用來得到目標方法的返回值的。

　　註解配置以下：

　　

　　5、測試

1 2 3 4 5 6 7

@Test      public  void  testAopAnnotation(){          ApplicationContext context =  new  ClassPathXmlApplicationContext( "applicationContext_Annotation.xml" );          UserService useService = (UserService) context.getBean( "userService" );          useService.addUser();          useService.deleteUser();      }

　　6、控制檯打印結果

　　

 

回到頂部

三、註解改進　　

 　　咱們能夠看前置通知和後置通知的註解配置：

　　

　　注意看紅色框住的部分，很顯然這裏是重複的，並且若是咱們有多個通知方法，那就得在每一個方法名都寫上該註解，並且若是包名夠複雜，也很容易寫錯。那麼怎麼辦呢？

　　解決辦法就是聲明公共切入點：

　　①、在 切面類 MyAspect.java 中新增一個切入點方法 myPointCut()，而後在這個方法上添加 @Pointcut 註解

　　

 

　　②、那麼前置通知和後置通知，咱們能夠進行以下改寫配置：

　　

 

 

回到頂部

四、總結 

 　　上面咱們只進行了前置通知和後置通知的講解，還有好比最終通知、環繞通知、拋出異常通知等，配置方式都差很少，這裏就不進行一一講解了。而後咱們看一下這些通知的註解：

　　@Aspect  聲明切面，修飾切面類，從而得到 通知。

　　通知

　　　　@Before 前置

　　　　@AfterReturning 後置

　　　　@Around 環繞

　　　　@AfterThrowing 拋出異常

　　　　@After 最終

　　切入點

　　　　@PointCut ，修飾方法 private void xxx(){}  以後經過「方法名」得到切入點引用