欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

使用Spring开启注解AOP的支持放置的位置

程序员文章站 2022-03-10 09:47:55
目录spring开启注解aop的支持放置的位置spring aop注解配置启动aop配置用 aspectj 注解声明切面利用方法签名编写 aspectj 切入点表达式spring开启注解aop的支持放...

spring开启注解aop的支持放置的位置

放在springmvc的aop,需要在springmvc的配置文件中写开启aop,而不是spring的配置文件

最近使用aop来记录controller的日志.

但是发现没有起作用.

后来发现是因为我的 aop 是写在controller层(在springmvc的容器中 -web中)

而开启aop配置却写在spring(applicationcontext.xml)中

所以不起作用,需要在springmvc.xml的配置文件中也开启才行

spring aop注解配置

启动aop配置

要在 spring 应用中使用 aspectj 注解,需要如下支持:

1. 在 classpath 下包含 aspectj 类库:aopalliance.jar、aspectj.weaver.jar 和 spring-aspects.jar

2. 将 aop schema 添加到 bean 配置文件 <beans> 根元素中。

3. 在 bean 配置文件中定义一个空的 xml 元素 <aop:aspectj-autoproxy><aop:aspectj-autoproxy/>

注:当 spring ioc 容器侦测到 bean 配置文件中的<aop:aspectj-autoproxy><aop:aspectj-autoproxy/> 元素时,会自动为与 aspectj 切面匹配的 bean 创建代理。

用 aspectj 注解声明切面

要在 spring 中声明 aspectj 切面,只需要在 ioc 容器中将切面声明为 bean 实例。当在 spring ioc 容器中初始化 aspectj 切面之后,spring ioc 容器就会为那些与 aspectj 切面相匹配的 bean 创建代理。

在 aspectj 注解中,切面只是一个带有 @aspect 注解的 java 类。通知是标注有某种注解的简单的 java 方法。

aspectj 支持 5 种类型的通知注解:

  • @before:前置通知,在方法执行之前执行
  • @after:后置通知,在方法执行之后执行
  • @afterrunning:返回通知,在方法返回结果之后执行
  • @afterthrowing:异常通知,在方法抛出异常之后
  • @around:环绕通知,围绕着方法执行

前置通知

前置通知:在方法执行之前执行的通知。

前置通知使用 @before 注解,并将切入点表达式的值作为注解值。

/**
 * 把这个类声明为一个切面:
 * 1. 使用注解“@repository”把该类放入到ioc容器中
 * 2. 使用注解“@aspect”把该类声明为一个切面
 * 
 * 设置切面的优先级:
 * 3. 使用注解“@order(number)”指定前面的优先级,值越小,优先级越高
 */
@order(1)
@aspect
@repository
public class daologaspect {
 /**
  * 声明该方法是一个前置通知:在目标方法开始之前执行
  * '@before'标识这个方法是个前置通知,切点表达式表示执行 userdao类的 insert(user user) 方法.
  */
 @before("execution(public xyz.huning.spring4.aop.dao.user xyz.huning.spring4.aop.dao.impl.userdao.insert(xyz.huning.spring4.aop.dao.user))")
 public void beforeinsert()
 {
  system.out.println("--beforeinsert------------");
 }
}

利用方法签名编写 aspectj 切入点表达式

最典型的切入点表达式是根据方法的签名来匹配各种方法:

  • execution * xyz.huning.spring4.aop.dao.impl.userdao.*(..):匹配userdao中声明的所有方法,第一个 * 代表任意修饰符及任意返回值。第二个 * 代表任意方法。 .. 匹配任意数量的参数。若目标类与接口与该切面在同一个包中,可以省略包名。
  • execution public * userdao.*(..):匹配 userdao类的所有公有方法。
  • execution public double userdao.*(..):匹配 userdao中返回 double 类型数值的方法。
  • execution public double userdao.*(double, ..):匹配第一个参数为 double 类型的方法, .. 匹配任意数量任意类型的参数。
  • execution public double userdao.*(double,double):匹配参数类型为 double,double 类型的方法。

