02 AOP切入点详解

Spring AOP支持的AspectJ切入点指示符

Spring AOP支持的AspectJ切入点指示符如下:

指示符 含义
execution 用于匹配方法执行的连接点;
within 用于匹配指定类型内的方法执行;
this 用于匹配当前AOP代理对象类型的执行方法;注意是AOP代理对象的类型匹配,这样就可能包括引入接口也类型匹配;
target 用于匹配当前目标对象类型的执行方法;注意是 目标对象的类型匹配,这样就不包括引入接口也类型匹配;
args 用于匹配当前执行的方法传入的参数为指定类型的执行方法;
@within 用于匹配所以持有指定注解类型内的方法;
@target 用于匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;
@args 用于匹配当前执行的方法传入的参数持有指定注解的执行;
@annotation 用于匹配当前执行方法持有指定注解的方法;
bean Spring AOP扩展的,AspectJ没有对于指示符,用于匹配特定名称的Bean对象的执行方法;
reference pointcut 表示引用其他命名切入点,只有@ApectJ风格支持,Schema风格不支持。

类型匹配语法

首先让我们来了解下AspectJ类型匹配的通配符:

*:匹配任何数量字符;
..:匹配任何数量字符的重复,如在类型模式中匹配任何数量子包;而在方法参数模式中匹配任何数量参数。
+:匹配指定类型的子类型;仅能作为后缀放在类型模式后边。

例如:

样例 说明
java.lang.String 匹配String类型
java.*.String 匹配java包下的任何“一级子包”下的String类型;如匹配java.lang.String,但不匹配java.lang.ss.String
java..* 匹配java包及任何子包下的任何类型;如匹配java.lang.Stringjava.lang.annotation.Annotation
java.lang.*ing 匹配任何java.lang包下的以ing结尾的类型
java.lang.Number+ 匹配java.lang包下的任何Number的自类型;如匹配java.lang.Integer,也匹配java.math.BigInteger

接下来再看一下具体的匹配表达式类型吧:

  1. 匹配类:使用如下方式匹配

    注解? 类的全限定名字
    - 注解:可选,类型上持有的注解,如@Deprecated;
    - 类的全限定名:必填,可以是任何类全限定名。

  2. 匹配方法执行:使用如下方式匹配:

    注解? 修饰符? 返回值类型 类型声明?方法名(参数列表) 异常列表?
    - 注解:可选,方法上持有的注解,如@Deprecated;
    - 修饰符:可选,如public、protected;
    - 返回值类型:必填,可以是任何类型模式;“”表示所有类型;
    - 类型声明:可选,可以是任何类型模式;
    - 方法名:必填,可以使用“
    ”进行模式匹配;
    - 参数列表:“()”表示方法没有任何参数;“(..)”表示匹配接受任意个参数的方法,“(..,java.lang.String)”表示匹配接受java.lang.String类型的参数结束,且其前边可以接受有任意个参数的方法;“(java.lang.String,..)” 表示匹配接受java.lang.String类型的参数开始,且其后边可以接受任意个参数的方法;“(*,java.lang.String)” 表示匹配接受java.lang.String类型的参数结束,且其前边接受有一个任意类型参数的方法;
    - 异常列表:可选,以“throws 异常全限定名列表”声明,异常全限定名列表如有多个以“,”分割,如throws java.lang.IllegalArgumentException, java.lang.ArrayIndexOutOfBoundsException。

  3. 匹配Bean名称:可以使用Bean的id或name进行匹配,并且可使用通配符“*”

组合切入点表达式

AspectJ使用 且(&&)、或(||)、非(!)来组合切入点表达式。

