【小家Spring】Spring AOP中@Pointcut切入点表达式最全面使用介绍(上)

简介: 【小家Spring】Spring AOP中@Pointcut切入点表达式最全面使用介绍(上)

Pointcut表达式类型


标准的AspectJ Aop的pointcut的表达式类型是很丰富的,但是Spring Aop只支持其中的9种,外加Spring Aop自己扩充的一种一共是11(10+1)种类型的表达式,分别如下。


1.execution:一般用于指定方法的执行,用的最多。


2.within:指定某些类型的全部方法执行,也可用来指定一个包。


3.this:Spring Aop是基于动态代理的,生成的bean也是一个代理对象,this就是这个代理对象,当这个对象可以转换为指定的类型时,对应的切入点就是它了,Spring Aop将生效。


4.target:当被代理的对象可以转换为指定的类型时,对应的切入点就是它了,Spring Aop将生效。


5.args:当执行的方法的参数是指定类型时生效。


6.@target:当代理的目标对象上拥有指定的注解时生效。


7.@args:当执行的方法参数类型上拥有指定的注解时生效。


8.@within:与@target类似,看官方文档和网上的说法都是@within只需要目标对象的类或者父类上有指定的注解,则@within会生效,而@target则是必须是目标对象的类上有指定的注解。而根据笔者的测试这两者都是只要目标类或父类上有指定的注解即可。


9.@annotation:当执行的方法上拥有指定的注解时生效。


10.reference pointcut:(经常使用)表示引用其他命名切入点,只有@ApectJ风格支持,Schema风格不支持


11.bean:当调用的方法是指定的bean的方法时生效。(Spring AOP自己扩展支持的)


Pointcut定义时,还可以使用&&、||、! 这三个运算。进行逻辑运算。可以把各种条件组合起来使用


AspectJ切入点支持的切入点指示符还有:call、get、set、preinitialization、staticinitialization、initialization、handler、adviceexecution、withincode、cflow、cflowbelow、if、@this、@withincode;但Spring AOP目前不支持这些指示符,使用这些指示符将抛出IllegalArgumentException异常。这些指示符Spring AOP可能会在以后进行扩展


aspectj支持的所有切点表达式类型如下(但Spring目前只支持如上)


见org.aspectj.weaver.tools.PointcutPrimitive这个枚举类:


// 相当于AspectJ一共提供了24中之多(当然不包含Spring自己的bean的模式)
public final class PointcutPrimitive extends TypeSafeEnum {
  public static final PointcutPrimitive CALL = new PointcutPrimitive("call",1);
  public static final PointcutPrimitive EXECUTION = new PointcutPrimitive("execution",2);
  public static final PointcutPrimitive GET = new PointcutPrimitive("get",3);
  public static final PointcutPrimitive SET = new PointcutPrimitive("set",4);
  public static final PointcutPrimitive INITIALIZATION = new PointcutPrimitive("initialization",5);
  public static final PointcutPrimitive PRE_INITIALIZATION = new PointcutPrimitive("preinitialization",6);
  public static final PointcutPrimitive STATIC_INITIALIZATION = new PointcutPrimitive("staticinitialization",7);
  public static final PointcutPrimitive HANDLER = new PointcutPrimitive("handler",8);
  public static final PointcutPrimitive ADVICE_EXECUTION = new PointcutPrimitive("adviceexecution",9);
  public static final PointcutPrimitive WITHIN = new PointcutPrimitive("within",10);
  public static final PointcutPrimitive WITHIN_CODE = new PointcutPrimitive("withincode",11);
  public static final PointcutPrimitive CFLOW = new PointcutPrimitive("cflow",12);
  public static final PointcutPrimitive CFLOW_BELOW = new PointcutPrimitive("cflowbelow",13);
  public static final PointcutPrimitive IF = new PointcutPrimitive("if",14);
  public static final PointcutPrimitive THIS = new PointcutPrimitive("this",15);
  public static final PointcutPrimitive TARGET = new PointcutPrimitive("target",16);
  public static final PointcutPrimitive ARGS = new PointcutPrimitive("args",17);
  public static final PointcutPrimitive REFERENCE = new PointcutPrimitive("reference pointcut",18);
  public static final PointcutPrimitive AT_ANNOTATION = new PointcutPrimitive("@annotation",19);
  public static final PointcutPrimitive AT_THIS = new PointcutPrimitive("@this",20);
  public static final PointcutPrimitive AT_TARGET = new PointcutPrimitive("@target",21);
  public static final PointcutPrimitive AT_ARGS = new PointcutPrimitive("@args",22);
  public static final PointcutPrimitive AT_WITHIN = new PointcutPrimitive("@within",23);
  public static final PointcutPrimitive AT_WITHINCODE = new PointcutPrimitive("@withincode",24);
  private PointcutPrimitive(String name, int key) {
    super(name, key);
  }
}


使用示例

execution:

