Spring AOP通知(Advice)详解

简介: Spring 的 AOP 功能中一个关键概念是通知(Advice),与切点(Pointcut)表达式相关联在特定节点织入一些逻辑,Spring 提供了五种类型的通知。


一、概述



AOP 中的通知是基于连接点(Join point)业务逻辑的一种增强,Spring AOP 提供了下面五种通知类型:

  • Before advice(前置通知):连接点前面执行,不能终止后续流程,除非抛异常
  • After returning advice(后置通知):连接点正常返回时执行,有异常不执行
  • Around advice(环绕通知):围绕连接点前后执行,也能捕获异常处理
  • After advice(最终通知):连接点退出时执行,无论是正常退出还是异常退出
  • After throwing advice(异常通知):连接点方法抛出异常时执行

AOP 的连接点一般是指目标类的方法,五种通知类型执行的节点如下:


微信图片33.png


二、通知的定义



Spring AOP 可以基于 XML 方式和基于注解方式定义,只是写法不同,这里只使用注解的方式来讲解通知的详细用法。


1. 前置通知


@Aspect 切面类中使用 @Before 注解简单地定义一个前置通知。


@Aspect
@Component
public class DemoAspect {
    @Before("execution(* cn.codeartist.spring.aop.advice.*.*(..))")
    public void doBefore() {
        // 自定义逻辑
    }
}


2. 后置通知


方法正常返回,会执行后置通知,使用 @AfterReturning 注解定义后置通知。


@AfterReturning("execution(* cn.codeartist.spring.aop.advice.*.*(..))")
public void doAfterReturning() {
    // 自定义逻辑
}

注解的 returning 属性可以绑定目标方法返回值,用于在通知中获取目标方法执行完成后的返回结果。

@AfterReturning(pointcut = "pointcut()", returning = "retVal")
public void doAfterReturning(Object retVal) {
    // 自定义逻辑(通过参数绑定方法切入点方法的返回值)
}

当注解使用了 returning 属性时,切入点会增加返回值类型的限制,上面使用的 Object 类型可以匹配到所有返回值类型的目标方法。

例如下面的情况,后置通知的代码不会被执行:

// 目标方法
public String doService() {
    return "码匠公众号";
}
// 后置通知定义
@AfterReturning(pointcut = "pointcut()", returning = "retVal")
public void doAfterReturning(Integer retVal) {
    // 目标方法返回值是String类型,结果参数绑定类型是Integer,该通知不会被执行
}


3. 环绕通知


环绕通知可以在方法执行的任何节点添加逻辑,它可以实现另外 4 种通知的功能。

如果需要以线程安全的方式在方法执行前后共享状态,可以使用环绕通知。

@Around 注解来定义环绕通知,需要使用 ProceedingJoinPoint 作为参数,来执行目标方法调用。

@Around("execution(* cn.codeartist.spring.aop.advice.*.*(..))")
public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
    // 方法执行前逻辑
    Object retVal = joinPoint.proceed();
    // 方法执行后逻辑
    return retVal;
}

joinPoint.proceed() 会调用目标方法,或者是调用另一个切面。

虽然环绕通知可以实现另外几种通知的功能,但在使用中都能实现功能的情况下,优先使用其他通知方式。


4. 最终通知


最终通知在方法退出的时候执行,使用 @After 注解定义,最终通知在方法正常退出和抛出异常时都会执行,通常用于资源的释放。

@After("execution(* cn.codeartist.spring.aop.advice.*.*(..))")
public void doAfter() {
    // 自定义逻辑
}


5. 异常通知


方法抛出异常的时候会执行异常通知,使用 @AfterThrowing 定义异常通知。

@AfterThrowing("execution(* cn.codeartist.spring.aop.advice.*.*(..))")
public void doAfterThrowing() {
    // 自定义逻辑
}

注解的 throwing 属性用来绑定目标方法抛出的异常,用于在通知中获取目标方法抛出的异常实例。

