Spring 中基于 AOP 的 @AspectJ

Spring 中基于 AOP 的 @AspectJ

@AspectJ 作為通過 Java 5 注釋注釋的普通的 Java 類，它指的是聲明 aspects 的一種風(fēng)格。通過在你的基于架構(gòu)的 XML 配置文件中包含以下元素，@AspectJ 支持是可用的。

<aop:aspectj-autoproxy/>

你還需要在你的應(yīng)用程序的 CLASSPATH 中使用以下 AspectJ 庫(kù)文件。這些庫(kù)文件在一個(gè) AspectJ 裝置的 ‘lib’ 目錄中是可用的，如果沒有，你可以在 Internet 中下載它們。

• aspectjrt.jar

• aspectjweaver.jar

• aspectj.jar

• aopalliance.jar

　聲明一個(gè) aspect

Aspects 類和其他任何正常的 bean 一樣，除了它們將會(huì)用 @AspectJ 注釋之外，它和其他類一樣可能有方法和字段，如下所示：

package org.xyz;
import org.aspectj.lang.annotation.Aspect;
@Aspect
public class AspectModule {
}

它們將在 XML 中按照如下進(jìn)行配置，就和其他任何 bean 一樣：

<bean id="myAspect" class="org.xyz.AspectModule">
   <!-- configure properties of aspect here as normal -->
</bean>

聲明一個(gè)切入點(diǎn)

一個(gè)切入點(diǎn)有助于確定使用不同建議執(zhí)行的感興趣的連接點(diǎn)（即方法）。在處理基于配置的 XML 架構(gòu)時(shí)，切入點(diǎn)的聲明有兩個(gè)部分：

• 一個(gè)切入點(diǎn)表達(dá)式?jīng)Q定了我們感興趣的哪個(gè)方法會(huì)真正被執(zhí)行。

• 一個(gè)切入點(diǎn)標(biāo)簽包含一個(gè)名稱和任意數(shù)量的參數(shù)。方法的真正內(nèi)容是不相干的，并且實(shí)際上它應(yīng)該是空的。

下面的示例中定義了一個(gè)名為 ‘businessService’ 的切入點(diǎn)，該切入點(diǎn)將與 com.xyz.myapp.service 包下的類中可用的每一個(gè)方法相匹配：

import org.aspectj.lang.annotation.Pointcut;
@Pointcut("execution(* com.xyz.myapp.service.*.*(..))") // expression 
private void businessService() {}  // signature

下面的示例中定義了一個(gè)名為 ‘getname’ 的切入點(diǎn)，該切入點(diǎn)將與 com.tutorialspoint 包下的 Student 類中的 getName() 方法相匹配：

import org.aspectj.lang.annotation.Pointcut;
@Pointcut("execution(* com.tutorialspoint.Student.getName(..))") 
private void getname() {}

聲明建議

你可以使用 @{ADVICE-NAME} 注釋聲明五個(gè)建議中的任意一個(gè)，如下所示。這假設(shè)你已經(jīng)定義了一個(gè)切入點(diǎn)標(biāo)簽方法 businessService()：

@Before("businessService()")
public void doBeforeTask(){
 ...
}
@After("businessService()")
public void doAfterTask(){
 ...
}
@AfterReturning(pointcut = "businessService()", returning="retVal")
public void doAfterReturnningTask(Object retVal){
  // you can intercept retVal here.
  ...
}
@AfterThrowing(pointcut = "businessService()", throwing="ex")
public void doAfterThrowingTask(Exception ex){
  // you can intercept thrown exception here.
  ...
}
@Around("businessService()")
public void doAroundTask(){
 ...
}

你可以為任意一個(gè)建議定義你的切入點(diǎn)內(nèi)聯(lián)。下面是在建議之前定義內(nèi)聯(lián)切入點(diǎn)的一個(gè)示例：

@Before("execution(* com.xyz.myapp.service.*.*(..))")
public doBeforeTask(){
 ...
}

基于 AOP 的 @AspectJ 示例

為了理解上面提到的關(guān)于基于 AOP 的 @AspectJ 的概念，讓我們編寫一個(gè)示例，可以實(shí)現(xiàn)幾個(gè)建議。為了在我們的示例中使用幾個(gè)建議，讓我們使 Eclipse IDE 處于工作狀態(tài)，然后按照如下步驟創(chuàng)建一個(gè) Spring 應(yīng)用程序：

這里是 Logging.java 文件的內(nèi)容。這實(shí)際上是 aspect 模塊的一個(gè)示例，它定義了在各個(gè)點(diǎn)調(diào)用的方法。

package com.tutorialspoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Around;
@Aspect
public class Logging {
   /** Following is the definition for a pointcut to select
    *  all the methods available. So advice will be called
    *  for all the methods.
    */
   @Pointcut("execution(* com.tutorialspoint.*.*(..))")
   private void selectAll(){}
   /** 
    * This is the method which I would like to execute
    * before a selected method execution.
    */
   @Before("selectAll()")
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }
   /** 
    * This is the method which I would like to execute
    * after a selected method execution.
    */
   @After("selectAll()")
   public void afterAdvice(){
      System.out.println("Student profile has been setup.");
   }
   /** 
    * This is the method which I would like to execute
    * when any method returns.
    */
   @AfterReturning(pointcut = "selectAll()", returning="retVal")
   public void afterReturningAdvice(Object retVal){
      System.out.println("Returning:" + retVal.toString() );
   }
   /**
    * This is the method which I would like to execute
    * if there is an exception raised by any method.
    */
   @AfterThrowing(pointcut = "selectAll()", throwing = "ex")
   public void AfterThrowingAdvice(IllegalArgumentException ex){
      System.out.println("There has been an exception: " + ex.toString());   
   }  
}

下面是 Student.java 文件的內(nèi)容：

package com.tutorialspoint;
public class Student {
   private Integer age;
   private String name;
   public void setAge(Integer age) {
      this.age = age;
   }
   public Integer getAge() {
      System.out.println("Age : " + age );
      return age;
   }
   public void setName(String name) {
      this.name = name;
   }
   public String getName() {
      System.out.println("Name : " + name );
      return name;
   }
   public void printThrowException(){
      System.out.println("Exception raised");
      throw new IllegalArgumentException();
   }
}

下面是 MainApp.java 文件的內(nèi)容：

package com.tutorialspoint;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class MainApp {
   public static void main(String[] args) {
      ApplicationContext context = 
             new ClassPathXmlApplicationContext("Beans.xml");
      Student student = (Student) context.getBean("student");
      student.getName();
      student.getAge();     
      student.printThrowException();
   }
}

下面是配置文件 Beans.xml：

<?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:aop="http://www.springframework.org/schema/aop"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd 
    http://www.springframework.org/schema/aop 
    http://www.springframework.org/schema/aop/spring-aop-3.0.xsd ">

    <aop:aspectj-autoproxy/>

   <!-- Definition for student bean -->
   <bean id="student" class="com.tutorialspoint.Student">
      <property name="name"  value="Zara" />
      <property name="age"  value="11"/>      
   </bean>

   <!-- Definition for logging aspect -->
   <bean id="logging" class="com.tutorialspoint.Logging"/> 

</beans>

一旦你已經(jīng)完成的創(chuàng)建了源文件和 bean 配置文件，讓我們運(yùn)行一下應(yīng)用程序。如果你的應(yīng)用程序一切都正常的話，這將會(huì)輸出以下消息：

Going to setup student profile.
Name : Zara
Student profile has been setup.
Returning:Zara
Going to setup student profile.
Age : 11
Student profile has been setup.
Returning:11
Going to setup student profile.
Exception raised
Student profile has been setup.
There has been an exception: java.lang.IllegalArgumentException
.....
other exception content