execution是使用的最多的一种Pointcut表达式,表示某个方法的执行,其标准语法如下。


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


   修饰符匹配(modifier-pattern?)


   返回值匹配(ret-type-pattern)可以为*表示任何返回值,全路径的类名等


   类路径匹配(declaring-type-pattern?)


   方法名匹配(name-pattern)可以指定方法名 或者 代表所有, set 代表以set开头的所有方法


   参数匹配((param-pattern))可以指定具体的参数类型,多个参数间用“,”隔开,各个参数也可以用“”来表示匹配任意类型的参数,如(String)表示匹配一个String参数的方法;(,String) 表示匹配有两个参数的方法,第一个参数可以是任意类型,而第二个参数是String类型;可以用(…)表示零个或多个任意参数


   异常类型匹配(throws-pattern?)


   其中后面跟着“?”的是可选项


下面看几个例子:

//表示匹配所有方法  
1)execution(* *(..))  
//表示匹配com.fsx.run.UserService中所有的公有方法  
2)execution(public * com.fsx.run.UserService.*(..))  
//表示匹配com.fsx.run包及其子包下的所有方法
3)execution(* com.fsx.run..*.*(..))  


Pointcut定义时,还可以使用&&、||、! 这三个运算。进行逻辑运算


// 签名:消息发送切面
@Pointcut("execution(* com.fsx.run.MessageSender.*(..))")
private void logSender(){}
// 签名:消息接收切面
@Pointcut("execution(* com.fsx.run.MessageReceiver.*(..))")
private void logReceiver(){}
// 只有满足发送  或者  接收  这个切面都会切进去
@Pointcut("logSender() || logReceiver()")
private void logMessage(){}

这个例子中,logMessage()将匹配任何MessageSender和MessageReceiver中的任何方法。


当我们的切面很多的时候,我们可以把所有的切面放到单独的一个类去,进行统一管理,比如下面:

//集中管理所有的切入点表达式
public class Pointcuts {
@Pointcut("execution(* *Message(..))")
public void logMessage(){}
@Pointcut("execution(* *Attachment(..))")
public void logAttachment(){}
@Pointcut("execution(* *Service.*(..))")
public void auth(){}
}

这样别的使用时,采用全类名+方法名的方式


@Before("com.fsx.run.Pointcuts.logMessage()")
public void before(JoinPoint joinPoint) {
  System.out.println("Logging before " +     joinPoint.getSignature().getName());
}


within:


within是用来指定类型的,指定类型中的所有方法将被拦截。

// AService下面所有外部调用方法,都会拦截。备注:只能是AService的方法,子类不会拦截的
@Pointcut("within(com.fsx.run.service.AService)")
public void pointCut() {
}

所以此处需要注意:上面写的是AService接口,是达不到拦截效果的,只能写实现类:


    //此处只能写实现类
    @Pointcut("within(com.fsx.run.service.impl.AServiceImpl)")
    public void pointCut() {
    }

匹配包以及子包内的所有类:

    @Pointcut("within(com.fsx.run.service..*)")
    public void pointCut() {
    }






相关文章
|
8月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
767 0
|
7月前
|
XML Java 数据格式
《深入理解Spring》:AOP面向切面编程深度解析
Spring AOP通过代理模式实现面向切面编程,将日志、事务等横切关注点与业务逻辑分离。支持注解、XML和编程式配置,提供五种通知类型及丰富切点表达式,助力构建高内聚、低耦合的可维护系统。
|
安全 Java Spring
Spring之Aop的底层原理
Spring之Aop的底层原理
|
Java Spring 容器
【Spring AOP底层实现原理】
【Spring AOP底层实现原理】
582 0
|
设计模式 Java uml
Spring AOP 原理
Spring AOP 原理
211 0
Spring5入门到实战------9、AOP基本概念、底层原理、JDK动态代理实现
这篇文章是Spring5框架的实战教程,深入讲解了AOP的基本概念、如何利用动态代理实现AOP,特别是通过JDK动态代理机制在不修改源代码的情况下为业务逻辑添加新功能,降低代码耦合度,并通过具体代码示例演示了JDK动态代理的实现过程。
Spring5入门到实战------9、AOP基本概念、底层原理、JDK动态代理实现
|
Java 开发者 Spring
Spring AOP 底层原理技术分享
Spring AOP(面向切面编程)是Spring框架中一个强大的功能,它允许开发者在不修改业务逻辑代码的情况下,增加额外的功能,如日志记录、事务管理等。本文将深入探讨Spring AOP的底层原理,包括其核心概念、实现方式以及如何与Spring框架协同工作。
|
Java Spring 容器
Spring IOC、AOP与事务管理底层原理及源码解析
【10月更文挑战第1天】Spring框架以其强大的控制反转(IOC)和面向切面编程(AOP)功能,成为Java企业级开发中的首选框架。本文将深入探讨Spring IOC和AOP的底层原理,并通过源码解析来揭示其实现机制。同时,我们还将探讨Spring事务管理的核心原理,并给出相应的源码示例。
557 9
|
XML Java 数据格式
Spring5系列学习文章分享---第三篇(AOP概念+原理+动态代理+术语+Aspect+操作案例(注解与配置方式))
Spring5系列学习文章分享---第三篇(AOP概念+原理+动态代理+术语+Aspect+操作案例(注解与配置方式))
220 0