@AfterThrowing(pointcut = "pointcut()", throwing = "ex")
public void doAfterThrowing(Throwable ex) {
    // 自定义逻辑(通过参数绑定方法切入点方法抛出的异常)
}

当注解使用了 throwing 属性时,切入点会增加异常类型的限制,上面使用的 Throwable 类型可以匹配到所有异常类型。

例如下面的情况,异常通知的代码不会被执行:

// 目标方法
public void doServiceThrow() {
    throw new RuntimeException("Test exception");
}
// 异常通知定义
@AfterThrowing(pointcut = "pointcut()", throwing = "ex")
public void doAfterThrowing(NullPointerException ex) {
    // 目标方法抛出的是RuntimeException,参数绑定类型是NullPointerException,该通知不会被执行
}


三、通知的参数



在定义通知的方法签名上可以指定参数来绑定目标方法的一些信息(例如前面讲到的后置通知和异常通知)。


1. 切入点


在定义通知方法的时候,一般可以使用 JoinPoint 作为参数,环绕通知使用 ProceedingJoinPoint。常用接口方法如下:


JoinPoint

public interface JoinPoint {
  // 获取代理对象
    Object getThis();
    // 获取目标对象
    Object getTarget();
    // 获取连接点方法的参数
    Object[] getArgs();
    // 获取连接点方法的签名
    Signature getSignature();
}


ProceedingJoinPoint

public interface ProceedingJoinPoint extends JoinPoint {
    // 执行下一个切面的通知或者目标方法
    public Object proceed() throws Throwable;
    // 执行下一个切面的通知或者目标方法(带参数)
    public Object proceed(Object[] args) throws Throwable;
}

切面的切入点一般为方法,所以 Signature 可以转换为 MethodSignature 使用。


2. 通知的参数传递


通知的参数可以通过切点表达式 args 来指定,具体用法会在后面切点表达式详解中讲到。

@Before("pointcut() && args(name,..)")
public void doBefore(String name) {
    // 切点表达式增加参数匹配
}

args(name,..) 也会增加切入点的限制,目标方法的参数个数至少为一个,且第一个参数类型为 String


四、通知的顺序



Spring AOP 中一个目标类可以被多个切面切入,多个切面也可以切入一个目标类。

使用 @Order 注解来指定切面的优先级,来控制切面的执行顺序。

在注册切面 Bean 的时候指定 @Order,如下:

@Order(1)
@Aspect
@Component
public class FirstAspect {
    // ......
}

优先级高的切面先执行,通知执行的顺序如下:


微信图片22.png

可以得出:

  • 优先级高的切面,前置通知先执行
  • 优先级低的切面,后置通知先执行

Order 值越小,优先级越大。

Spring AOP 是基于动态代理的拦截器模式实现的,切面模型与拦截器模型相似,如下:

微信图片11.png

五、附录



1. 常用注解


注解 描述
@Aspect 定义切面类
@Before 定义前置通知
@AfterReturning 定义后置通知
@Around 定义环绕通知
@After 定义最终通知
@AfterThrowing 定义异常通知


2. 示例代码


Gitee 仓库:

https://gitee.com/code_artist/spring




