@Pointcut语法详解

@Pointcut语法详解

 

目录

@Pointcut语法详解

定义

表达式标签

execution

execution格式:

例子:

AspectJ类型匹配的通配符:

within和@within

this

@target

@annotation

args 和 @args

命名及匿名切入点

切入点使用示例:

通知参数

AOP例子


定义

格式:@ 注解(value=“表达标签 ( 表达式格式)”)
如:@Pointcut (value=“execution(* com.cn.spring.aspectj.NotVeryUsefulAspectService.*(…))”)

表达式标签

  • execution():用于匹配方法执行的连接点
  • args(): 用于匹配当前执行的方法传入的参数为指定类型的执行方法
  • this(): 用于匹配当前AOP代理对象类型的执行方法;注意是AOP代理对象的类型匹配,这样就可能包括引入接口也类型匹配;
  • target(): 用于匹配当前目标对象类型的执行方法;注意是目标对象的类型匹配,这样就不包括引入接口也类型匹配;
  • within(): 用于匹配指定类型内的方法执行;
  • @args():于匹配当前执行的方法传入的参数持有指定注解的执行;
  • @target():用于匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;
  • @within():用于匹配所以持有指定注解类型内的方法;
  • @annotation:用于匹配当前执行方法持有指定注解的方法;

其中execution 是用的最多的,

execution

execution格式:

execution(

modifier-pattern?
ret-type-pattern
declaring-type-pattern?
name-pattern(param-pattern)
throws-pattern?

)

execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern)throws-pattern?)

其中带 ?号的 modifiers-pattern?,declaring-type-pattern?,hrows-pattern?是可选项
ret-type-pattern,name-pattern, parameters-pattern是必选项;

  • modifier-pattern? 修饰符匹配,如public 表示匹配公有方法
  • ret-type-pattern 返回值匹配,* 表示任何返回值,全路径的类名等
  • declaring-type-pattern? 类路径匹配
  • name-pattern 方法名匹配,* 代表所有,set*,代表以set开头的所有方法
  • (param-pattern) 参数匹配,指定方法参数(声明的类型),

         (..)代表所有参数,

         ()代表一个参数,

         (,String)代表第一个参数为任何值,第二个为String类型.

  • throws-pattern? 异常类型匹配

例子:

  • execution(public * *(..)) 定义任意公共方法的执行
  • execution(* set*(..)) 定义任何一个以"set"开始的方法的执行
  • execution(* com.xyz.service.AccountService.*(..)) 定义AccountService 接口的任意方法的执行
  • execution(* com.xyz.service.*.*(..)) 定义在service包里的任意方法的执行
  • execution(* com.xyz.service ..*.*(..)) 定义在service包和所有子包里的任意类的任意方法的执行
  • execution(* com.test.spring.aop.pointcutexp…JoinPointObjP2.*(…)) 定义在pointcutexp包和所有子包里的JoinPointObjP2类的任意方法的执行:

说明:最靠近(..)的为方法名,靠近.∗(..))的为类名或者接口名,如上例的JoinPointObjP2.∗(..))

AspectJ类型匹配的通配符:

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

如:

  • 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

within和@within

  • within(com.test.spring.aop.pointcutexp.*) pointcutexp包里的任意类.
  • within(com.test.spring.aop.pointcutexp…*) pointcutexp包和所有子包里的任意类.
  • @within(org.springframework.transaction.annotation.Transactional) 带有@Transactional标注的所有类的任意方法.

this

  • this(com.test.spring.aop.pointcutexp.Intf) 实现了Intf接口的所有类,如果Intf不是接口,限定Intf单个类.

当一个实现了接口的类被AOP的时候,用getBean方法必须cast为接口类型,不能为该类的类型.

@target

  • @target(org.springframework.transaction.annotation.Transactional) 带有@Transactional标注的所有类的任意方法.

@annotation

  • @annotation(org.springframework.transaction.annotation.Transactional) 带有@Transactional标注的任意方法.

@within和@target针对类的注解,@annotation是针对方法的注解

args 和 @args

  • @args(org.springframework.transaction.annotation.Transactional) 参数带有@Transactional标注的方法.
  • args(String) 参数为String类型(运行是决定)的方法.

命名及匿名切入点

Pointcut定义时,还可以使用&&、∣∣、!运算符

@Pointcut("execution(* com.savage.aop.MessageSender.*(..)) && args(param)")
public void log(){
}

@Before("log(String param)") 
public void beforeLog(){
     //todo something....
}

//等同于
@Before("execution(* com.savage.aop.MessageSender.*(..)) && args(param)") 
public void beforeLog(){
     //todo something....
}

又如:

@Pointcut("execution(* com.savage.aop.MessageSender.*(..))")
private void logSender(){}

@Pointcut("execution(* com.savage.aop.MessageReceiver.*(..))")
private void logReceiver(){}

@Pointcut("logSender() || logReceiver()")
private void logMessage(){} 

