Spring AOP 基于注解详解及实例代码

(编辑：jimmy 日期: 2024/12/25 浏览：3 次 )

Spring AOP 基于注解详解及实例代码

1.启用spring对@AspectJ注解的支持:

<beans xmlns:aop="http://www.springframework.org/schema/aop"...>
  <!--启动支持-->
  <aop:aspectj-autoproxy />
</beans>

也可以配置AnnotationAwareAspectJAutoProxyCreator Bean来启动Spring对@AspectJ注解的支持

<beans...>
  <bean class="org.springframework.aop.aspectj.annotation.AnnotationAwareAspectJAutoProxyCreator" />
</beans>

2.为了在应用中启动@AspectJ的支持，还需亚奥增加两个AspectJ库：aspectjweaver.jar和aspectjrt.jar。除此之外，Spring AOP还需要依赖一个aopllliance.jar包

3.定义切面Bean

@Aspect
public class LogAspect {
  //...
}

4.定义增强处理器，如Before

@Aspect
public class LogAspect {
  @Before("execution(* *.*.*(..))")
  public void authority() {
    System.out.println("执行目标方法前模拟权限检查") ;
  }
}

@AfterReturning注解将在目标方法正常完成后被织入，该注解指定如下两个属性:
1>pointcut/value：用于指定该切入点对应的切入表达式
2>returning：指定一个形参名，用于访问目标方法的返回值。同时如果在Advice方法中指定该形参类型，将会限制目标方法的返回值必须为该类型

@AfterThrowing注解用于处理程序中未处理的异常。该注解指定如下连个属性：
1>pointcut/value：用于指定该切入点对应的切入表达式
2>throwing：该属性值也指定一个形参名，用于表示目标方法抛出的未处理的异常。同时如果在Advice方法中指定该形参类型，将会限制目标方法必须抛出指定类型的异常

@Around注解近似于Before和AfterReturning增强处理的总和，它可以决定目标方法在什么时候执行，因为该注解修饰的Advice方法第一个形参为ProceedingJoinPoint类型，ProceedingJoinPoint参数有一个proceed()方法，调用该方法可以执行目标方法。如果在Advice方法中没有显示调用该方法，那么目标方法将不会被执行：

@Aspect
public class LogAspect {
  @Around("execution(* *.*.*(..))")
  public Object aroundAdvice(ProceedingJoinPoint jp) {
    System.out.println("执行Around增强处理") ;
    //获取目标方法的原始参数
    Object[] args = jp.getArgs() ;
    //执行目标方法获取返回值
    Object result = jp.proceed(args) ;
    System.out.priontln("Around增强处理执行完毕") ;
  }
}

5.如果需要获取目标方法的相关信息，可以在定义增强处理方法时将第一个参数定义为JoinPoint类型，当该增强处理方法被调用时，该JoinPoint参数就代表了织入增强处理的连接点。JoinPoint类似与Around增强处理的ProceedingJoinPoint，只不过后者特定于Around增强处理使用。JoinPoint里包含了如下几个常用的方法：

  1>Object[] getArgs()：返回执行目标方法时的参数
  2>Signature getSignature()：返回被增强的方法的相关信息
  3>Object getTarget()：返回被织入增处理的目标对象
  4>Object getThis()：返回AOP框架为目标对象生成的代理对象

示例Before增强处理获取目标方法的相关信息

@Aspect
public class LogAspect {
  @Before("execution（* *.*.*(..))")
  public void beforeAdvice(JoinPoint jp) {
    //获取目标方法的参数
    Object[] args = jp.getArgs() ;
    System.out.println("目标方法的参数列表为:" + Array.toString(args)) ;
    //获取目标方法的方法名
    String methodName = jp.getSignature().getName() ;
    System.out.println("目标方法的方法名为:" + methodNamme) ;
    //获取被织入增强处理的目标对象LogAspect
    System.out.println("被织入增强处理的目标对象为:" + jp.getTarget()) ;
  }
}

6.如果两个不同的Aspect里的两个Advice需要在同一个JoinPoint连接点被植入时，Spring AOP将会以随机的顺序来织入这两个增强处理。如果需要指定他们的优先级，有两种方法:

  1>Aspect类实现org.springframework.core.Ordered接口，并且实现其抽象方法:int getOrder()；该方法的返回值越小，优先级就越高

  2>直接使用@Order注解来修饰Aspect类，该注解需要指定一个int型的value属性值

7.定义切入点Pointcut：包含两个部分：一个切入点表达式和一个包含名字和任意参数的方法签名：

@Pointcut("execution(* *.*.*(..))")
public void simplepointcut() {
  //...
}

//定义了Pointcut之后，就可以在其他的增强处理中使用其方法名作为pointcut属性值了:
@Before(pointcut="simplepointcut()")
//等同于pointcut="execution(* *.*.*(..))"
public void beforeAspect() {
  //...
}

//如果使用的pointcut切入点不是同一类，就需要使用类来修饰如:
  @Before(pointcut="Simple.simplepointcut()")
  ...

8.切入点指示符：也就是之前增强处理中指定的execution一类，用于指定目标方法要满足的条件。Spring AOP一共支持如下几种切入点指示符:

1>execution：用于匹配执行方法的joinpoint

  2>within：用于限定匹配特定类型的joinpoint 如:
    within(com.cheng.joinpoint.*)

  3>this：用于限定AOP代理必须是指定类型的实例，匹配该对象的所有连接点 如:
    this(com.cheng.aop.aopService)

  4>target：用于限定目标独享必须是指定类型的实例

  5>args：用于对连接点的参数类型进行限制，要求参数类型必须是指定类型的实例，多个参数类型使用逗号隔开

  6>bean：用于限定只匹配指定Bean的实例内的连接点，需要传入Bean的id/name

9>最后，我们需要在Spring配置文件中使用元素来指定自动搜索切面类

<beans...>
  <!--指定自动搜索Bean组件、自动搜索切面类-->
  <context:component-scan base-package="com.cheng">
    <context:include-filter type="annotation" expression="org.aspectj.lang.annotation.Aspect" />
  </context:component-scan>
</beans>

感谢阅读，希望能帮助到大家，谢谢大家对本站的支持！

上一篇：JSP Spring ApplicationContext的国际化支持
下一篇：Spring 配置文件XML头部文件模板实例详解