目录
相关文章
|
1月前
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
339 0
|
12天前
|
XML Java 数据格式
《深入理解Spring》:AOP面向切面编程深度解析
Spring AOP通过代理模式实现面向切面编程,将日志、事务等横切关注点与业务逻辑分离。支持注解、XML和编程式配置,提供五种通知类型及丰富切点表达式,助力构建高内聚、低耦合的可维护系统。
|
5月前
|
监控 安全 Java
Spring AOP实现原理
本内容主要介绍了Spring AOP的核心概念、实现机制及代理生成流程。涵盖切面(Aspect)、连接点(Join Point)、通知(Advice)、切点(Pointcut)等关键概念,解析了JDK动态代理与CGLIB代理的原理及对比,并深入探讨了通知执行链路和责任链模式的应用。同时,详细分析了AspectJ注解驱动的AOP解析过程,包括切面识别、切点表达式匹配及通知适配为Advice的机制,帮助理解Spring AOP的工作原理与实现细节。
|
2月前
|
人工智能 监控 安全
Spring AOP切面编程颠覆传统!3大核心注解+5种通知类型,让业务代码纯净如初
本文介绍了AOP(面向切面编程)的基本概念、优势及其在Spring Boot中的使用。AOP作为OOP的补充,通过将横切关注点(如日志、安全、事务等)与业务逻辑分离,实现代码解耦,提升模块化程度、可维护性和灵活性。文章详细讲解了Spring AOP的核心概念,包括切面、切点、通知等,并提供了在Spring Boot中实现AOP的具体步骤和代码示例。此外,还列举了AOP在日志记录、性能监控、事务管理和安全控制等场景中的实际应用。通过本文,开发者可以快速掌握AOP编程思想及其实践技巧。
|
2月前
|
人工智能 监控 安全
如何快速上手【Spring AOP】?核心应用实战(上篇)
哈喽大家好吖~欢迎来到Spring AOP系列教程的上篇 - 应用篇。在本篇,我们将专注于Spring AOP的实际应用,通过具体的代码示例和场景分析,帮助大家掌握AOP的使用方法和技巧。而在后续的下篇中,我们将深入探讨Spring AOP的实现原理和底层机制。 AOP(Aspect-Oriented Programming,面向切面编程)是Spring框架中的核心特性之一,它能够帮助我们解决横切关注点(如日志记录、性能统计、安全控制、事务管理等)的问题,提高代码的模块化程度和复用性。
|
2月前
|
设计模式 Java 开发者
如何快速上手【Spring AOP】?从动态代理到源码剖析(下篇)
Spring AOP的实现本质上依赖于代理模式这一经典设计模式。代理模式通过引入代理对象作为目标对象的中间层,实现了对目标对象访问的控制与增强,其核心价值在于解耦核心业务逻辑与横切关注点。在框架设计中,这种模式广泛用于实现功能扩展(如远程调用、延迟加载)、行为拦截(如权限校验、异常处理)等场景,为系统提供了更高的灵活性和可维护性。
|
9月前
|
XML Java 开发者
Spring Boot中的AOP实现
Spring AOP(面向切面编程)允许开发者在不修改原有业务逻辑的情况下增强功能,基于代理模式拦截和增强方法调用。Spring Boot通过集成Spring AOP和AspectJ简化了AOP的使用,只需添加依赖并定义切面类。关键概念包括切面、通知和切点。切面类使用`@Aspect`和`@Component`注解标注,通知定义切面行为,切点定义应用位置。Spring Boot自动检测并创建代理对象,支持JDK动态代理和CGLIB代理。通过源码分析可深入了解其实现细节,优化应用功能。
479 6
|
8月前
|
XML Java 测试技术
Spring AOP—通知类型 和 切入点表达式 万字详解(通俗易懂)
Spring 第五节 AOP——切入点表达式 万字详解!
431 25
|
8月前
|
XML 安全 Java
Spring AOP—深入动态代理 万字详解(通俗易懂)
Spring 第四节 AOP——动态代理 万字详解!
352 24
|
7月前
|
Java API 微服务
微服务——SpringBoot使用归纳——Spring Boot中的切面AOP处理——Spring Boot 中的 AOP 处理
本文详细讲解了Spring Boot中的AOP(面向切面编程)处理方法。首先介绍如何引入AOP依赖,通过添加`spring-boot-starter-aop`实现。接着阐述了如何定义和实现AOP切面,包括常用注解如`@Aspect`、`@Pointcut`、`@Before`、`@After`、`@AfterReturning`和`@AfterThrowing`的使用场景与示例代码。通过这些注解,可以分别在方法执行前、后、返回时或抛出异常时插入自定义逻辑,从而实现功能增强或日志记录等操作。最后总结了AOP在实际项目中的重要作用,并提供了课程源码下载链接供进一步学习。
855 0

热门文章

最新文章