上一节:
下一节:

  Spring 基于@AspectJ注解的AOP

  • 基于XML的面向切面编程（AOP）

    @AspectJ是一种将方面声明为带有Java 5注解的常规Java类的样式。通过在基于XML配置文件中包含以下元素，可以启用@AspectJ支持。 
    <aop:aspectj-autoproxy/>
    您还将在应用程序的CLASSPATH上需要以下AspectJ库。这些库位于AspectJ源码包的'lib'目录中，您可以从网络上下载它们。
    • Aspectjrt.jar
    • Aspectjweaver.jar
    • Aspectj.jar
    • aopalliance.jar

  • 声明切面

    Aspects类与任何其他普通bean一样，并且可以像其他任何类一样具有方法和字段，不同之处在于它们将使用@Aspect进行如下注释 
    package org.xyz;

import org.aspectj.lang.annotation.Aspect;

@Aspect
public class AspectModule {
}
    它们将像其他任何bean一样以XML进行配置，如下所示 
    <bean id = "myAspect" class = "org.xyz.AspectModule">
   <!-- configure properties of aspect here as normal -->
</bean>

  • 声明切入点

    一个切入点有助于确定插入点（即方法）以不同的通知来执行的加入。在使用基于@AspectJ的配置时，切入点声明包含两个部分
    • 一个切入点表达式，用于精确确定我们感兴趣的方法执行。
    • 一个切入点签名，包括名称和任意数量的参数。该方法的实际主体是无关紧要的，实际上应该为空。
    以下示例定义了一个名为'businessService'的切入点，该切入点将匹配com.xyz.myapp.service包下的类中可用的每个方法的执行 
    import org.aspectj.lang.annotation.Pointcut;

@Pointcut("execution(* com.xyz.myapp.service.*.*(..))") // expression 
private void businessService() {}  // signature
    以下以下示例定义了一个名为“getname”的切入点，该切入点将匹配com.jc2182包下Student类中可用的getName()方法的执行 
    import org.aspectj.lang.annotation.Pointcut;

@Pointcut("execution(* com.jc2182.Student.getName(..))") 
private void getname() {}

  • 定义通知

    您可以使用代码段中提供的@{ADVICE-NAME}批注来声明五个建议中的任何一个。假设您已经定义了切入点签名方法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(){
   ...
}
    您可以为任何建议定义一个切入点内联。以下是为before通知定义内联切入点的示例 
    
@Before("execution(* com.xyz.myapp.service.*.*(..))")
public doBeforeTask(){
   ...
}

  • 基于@AspectJ的AOP示例

    为了理解与基于@AspectJ的AOP相关的上述概念，让我们编写一个示例。
    假设拥有一个运行良好的Eclipse IDE，并采取以下步骤来创建Spring应用程序-
    1. 创建一个名称为SpringExample的项目，并在创建的项目的src文件夹下创建一个包com.jc2182。
    2. 使用“添加外部JAR”选项添加所需的Spring库，如“Spring Hello World示例”一章中所述。
    3. 在项目中添加特定于Spring AOP的库Aspectjrt.jar，aspectjweaver.jar和Aspectj.jar。
    4. 在com.jc2182包下创建Java类Logging，Student和MainApp。
    5. 在src文件夹下创建Beans配置文件Beans.xml。
    6. 最后一步是创建所有Java文件和Bean配置文件的内容，然后按以下说明运行应用程序。
    这是Logging.java文件的内容。这实际上是Aspect模块的一个示例，它定义了要在各个点调用的方法。 
    package com.jc2182;

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文件的内容 
    package com.jc2182;

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文件的内容 
    
package com.jc2182;

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.jc2182.Student">
      <property name = "name" value = "Zara" />
      <property name = "age"  value = "11"/>      
   </bean>

   <!-- Definition for logging aspect -->
   <bean id = "logging" class = "com.jc2182.Logging"/> 
      
</beans>
    完成创建源和Bean配置文件后，让我们运行该应用程序。如果您的应用程序一切正常，它将显示以下类似消息： 
    
Name : Zara
Age : 11
Exception raised
java.lang.IllegalArgumentException
  at com.jc2182.Student.printThrowException(Student.java:23)
  at com.jc2182.MainApp.main(MainApp.java:14)
上一节:
下一节: