spring---@Pointcut表达式

spring语法

execution

方法表达式：execution(modifiers-pattern? ret-type-pattern declaring-type-pattern/name-pattern(param-pattern) throws-pattern?)

• 修饰符匹配(modifier-pattern?)：可以省略。代表匹配任意修饰符方法；或者显示指定public、private
• 返回值匹配(ret-type-pattern)：不可省略。可以为*，表示任何返回值；或者全路径的类名
• 类路径匹配(declaring-type-pattern)/方法名匹配(name-pattern)：两种任选一个，不可省略。全路径类名或者正则方法名；或者*，代表所有。
• 参数匹配((param-pattern))：不可省略。() 匹配一个不需要参数的方法;(…) 匹配任何数量（零或更多）的参数;(*) 模式匹配一个需要任何类型的参数的方法;(*,java.lang.String) 表示匹配有两个参数的方法，第一个参数可以是任意类型，而第二个参数是String类型；
• 异常类型匹配(throws-pattern?)：可以省略，代表匹配任意异常，或者全路径显示指定。
• 示例：

  execution(* com.hytech.user.service.UserOuterService.*(..))UserOuterService接口所定义的任何方法的 execution
  execution(* com.hytech.user.service.*.*(..))：在 service 包中定义的任何方法的 execution:
  execution(* com.hytech.user.service..*.*(..))：在 service 包或其子包中定义的任何方法的 execution。
  

within

类型表达式：within(declaring-type-pattern)

• 类路径匹配(declaring-type-pattern)：不可省略，全限定命名，支持正则
• 示例：

  within(com.hytech.user.service.impl.UserOuterServiceImpl)：过滤UserOuterServiceImpl的方法
  within(com.hytech.user.service.impl.*)：过滤impl包内的所有类的方法
  within(com.hytech.user.service..*)：过滤impl包及其子包内的所有类的方法
  

this

代理对象表达式：this(type)

• 数据类型匹配：当生成的代理对象可以转换为指定的类型时匹配。但需注意基于JDK接口的代理和基于CGLIB的代理生成的代理对象是不一样的。尽量用target，若必须用则指定接口类。

• 示例：

  this(com.hytech.user.service.UserOuterService)：当生成的代理对象可以转换为UserOuterService类型时匹配
  

target

目标对象表达式：target(type)

• 数据类型匹配：当被代理的目标对象可以被转换为指定的类型时则表示匹配。使用实现类匹配。
• 示例：

  target(com.hytech.user.service.impl.UserOuterServiceImpl)：当被代理的目标对象可以被转换为UserOuterServiceImpl类型时匹配
  

args

参数表达式：args()

• 匹配方法参数：当参数格式符合时进行匹配
• 示例：

  args()：匹配任何不带参数的方法。
  args(…)：带任意参数的方法。
  args(java.lang.String)：匹配任何只带一个参数，而且这个参数的类型是String的方法。
  args(java.lang.String,…)：匹配带任意个参数，但是第一个参数的类型是String的方法。
  args(…,java.lang.String)：匹配带任意个参数，但是最后一个参数的类型是String的方法。	
  

@args

注解参数表达式：@args(annotation)

• 匹配参数上有指定注解：匹配任意需要传参的方法，并且所传递的参数的运行时类型具有指定注解
• 示例：

  @args(com.xyz.security.Classified)：匹配任意方法参数类型上拥有Classified注解的方法调用。
  

@target

注解目标对象表达式：@target(annotation)

• 匹配目标对象上有指定注解：匹配当被代理的目标对象对应的类型及其父类型上拥有指定的注解时
• 示例：

  @target(org.springframework.transaction.annotation.Transactional)：匹配任意目标对象有@Transactional注解，即实例类型
  

@within

注解搭理对象表达式：@within(annotation)

• 匹配代理对象对应的类型或其父类型拥有指定的注解的情况
• 示例：

  @within(org.springframework.transaction.annotation.Transactional)：匹配任意代理对象有@Transactional注解，即声明类型
  

@annotation

注解表达式：@annotation()

• 匹配任意方法上拥有指定注解的情况
• 示例：

  @annotation(org.springframework.transaction.annotation.Transactional)：执行的方法有@Transactional注解即会匹配。
  

注意

1. 模糊匹配语法，但结合具体pointCut有不同释义，主要就是匹配对象还是方法

   • .*：任意方法/对象
   • ..*：包下及子包下的任意对象
   • .*.*：包下的任意类的任意方法
   • ..*.*：包下及子包下的任意类的任意方法

2. 可以结合使用，使用 && || ！

3. 类型匹配语法

   • * ：匹配任何数量字符；
   • … ：匹配任何数量字符的重复，如在类型模式中匹配任何数量子包；而在方法参数模式中匹配任何数量参数。
   • + ：匹配指定类型的子类型；仅能作为后缀放在类型模式后边。
   • 示例：

     java.lang.String    匹配String类型； 
     java.\*.String       匹配java包下的任何“一级子包”下的String类型； 如匹配java.lang.String，但不匹配java.lang.ss.String 
     java..\*            匹配java包及任何子包下的任何类型。如匹配java.lang.String、java.lang.annotation.Annotation 
     java.lang.*ing      匹配任何java.lang包下的以ing结尾的类型；
     java.lang.Number+  匹配java.lang包下的任何Number的子类型； 如匹配java.lang.Integer，也匹配java.math.BigInteger 
     

4. aop表达式不是spring独有的，Spring将Spring AOP和IoC与AspectJ无缝集成，所以spring隐式的支持很多AspectJ的语法。例如

   within(@annotation *)不是spring官网的语法，但spring依旧可以识别，它等效为 @within(annotation);而后者才是spring的官方建议写法。
   

   但是最好还是按照spring官方的建议，以免出现异常

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切入点支持的切入点指示符还有： call、get、set、preinitialization、staticinitialization、initialization、handler、adviceexecution、withincode、cflow、cflowbelow、if、@this、@withincode；但Spring AOP目前不支持这些指示符，使用这些指示符将抛出IllegalArgumentException异常。这些指示符Spring AOP可能会在以后进行扩展。

execution

表达式：注解？ 修饰符? 返回值类型 类型声明?方法名(参数列表) 异常列表？

• 注解：可选，方法上持有的注解，如@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。
• 示例

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

within

使用“within(类型表达式)”匹配指定类型内的方法执行

this

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

target

使用“target(类型全限定名)”匹配当前目标对象类型的执行方法；注意是目标对象的类型匹配，这样就不包括引入接口也类型匹配；注意target中使用的表达式必须是类型全限定名，不支持通配符；

args

使用“args(参数类型列表)”匹配当前执行的方法传入的参数为指定类型的执行方法；注意是匹配传入的参数类型，不是匹配方法签名的参数类型；参数类型列表中的参数必须是类型全限定名，通配符不支持；args属于动态切入点，这种切入点开销非常大，非特殊情况最好不要使用；

@within

使用“@within(注解类型)”匹配所以持有指定注解类型内的方法；注解类型也必须是全限定类型名；

@targe

使用“@target(注解类型)”匹配当前目标对象类型的执行方法，其中目标对象持有指定的注解；注解类型也必须是全限定类型名；

@args

使用“@args(注解列表)”匹配当前执行的方法传入的参数持有指定注解的执行；注解类型也必须是全限定类型名；

@annotation

使用“@annotation(注解类型)”匹配当前执行方法持有指定注解的方法；注解类型也必须是全限定类型名；