SpringAop切入点execution表达式详解

2022-07-02 14:09:55

一、Aspect切入点语法定义

在使用spring框架配置AOP的时候,不管是通过XML配置文件形式,还是注解的方式都需要定义pointcut(切入点),pointcut称之为切入点。

例如 :

  • 定义切入点表达式  :
execution (* com.sample.service.impl..*.*(..))

上面的execution()是最常用的切点函数,其语法如下所示:

整个表达式可以分为五个部分

  •  1、execution():表达式主体。
  • 2、第一个*号:表示返回类型,*号表示所有的类型。
  •  3、包名:表示需要拦截的包名,后面的两个句点分别表示当前包和当前包的所有子包,com.sample.service.impl包、子孙包下所有类的方法。
  •  4、第二个*号:表示类名,*号表示所有的类。
  •  5、*(..) :第三个星号表示方法名,*号表示所有的方法,后面括弧里面表示方法的参数,两个句点表示任何参数。

下面给出一些常见切入点表达式的例子: 借鉴(https://smallbee.iteye.com/blog/2213078)

  • 任意公共方法的执行:

    execution(public * *(..))    : 表明任何返回类型、类名和参数的任何公共方法都将被通知。
  • 任何一个以"set"开始的方法的执行:

    execution(* set*(..))
  • AccountService接口的任意方法的执行:

    execution(* com.xyz.service.AccountService.*(..))
  • 定义在service包里的任意方法的执行:

    execution(* com.xyz.service.*.*(..))
  • 定义在service包或者子包里的任意类的任意方法的执行:

    execution(* com.xyz.service..*.*(..))

二、如何定义多个切入点,在多个表达式之间如何表示

  • 使用 ||,   or表示 或
  • 使用 &&,and表示 与
  • 使用not,!表示 非

三、execution表达式

1、匹配指定包下所有类方法 :

execution(* com.baidu.dao.*(..)) 不包含子包

2.   匹配指定包以及及指定包下面的子包所有类 :

execution(* com.baidu.dao..*(..))  ..*表示当前包、子孙包下所有类

3、匹配指定类所有方法 :

execution(* com.baidu.service.UserService.*(..))

4、匹配实现特定接口所有类方法 :

execution(* com.baidu.dao.GenericDAO+.*(..))

5、匹配所有save开头的方法 :

execution(* save*(..))

另外,签名可分为类型签名和方法签名,下面介绍两种类型 的区别,参考自:https://www.jianshu.com/p/1ff6c1edbb7b

四、类型签名表达式

为了根据类型(比如接口、类名或者包名过滤方法),SpringAOP提供了Within关键字。类型签名模式如下,其中可以使用package name或者class name替换type name。

Within(<type name>)

接下来列举一些类型签名用法的示例:

  • within(net.yangki..*):该通知将匹配net.yangki包及其子包中所有类中的所有方法。
  • within(net.yangki.spring.demo.MyService):该通知将匹配MyService类中的所有方法。
  • within(MyServiceInterface+):该通知将匹配所有实现了MyServiceInterface接口的类的所有方法。
  • within(net.yangki.spring.demo.MyBaseService+):该通知将匹配MyBaseService类以及其子类的所有方法。

五、方法签名表达式

如果想根据方法签名进行过滤,可以使用关键字execution。模式如下:

execution(<scope><return-type><fully-qualified-class-name>.*(parameters))

此时,对于与给定的作用域、返回类型、完全限定类名以及参数相匹配的方法,都会应用指定的通知。方法的作用域可以是公共的、保护的或者私有的。如果不想使用参数过滤,可以指定两个点..,以表明方法可以接受任何数量和任何类型的参数。下面对方法签名的示例进行了简单的概述:

  • execute(* net.yangki.soring.demo.MyBean.*(..)):该通知将匹配MyBean中的所有方法。
  • execute(public * net.yangki.spring.demo.MyBean.*(..)):该通知将匹配MyBean中的所有公共方法。
  • execute(public String net.yangki.spring.demo.MyBean.*(..)):该通知将匹配MyBean中的所有返回值为String类型的公共方法。
  • execute(public * net.yangki.spring.demo.MyBean.*(long,..)):该通知将匹配MyBean第一个参数被定义为long的所有公共方法。

六、其他替代的切入点指示符

该部分将举例SpringAOP所支持的指示符。AOP仅支持在其他AOP项目中可用的指示符的一个子集。

  • bean(* Service):根据名称使用关键字bean进行过滤。该切入点表达式将与名称中带有后缀Service的Bean相匹配。
  • @annotation(net.yangki.spring.demo.MarkerMethodAnnotation):根据所应用的注解对方法进行过滤。该切入点表达式表明使用了MarkerMethodAnnotation注解的方法将被通知。
  • within(net.yangki.spring.demo.MarkerAnnotation):当带有关键字within的切入点表达式与一个包、类或者接口相匹配时,可以根据类所使用的注解限制对类的过滤。此时,使用了MarkerMethodAnnotation注解的类将被@within关键字通知。
  • This(net.yangki.spring.demo.MarkerInterface):该切入点表达式将对任何实现了MarkerInterface接口的代理对象的方法进行过滤。

七、通配符

在定义表达式时,还可以使用通配符。比如*..或者+。如下表

通配符定义
..该通配符匹配方法定义中的任何数量的参数,此外还匹配类定义中任何数量的包
+该通配符匹配给定类的任何子类
*该通配符匹配任何数量的字符
  • 作者:Thinkingcao
  • 原文链接:https://thinkingcao.blog.csdn.net/article/details/84872610
    更新时间:2022-07-02 14:09:55