合并切入点表达式

在 aspectj 中,切入点表达式可以通过操作符 &&,||,! 结合起来。

 /**
  * 合并切入点表达式
  * 在 aspectj 中,切入点表达式可以通过操作符 &&,||,! 结合起来。
  */
 @pointcut("execution(* *.insert(..)) || execution(* *.delete(..))")
 public void insertdeletejoinpoint(){}

让通知访问当前连接点的细节

可以在通知方法中声明一个类型为 joinpoint 的参数。然后就能访问链接细节。如方法名称和参数值。

 /**
  * 声明该方法是一个前置通知:在目标方法开始之前执行
  */
 @before("execution(public xyz.huning.spring4.aop.dao.user xyz.huning.spring4.aop.dao.impl.userdao.insert(xyz.huning.spring4.aop.dao.user))")
 public void beforeinsert(joinpoint joinpoint)
 {
  system.out.println("--beforeinsert with joinpoint------------");
  //获取方法名称
  string methodname = joinpoint.getsignature().getname();
  //获取参数值
  string args = arrays.tostring(joinpoint.getargs());
  system.out.println("taget method: " + methodname);
  system.out.println("taget method args: " + args);
 }

后置通知

后置通知是在连接点完成之后执行的, 即连接点返回结果或者抛出异常的时候,下面的后置通知记录了方法的终止。

一个切面可以包括一个或者多个通知。

 /**
  * 声明该方法是一个后置通知:在目标方法开始之后执行(即使目标方法执行出现异常也会执行)
  * 后置通知中不能访问目标方法的执行结果
  */
 @after("execution(public xyz.huning.spring4.aop.dao.user xyz.huning.spring4.aop.dao.impl.userdao.insert(xyz.huning.spring4.aop.dao.user))")
 public void afterinsert()
 {
  system.out.println("--afterinsert------------");
 }

返回通知

无论连接点是正常返回还是抛出异常,后置通知都会执行。如果只想在连接点返回的时候记录日志,应使用返回通知代替后置通知。在返回通知中,只要将 returning 属性添加到 @afterreturning 注解中,就可以访问连接点的返回值。该属性的值即为用来传入返回值的参数名称。

必须在通知方法的签名中添加一个同名参数。在运行时,spring aop 会通过这个参数传递返回值。原始的切点表达式需要出现在 pointcut 属性中。

 /**
  * 声明该方法是一个返回通知:在目标方法正常结束之后返回(目标方法执行出现异常时不再执行)
  * 返回通知可以访问目标方法的执行结果
  */
 @afterreturning(value="execution(* xyz.huning.spring4.aop.dao.impl.userdao.query(..))",returning="result")
 public void afterqueryreturning(joinpoint joinpoint,object result)
 {
  system.out.println("--afterqueryreturning with joinpoint and result------------");
  string methodname = joinpoint.getsignature().getname();
  string args = arrays.tostring(joinpoint.getargs());
  system.out.println("taget method: " + methodname);
  system.out.println("taget method args: " + args);
  system.out.println("taget method execute result: " + result);
 }

异常通知

只在连接点抛出异常时才执行异常通知,将 throwing 属性添加到 @afterthrowing 注解中,也可以访问连接点抛出的异常。throwable 是所有错误和异常类的超类。

所以在异常通知方法可以捕获到任何错误和异常。如果只对某种特殊的异常类型感兴趣,可以将参数声明为其他异常的参数类型。然后通知就只在抛出这个类型及其子类的异常时才被执行。

 /**
  * 声明该方法是一个异常通知:在目标方法出现异常时执行此方法
  * 异常通知可以访问目标方法中的异常对象,且可以指定在出现特定异常时再执行通知代码
  */
 @afterthrowing(value="execution(* xyz.huning.spring4.aop.dao.impl.userdao.*(..))",throwing="e")
 public void afterallthrowing(joinpoint joinpoint,exception e)
 {
  system.out.println("--afterallthrowing with throwing------------");
  system.out.println("taget method execute exception: " + e);
 }
 
 /**
  * 指定在出现特定异常时再执行通知代码
  */
 @afterthrowing(value="execution(* xyz.huning.spring4.aop.dao.impl.userdao.*(..))",throwing="e")
 public void afterallthrowing(joinpoint joinpoint,nullpointerexception e)
 {
  system.out.println("--afterallthrowing with nullpointerexception------------");
  system.out.println("taget method execute exception: " + e);
 }