这个例子中,logMessage()将匹配任何MessageSenderMessageReceiver中的任何方法

切入点使用示例:

  • 一、execution:使用“execution(方法表达式)”匹配方法执行;
示例描述
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.Deprecatedcn.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 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(类型表达式)”匹配指定类型内的方法执行;
示例 描述
within(cn.javass..*)    cn.javass包及子包下的任何方法执行
within(cn.javass..IPointcutService+)  cn.javass包或所有子包下IPointcutService类型及子类型的任何方法
within(@cn.javass..Secure *) 持有cn.javass…Secure注解的任何类型的任何方法必须是在目标对象上声明这个注解,在接口上声明的对它不起作用
  • 三、this:使用“this(类型全限定名)”匹配当前AOP代理对象类型的执行方法;注意是AOP代理对象的类型匹配,这样就可能包括引入接口方法也可以匹配;注意this中使用的表达式必须是类型全限定名,不支持通配符;
示例    描述

this(cn.javass.spring.chapter6.service.

IPointcutService) 

当前AOP对象实现了 IPointcutService接口的任何方法

this(cn.javass.spring.chapter6.service.

IIntroductionService) 

当前AOP对象实现了 IIntroductionService接口的任何方法
  • 四、target:使用“target(类型全限定名)”匹配当前目标对象类型的执行方法;注意是目标对象的类型匹配,这样就不包括引入接口也类型匹配;注意target中使用的表达式必须是类型全限定名,不支持通配符;
示例    描述

target(cn.javass.spring.chapter6.

service.IPointcutService)    

当前目标对象(非AOP对象)实现了 IPointcutService接口的任何方法

target(cn.javass.spring.

chapter6.service.IIntroductionService) 

当前目标对象(非AOP对象) 实现了IIntroductionService 接口的任何方法, 不可能是引入接口
  • 五、args:使用“args(参数类型列表)”匹配当前执行的方法传入的参数为指定类型的执行方法;注意是匹配传入的参数类型,不是匹配方法签名的参数类型;参数类型列表中的参数必须是类型全限定名,通配符不支持;args属于动态切入点,这种切入点开销非常大,非特殊情况最好不要使用;
示例    描述
args (java.io.Serializable,…) 任何一个以接受“传入参数类型为 java.io.Serializable” 开头,且其后可跟任意个任意类型的参数的方法执行,args指定的参数类型是在运行时动态匹配的
  
  • 六、@within:使用“@within(注解类型)”匹配所以持有指定注解类型内的方法;注解类型也必须是全限定类型名;
示例    描述
@within(cn.javass.spring.chapter6.Secure)  任何目标对象对应的类型持有Secure注解的类方法;
  • 七、@target:使用“@target(注解类型)”匹配当前目标对象类型的执行方法,其中目标对象持有指定的注解;注解类型也必须是全限定类型名;
示例    描述
@target (cn.javass.spring.chapter6.Secure) 任何目标对象持有Secure注解的类方法;必须是在目标对象上声明这个注解,在接口上声明的对它不起作用
  • 八、@args:使用“@args(注解列表)”匹配当前执行的方法传入的参数持有指定注解的执行;注解类型也必须是全限定类型名;
示例    描述
@args (cn.javass.spring.chapter6.Secure) 任何一个只接受一个参数的方法,且方法运行时传入的参数持有注解 cn.javass.spring.chapter6.Secure;动态切入点,类似于arg指示符;
  • 九、@annotation:使用“@annotation(注解类型)”匹配当前执行方法持有指定注解的方法;注解类型也必须是全限定类型名;
示例    描述

@annotation(cn.javass.spring.

chapter6.Secure )

当前执行方法上持有注解 cn.javass.spring.chapter6.Secure将被匹配
  • 十、bean:使用“bean(Bean id或名字通配符)”匹配特定名称的Bean对象的执行方法;Spring ASP扩展的,在AspectJ中无相应概念;
示例    描述
bean(*Service) 匹配所有以Service命名(id或name)结尾的Bean
  • 十一、reference pointcut:表示引用其他命名切入点;
@Pointcut(value="bean(*Service)")
private void pointcut1(){
}

@Pointcut(value="@args()cn.javass.spring.chaper6.Source")
public referencePointcutTest(JoinPoint jp){
     ...
}

通知参数

  • 1)JoinPoint:提供访问当前被通知方法的目标对象、代理对象、方法参数等数据
  • 2)ProceedingJoinPoint:用于环绕通知,使用proceed()方法来执行目标方法
  • 3)JoinPoint.StaticPart:提供访问连接点的静态部分,如被通知方法签名、连接点类型等:

使用如下方式在通知方法上声明,必须是在第一个参数,然后使用jp.getArgs()就能获取到被通知方法参数

@Before(value="execution(* sayBefore(*))")  
public void before(JoinPoint jp) {}  
  
@Before(value="execution(* sayBefore(*))")  
public void before(JoinPoint.StaticPart jp) {}  

自动获取:通过切入点表达式可以将相应的参数自动传递给通知方法,例如前边章节讲过的返回值和异常是如何传递给通知方法的。
Spring AOP中,除了executionbean指示符不能传递参数给通知方法,其他指示符都可以将匹配的相应参数或对象自动传递给通知方法。

@Before(value="execution(* test(*)) && args(param)", argNames="param")  
public void before1(String param) {  
    System.out.println("===param:" + param);  
}  

 切入点表达式execution(* test()) && args(param)
1)首先execution( test(*))匹配任何方法名为test,且有一个任何类型的参数;
2)args(param)将首先查找通知方法上同名的参数,并在方法执行时(运行时)匹配传入的参数是使用该同名参数类型,即java.lang.String;如果匹配将把该被通知参数传递给通知方法上同名参数。
其他指示符(除了executionbean指示符)都可以使用这种方式进行参数绑定。
在此有一个问题,即前边提到的类似于【3.1.2构造器注入】中的参数名注入限制:在class文件中没生成变量调试信息是获取不到方法参数名字的。
所以我们可以使用策略来确定参数名:
如果我们通过“argNames”属性指定了参数名,那么就是要我们指定的;

@Before(value=" args(param)", argNames="param") //明确指定了  
public void before1(String param) {  
    System.out.println("===param:" + param);  
}  

如果第一个参数类型是JoinPoint、ProceedingJoinPoint或JoinPoint.StaticPart类型,应该从“argNames”属性省略掉该参数名(可选,写上也对),这些类型对象会自动传入的,但必须作为第一个参数;

@Before(value=" args(param)", argNames="param") //明确指定了  
public void before1(JoinPoint jp, String param) {  
    System.out.println("===param:" + param);  
}  

如果“class文件中含有变量调试信息”将使用这些方法签名中的参数名来确定参数名;

@Before(value=" args(param)") //不需要argNames了  
public void before1(JoinPoint jp, String param) {  
    System.out.println("===param:" + param);  
}  

如果没有“class文件中含有变量调试信息”,将尝试自己的参数匹配算法,如果发现参数绑定有二义性将抛出AmbiguousBindingException异常;对于只有一个绑定变量的切入点表达式,而通知方法只接受一个参数,说明绑定参数是明确的,从而能配对成功。

@Before(value=" args(param)")   
public void before1(JoinPoint jp, String param) {  
    System.out.println("===param:" + param);  
}  

以上策略失败将抛出IllegalArgumentException
接下来让我们示例一下组合情况吧:

@Before(args(param) && target(bean) && @annotation(secure)",   
        argNames="jp,param,bean,secure")  
public void before5(JoinPoint jp, String param,  
 IPointcutService pointcutService, Secure secure) {  
……  
}  

也可以对使用命名切入点自动获取参数:

@Pointcut(value="args(param)", argNames="param")  
private void pointcut1(String param){}  
@Pointcut(value="@annotation(secure)", argNames="secure")  
private void pointcut2(Secure secure){}  
      
@Before(value = "pointcut1(param) && pointcut2(secure)", argNames="param, secure")  
public void before6(JoinPoint jp, String param, Secure secure) {  
……  
}  

AOP例子

@Aspect
@Component
public class NotVeryUsefulAspect {
    @AfterReturning(value="execution(* com.cn.spring.aspectj.NotVeryUsefulAspectService.*(..))")
    private void logReceiver(){
        System.out.println("切入点logReceiver...");
    }

    @Pointcut(value="execution(* com.cn.spring.aspectj.NotVeryUsefulAspectService.*(..)) && args(param)")
    private void pointcut(String param){ 
        System.out.println("切入点pointcut()"+param);
    }

    //方法体将不执行
    @Pointcut("within(com.cn.spring.aspectj.*)")
    public String inWebLayer() {
        System.out.println("切入点inWebLayer()");
        return "返回值加载";
    }

    @Before(value="inWebLayer()")
        private void beforeinWebLayer(){ 
        System.out.println("beforeinWebLayer~~");
    }

    @Before(value="pointcut(param)")
        private void beforePointcut(String param){ 
        System.out.println("beforePointcut:"+param);
    }


    @AfterReturning(pointcut="inWebLayer()",returning="retVal")
        public void doAccessCheck(Object retVal) {
        System.out.println("doAccessCheck:"+retVal);
    }

    @Around(value="execution(* com.cn.spring.aspectj.NotVeryUsefulAspectService.*(..))")
    private Object aroundLayer(ProceedingJoinPoint pjp) throws Throwable{ 
        // start stopwatch
        Object retVal = pjp.proceed();
        // stop stopwatch
        System.out.println("aroundLayer~~");
        return retVal;
    }
}

参考自:
https://www.mekau.com/4880.html
https://blog.csdn.net/xiaoyiaoyou/article/details/45972363

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值