切入点使用示例

  1. execution:使用“execution(方法表达式)”匹配方法执行

    模式 描述
    public * *(..) 任何公共方法的执行
    * com.learn..IHelloService.*() com.learn包及所有子包下IHelloService接口中的任何无参方法
    * com.learn..*.*(..) com.learn包及所有子包下任何类的任何方法
    * com.learn..IHelloService.*(*) com.learn包及所有子包下IHelloService接口的任何只有一个参数方法
    * (!com.learn..IHelloService+).*(..) 非“com.learn包及所有子包下IHelloService接口及子类型”的任何方法
    * com.learn..IHelloService+.*() com.learn包及所有子包下IHelloService接口及子类型的的任何无参方法
    * com.learn..IHelloService*.test*(java.util.Date) com.learn包及所有子包下IHelloService前缀类型的的以test开头的只有一个参数类型为java.util.Date的方法,注意该匹配是根据方法签名的参数类型进行匹配的,而不是根据执行时传入的参数类型决定的,如定义方法:public void test(Object obj);即使执行时传入java.util.Date,也不会匹配的;
    * com.learn..IHelloService.test(..) throws IllegalArgumentException, ArrayIndexOutOfBoundsException com.learn包及所有子包下IHelloService前缀类型的的任何方法,且抛出IllegalArgumentException和ArrayIndexOutOfBoundsException异常
    * (com.learn..IHelloService+ && java.io.Serializable+).*(..) 任何实现了com.learn包及所有子包下 IHelloService接口和java.io.Serializable接口的类型的任何方法
    @java.lang.Deprecated * *(..) 任何持有@java.lang.Deprecated注解的方法
    @(java.lang.Deprecated || com.learn..Secure) * *(..) 任何持有@java.lang.Deprecated或@com.learn..Secure注解的方法
    (@com.learn..Secure *) *(..) 任何返回值类型持有@com.learn..Secure的方法
    * (@com.learn..Secure *).*(..) 任何定义方法的类型持有@com.learn..Secure的方法
    * *(@com.learn..Secure (*) , @com.learn..Secure (*)) 任何签名带有两个参数的方法,且这个两个参数都被@Secure标记了,如public void test(@Secure String str1, @Secure String str1)
    * *((@ com.learn..Secure *))或 * *(@ com.learn..Secure *) 任何带有一个参数的方法,且该参数类型持有@com.learn..Secure;如public void test(Model model);且Model类上持有@Secure注解
    * *( @com.learn..Secure (@com.learn..Secure *) , @ com.learn..Secure (@com.learn..Secure *)) 任何带有两个参数的方法,且这两个参数都被@com.learn..Secure标记了;且这两个参数的类型上都持有@ com.learn..Secure;
    * *( java.util.Map<com.learn..Model, com.learn..Model> , ..) 任何带有一个java.util.Map参数的方法,且该参数类型是以< com.learn..Model, com.learn..Model >为泛型参数;注意只匹配第一个参数为java.util.Map,不包括子类型;如public void test(HashMap<Model, Model> map, String str);将不匹配,必须使用“* *( java.util.HashMap<com.learn..Model,com.learn..Model> , ..)”进行匹配; 而public void test(Map map, int i);也将不匹配,因为泛型参数不匹配 * *(java.util.Collection<@com.learn..Secure *>) 任何带有一个参数(类型为java.util.Collection)的方法,且该参数类型是有一个泛型参数,该泛型参数类型上持有@com.learn..Secure注解; 如public void test(Collection<Model> collection);Model类型上持有@com.learn..Secure * *(java.util.Set<? extends HashMap>) 任何带有一个参数的方法,且传入的参数类型是有一个泛型参数,该泛型参数类型继承与HashMap; Spring AOP目前测试不能正常工作
    * *(java.util.List<? super HashMap>) 任何带有一个参数的方法,且传入的参数类型是有一个泛型参数,该泛型参数类型是HashMap的基类型;如public voi test(Map map);Spring AOP目前测试不能正常工作
    * *(*<@com.learn..Secure *>) 任何带有一个参数的方法,且该参数类型是有一个泛型参数,该泛型参数类型上持有@com.learn..Secure注解;Spring AOP目前测试不能正常工作
  1. within:使用“within(类型表达式)”匹配指定类型内的方法执行;

    模式 描述
    within(com.learn..*) com.learn包及子包下的任何方法执行
    within(com.learn..IHelloService+) com.learn包或所有子包下IHelloService类型及子类型的任何方法
    within(@com.learn..Secure *) 持有com.learn..Secure注解的任何类型的任何方法,必须是在目标对象上声明这个注解,在接口上声明的对它不起作用
  1. 模式 描述
    this(com.learn.model.Member) 当前AOP对象实现了Member接口/抽象类的某些方法,Member的父类未重载的方法不会被处理

    this:使用“this(类型全限定名)”匹配当前AOP代理对象类型的执行方法;注意 是AOP代理对象的类型匹配,这样就可能包括引入接口方法也可以匹配;注意this中使用的表达式必须是类型全限定名,不支持通配符

    模式 描述
    this(com.learn.model.Member) 当前AOP对象实现了Member接口/抽象类的某些方法,Member的父类未重载的方法不会被处理
  2. target:使用“target(类型全限定名)”匹配当前目标对象类型的执行方法;注意 是目标对象的类型匹配,这样就不包括引入接口也类型匹配;注意target中使用的表达式必须是类型全限定名,不支持通配符

    模式 描述
    target(com.learn.model.Member) 当前目标对象(非AOP对象)实现了Member接口/抽象类的某些方法,Member的父类未重载的方法也会被处理
  3. args:使用“args(参数类型列表)”匹配当前执行的方法传入的参数为指定类型的执行方法;注意是匹配传入的参数类型,不是匹配方法签名的参数类型;参数类型列表中的参数必须是类型全限定名,通配符不支持;args属于动态切入点,这种切入点开销非常大,非特殊情况最好不要使用

    模式 描述
    args (com.learn.model.Member,..) 任何一个以接受“传入参数类型为com.learn.model.Member” 开头,且其后可跟任意个任意类型的参数的方法执行,args指定的参数类型是在运行时动态匹配的
  4. @within:使用“@within(注解类型)”匹配所有持有指定注解类型内的方法;注解类型也必须是全限定类型名

    模式 描述
    @within(com.learn.annotation.Secure) 任何目标对象对应的类型持有Secure注解的类方法; 必须是在目标对象上声明这个注解, 在接口上声明的对它不起作用
  5. @target:使用“@target(注解类型)”匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;注解类型也必须是全限定类型名

    模式 描述
    @target(com.learn.annotation.Secure) 任何目标对象持有Secure注解的类方法; 必须是在目标对象上声明这个注解,在接口上声明的对它不起作用
  6. @args:使用“@args(注解列表)”匹配当前执行的方法传入的参数持有指定注解的执行;注解类型也必须是全限定类型名

    模式 描述
    @args(com.learn.annotation.Secure) 任何一个只接受一个参数的方法,且方法运行时传入的参数持有注解com.learn.annotation.Secure;动态切入点,类似于arg指示符
  7. @annotation:使用“@annotation(注解类型)”匹配当前执行方法持有指定注解的方法;注解类型也必须是全限定类型名;

    模式 描述
    @annotation(com.learn.annotation.Secure) 当前执行方法上持有注解com.learn.annotation.Secure将被匹配
  8. bean:使用“bean(Bean id或名字通配符)”匹配特定名称的Bean对象的执行方法;Spring ASP扩展的,在AspectJ中无相应概念;

    模式 描述
    bean(*Service) 匹配所有以Service命名(id或name)结尾的Bean
  9. reference pointcut: 表示引用其他命名切入点, 只有@ApectJ风格支持,Schema风格不支持,如下所示:
    比如我们定义如下切面:

@Aspect
public class HelloServiceAspect {
    //匹配com.learn.service.impl包及其子包下的所有类的所有方法
    @Pointcut("execution(* com.learn.service.impl..*.*(..))")
    public void executeService(){ }
}

可以通过如下方式引用:

@Aspect
@Component
public class HelloServiceExecutor {
    @Before("com.learn.aop.HelloServiceAspect.executeService()")
    public void doBeforeAdvice(){
        System.out.println("我是前置通知!!!");
    }
}

到此我们切入点表达式语法示例就介绍完了,我们这些示例几乎包含了日常开发中的所有情况,但当然还有更复杂的语法等等,如果以上介绍的不能满足您的需要,请参考AspectJ文档。

目录
源码链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 224,815评论 6 522
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,251评论 3 402
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 171,999评论 0 366
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,996评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 69,993评论 6 400
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,477评论 1 314
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,848评论 3 428
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,823评论 0 279
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,361评论 1 324
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,401评论 3 346
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,518评论 1 354
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,119评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,850评论 3 338
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,292评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,424评论 1 275
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,072评论 3 381
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,588评论 2 365