环绕通知

环绕通知是所有通知类型中功能最为强大的,能够全面地控制连接点。甚至可以控制是否执行连接点。对于环绕通知来说,连接点的参数类型必须是 proceedingjoinpoint 。

它是 joinpoint 的子接口,允许控制何时执行,是否执行连接点。在环绕通知中需要明确调用 proceedingjoinpoint 的 proceed() 方法来执行被代理的方法。如果忘记这样做就会导致通知被执行了,但目标方法没有被执行。

注意:环绕通知的方法需要返回目标方法执行之后的结果,即调用 joinpoint.proceed()的返回值,否则会出现空指针异常。

 /**
  * 环绕通知需要携带proceedingjoinpoint类型的参数
  * 环绕通知类似于动态代理的全过程:proceedingjoinpoint类型的参数可以决定是否执行目标方法
  * 且环绕通知必须有返回值,返回值即为目标方法的返回值
  */
 @around("execution(* xyz.huning.spring4.aop.dao.impl.userdao.delete(..))")
 public object around(proceedingjoinpoint pj)
 {
     object result = null;
     string methodname = pj.getsignature().getname();
     
     try{
      //前置通知
      system.out.println("the method: " + methodname + "前置通知");
      //执行目标方法
      result = pj.proceed();
      //返回通知
      system.out.println("the method: " + methodname + "返回通知");
     }catch(throwable e)
     {
      //异常通知
      system.out.println("the method: " + methodname + "异常通知: " + e.getmessage());
     }
     //后置通知
     system.out.println("the method: " + methodname + "后置通知");
     
     return result;
 }

指定切面的优先级

在同一个连接点上应用不止一个切面时,除非明确指定,否则它们的优先级是不确定的。

切面的优先级可以通过实现 ordered 接口或利用 @order 注解指定。实现 ordered 接口,,getorder() 方法的返回值越小,优先级越高。若使用 @order 注解,序号出现在注解中。

重用切入点定义

在编写 aspectj 切面时,可以直接在通知注解中书写切入点表达式,但同一个切点表达式可能会在多个通知中重复出现。

在 aspectj 切面中,可以通过 @pointcut 注解将一个切入点声明成简单的方法。切入点的方法体通常是空的,因为将切入点定义与应用程序逻辑混在一起是不合理的。

切入点方法的访问控制符同时也控制着这个切入点的可见性。如果切入点要在多个切面*用,最好将它们集中在一个公共的类中。在这种情况下,它们必须被声明为 public。

在引入这个切入点时,必须将类名也包括在内。如果类没有与这个切面放在同一个包中,还必须包含包名。其他通知可以通过方法名称引入该切入点。

 /**
  * 
  * ************重用切点表达式********************************************************************************
  * 
  * 定义一个方法,用于声明切入点表达式,一般的,该方法中不再不要填土其他的代码。
  * 使用@pointcut来声明切入点表达式。
  * 同一个类中其他通知直接使用方法名来引用当前的切入点表达式,如:@before("method()")
  * 同一个报下其他类中的通知需要在方法名前加类名,如:@before("class.method()")
  * 其他包下面类中的通知需要在方法名前加类的全额限定名,如:@afterreturning(value="package.class.method()",returning="result")
  * 
  * 第一个星号代表匹配任意修饰符及任意返回值, 第二个星号表示任意方法名称,参数列表中的两个点号表示任意数量和类型的参数
  */
 @pointcut("execution(* xyz.huning.spring4.aop.dao.impl.userdao.*(..))")
 public void userdaojoinpoint(){}
 

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。

相关标签: Spring 注解 AOP