SpringBoot AOP

本文介绍了SpringBoot中如何使用AOP进行面向切面编程,包括相关概念如连接点、切入点、通知、切面和目标对象。通过具体的代码示例展示了如何配置AOP,包括前置、后置、异常、返回和环绕通知的使用,以及如何在Controller中调用UserService实现动态增强。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

面向切面编程(Aspect-Oriented Programming,AOP)。在系统运行时动态添加代码的方式称为面向切面编程(AOP)。

相关概念
  • Joinpoint (连接点):类里面可以被增强的方法即为连接点。例如,想修改哪个方法的功能, 那么该方法就是一个连接点。
  • Pointcut(切入点):对 Joinpoint 进行拦截的定义即为切入点,例如,拦截所有以 insert 开始的方法,这个定义即为切入点。
  • Advice (通知):拦截到 Joinpoint 之后所要做的事情就是通知。例如, 打印日志监控。 通知分为前置通知、后置通知、异常通知、最终通知和环绕通知。
  • Aspect (切面): Pointcut 和 Advice 的结合。
  • Target(目标对象):要增强的类称为 Target。
Spring Boot 项目中使用 AOP

SpringBoot 在 Spring 的基础上对 AOP 的配置提供了自动化配置解决方案 spring-boot-starter-aop。配置步骤如下。:

  1. 首先在 Spring Boot Web 项目中引入 spring-boot-starter-aop 依赖,代码如下:
<!-- spring aop -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
  1. 创建 UserService 类,代码如下:
import org.springframework.stereotype.Service;

@Service
public class UserService {

    public String getUserById(Integer id) {
        System.out.println("get...");
        return "user";
    }

    public void deleteUserById(Integer id) {
        System.out.println("delete...");
    }
}
  1. 创建切面,代码如下:
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class LogAspect {

    @Pointcut("execution(* xyz.ther.boot.service.*.*(..))")
    public void pc1() {
    }

    @Before(value = "pc1()")
    public void before(JoinPoint joinPoint) {
        String name = joinPoint.getSignature().getName();
        System.out.println(name + "方法执行开始...");
    }

    @After(value = "pc1()")
    public void after(JoinPoint joinPoint) {
        String name = joinPoint.getSignature().getName();
        System.out.println(name + "方法执行结束...");
    }

    @AfterReturning(value = "pc1()", returning = "result")
    public void afterReturning(JoinPoint joinPoint, Object result) {
        String name = joinPoint.getSignature().getName();
        System.out.println(name + "方法返回值为:" + result);
    }

    @AfterThrowing(value = "pc1()", throwing = "e")
    public void afterThrowing(JoinPoint joinPoint, Exception e) {
        String name = joinPoint.getSignature().getName();
        System.out.println(name + "方法抛出异常,异常为:" + e);
    }

    @Around("pc1()")
    public Object around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        return proceedingJoinPoint.proceed();
    }
}
  • @Aspect 注解表明这是一个切面类。

  • pc1 方法使用了 @Pointcut 注解,这是一个切入点定义。 execution 中的第一个 * 表示方法返回任意值,第二个 * 表示 service 包下的任意类,第三个 * 表示类中的任意方法,括号中的两个点表示方法参数任意,即这里描述的切入点为 service 包下所有类中的所有方法。

  • 方法使用 @Before 注解表示这是一个前置通知,该方法在目标方法执行之前执行。通过 JoinPoint 参数可以获取目标方法的方法名、修饰符等信息。

  • 方法使用 @After 注解表示这是一个后置通知,该方法在目标方法执行之后执行。

  • 方法使用 @AfterReturning 注解表示这是一个返回通知,在该方法中可以获取目标方法的返回值。@AfterReturning 注解的 returning 参数是指返回值的变量名,对应方法的参数。注意,在方法参数中定义了 result 的类型为 Object,表示目标方法的返回值可以是任意类型,若 result 参数的类型为 Long,则该方法只能处理目标方法返回值为 Long 的情况。

  • 方法使用 @AfterThrowing 注解表示这是一个异常通知,即当目标方法发生异常时,该方法会被调用,异常类型为 Exception 表示所有的异常都会进入该方法中执行,若异常类型为 ArithmeticException,则表示只有目标方法抛出的 ArithmeticException 异常才会进入该方法中处理。

  • 方法使用 @Around 注解表示这是一个环绕通知。 环绕通知是所有通知里功能最为强大的通知,可以实现前置通知、后置通知、异常通知以及返回通知的功能。目标方法进入环绕通知后,通过调用 ProceedingJoinPoint 对象的 proceed 方法使目标方法继续执行,开发者可以在此修改目标方法的执行参数、返回值等,并且可以在此处理目标方法的异常。

  1. 配置完成后,接下来在 Controller 中创建接口,分别调用 UserService 中的两个方法,即可看到 LogAspect 中的代码动态地嵌入目标方法中执行了。
getUserById方法执行开始...
get...
getUserById方法执行结束...
getUserById方法返回值为:user
deleteUserById方法执行开始...
delete...
deleteUserById方法执行结束...
deleteUserById方法返回值为:null
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值