【小家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() {
    }






相关文章
|
运维 Java 程序员
Spring5深入浅出篇:Spring切入点详解
该文档是关于Spring框架中切入点的详细解释。切入点是AOP(面向切面编程)的核心概念,用于定义通知(如日志、事务管理)应该附加到代码的哪些位置。文档主要介绍了切入点表达式的不同类型: 1. 方法切入点表达式:使用`execution()`定义匹配的方法,星号`*`代表任意返回值和方法名,`(..)`表示任意参数。 2. 类切入点:指定特定类以应用额外功能,可以精确到类中的所有方法,或者只包含特定包的类。 3. 包切入点表达式:适用于整个包或包及其子包内的所有类和方法。
|
4月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
549 0
|
11月前
|
XML Java 测试技术
Spring AOP—通知类型 和 切入点表达式 万字详解(通俗易懂)
Spring 第五节 AOP——切入点表达式 万字详解!
844 25
|
监控 Java Spring
AOP切入同类调用方法不起作用,AopContext.currentProxy()帮你解决这个坑
AOP切入同类调用方法不起作用,AopContext.currentProxy()帮你解决这个坑
1538 1
|
Java 开发者 Spring
Spring AOP的切点是通过使用AspectJ的切点表达式语言来定义的。
【5月更文挑战第1天】Spring AOP的切点是通过使用AspectJ的切点表达式语言来定义的。
196 5
|
Java Spring
切面编程的锋芒:Spring切入点的玩法与技巧
切面编程的锋芒:Spring切入点的玩法与技巧
195 0
切面编程的锋芒:Spring切入点的玩法与技巧
|
XML Java 数据格式
spring AOP切入点execution表达式
spring AOP切入点execution表达式
243 1
|
6月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
1096 0
|
7月前
|
人工智能 Java 测试技术
Spring Boot 集成 JUnit 单元测试
本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧,包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块(如JSON、MVC、WebFlux、JDBC等),以及@MockBean和@SpyBean的应用。内容实用,适合Java开发者参考学习。
835 0
|
3月前
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
401 3