当前位置：首页 > news >正文

Spring Boot 切面编程（AOP）详细教程

news 2025/6/25 14:19:30

Spring Boot 切面编程（AOP）详细教程

一、概述：什么是AOP？为什么需要它？

AOP（Aspect-Oriented Programming）即面向切面编程，是一种与OOP（面向对象编程）互补的编程思想。
简单理解：OOP关注“对象的属性与行为”（比如用户对象有姓名、年龄，能登录），而AOP关注“多个对象/方法的共同行为”（比如所有方法执行前需要记录日志、所有接口调用需要校验权限）。

核心价值：解耦

假设你需要为100个方法添加“日志记录”功能，如果用OOP（在每个方法里写日志代码），会导致代码重复、维护困难。而AOP可以把这些“公共逻辑”抽离成独立的“切面”，自动“切入”到需要的位置，让业务代码保持干净。

二、AOP的核心概念（必须掌握）

术语	解释
切面（Aspect）	封装公共逻辑的类（比如日志切面、权限切面），用`@Aspect`注解标记
连接点（JoinPoint）	程序执行的某个点（比如方法调用、异常抛出），AOP的“切入点”候选位置
切入点（Pointcut）	明确指定要“切入”的连接点（比如“所有`UserController`类的方法”）
通知（Advice）	切面在连接点执行的具体逻辑（比如“方法执行前记录日志”“方法执行后统计耗时”）

三、通知（Advice）的5种类型（最常用！）

Spring AOP通过注解定义通知，控制公共逻辑在“何时执行”。5种通知类型如下：

注解	执行时机	典型场景
`@Before`	目标方法执行前（不能阻止目标方法执行）	日志记录、权限校验
`@After`	目标方法执行后（无论成功/失败都会执行）	资源释放、结果汇总
`@AfterReturning`	目标方法成功返回后（失败不执行）	结果处理、数据同步
`@AfterThrowing`	目标方法抛出异常后	异常日志记录、错误补偿
`@Around`	包裹目标方法（可控制目标方法是否执行）	性能监控、事务管理

四、使用场景：AOP能解决哪些实际问题？

AOP适合处理跨多个方法/类的公共逻辑，常见场景：

日志记录：自动记录接口调用参数、返回结果、耗时（比如统计用户登录接口的访问量）。
权限校验：在敏感方法执行前检查用户是否有权限（比如删除订单前校验是否是订单主人）。
性能监控：统计方法执行耗时，定位慢接口（比如找出响应时间超过1秒的接口）。
事务管理：控制数据库事务的开启、提交、回滚（Spring声明式事务的底层就是AOP）。
参数校验：在方法执行前校验入参是否合法（比如检查用户输入的手机号格式）。

五、代码实现：Spring Boot中如何写AOP？

步骤1：添加依赖（Spring Boot自动集成AOP）

Spring Boot项目默认包含AOP依赖，无需额外添加。如果是手动创建的项目，检查pom.xml是否有：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId>
</dependency>

步骤2：定义切面类（核心）

创建一个普通Java类，用@Aspect和@Component注解标记（告诉Spring这是一个切面，需要被扫描）。

步骤3：定义切入点（Pointcut）

用@Pointcut注解定义“需要切入的方法”，通过切入点表达式指定目标方法。
常用切入点表达式：

execution(* com.example.demo.controller.*.*(..))：匹配controller包下所有类的所有方法（*表示任意返回值/类名/方法名，..表示任意参数）。
@annotation(com.example.demo.annotation.Log)：匹配所有使用了@Log自定义注解的方法。

步骤4：编写通知（Advice）

在切面类中编写方法，用@Before/@After等注解绑定到切入点，实现公共逻辑。

完整示例：用AOP实现接口调用日志记录

需求：所有`UserController`的接口被调用时，自动记录“调用时间、方法名、入参、耗时”。

1. 创建自定义注解（可选，用于灵活标记需要记录的方法）

如果只想记录部分方法，可以用注解标记。比如定义@Log注解：

import java.lang.annotation.*;@Target(ElementType.METHOD) // 作用在方法上
@Retention(RetentionPolicy.RUNTIME) // 运行时生效
public @interface Log {String desc() default "默认日志"; // 日志描述
}

2. 创建切面类（核心代码）

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.Date;@Aspect // 标记这是一个切面
@Component // 交给Spring管理
public class LogAspect {/*** 定义切入点：匹配所有使用@Log注解的方法* （如果想匹配所有controller方法，改为 execution(* com.example.demo.controller.*.*(..)) ）*/@Pointcut("@annotation(com.example.demo.annotation.Log)") public void logPointcut() {}/*** @Before：目标方法执行前记录入参*/@Before("logPointcut()") public void beforeLog(JoinPoint joinPoint) {String methodName = joinPoint.getSignature().getName(); // 获取方法名Object[] args = joinPoint.getArgs(); // 获取方法入参System.out.println("【日志-前置】调用时间：" + new Date());System.out.println("【日志-前置】方法名：" + methodName);System.out.println("【日志-前置】入参：" + Arrays.toString(args));}/*** @Around：统计方法执行耗时（能控制目标方法是否执行）*/@Around("logPointcut()") public Object aroundLog(ProceedingJoinPoint joinPoint) throws Throwable {long start = System.currentTimeMillis();Object result = joinPoint.proceed(); // 执行目标方法（必须调用，否则目标方法不会执行）long end = System.currentTimeMillis();System.out.println("【日志-环绕】耗时：" + (end - start) + "ms");return result; // 返回目标方法的结果}/*** @AfterReturning：目标方法成功返回后记录结果*/@AfterReturning(pointcut = "logPointcut()", returning = "result") public void afterReturningLog(Object result) {System.out.println("【日志-返回后】返回结果：" + result);}
}

3. 在业务方法中使用@Log注解（触发切面）

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;@RestController
public class UserController {@Log(desc = "用户登录接口") // 使用自定义注解，触发切面@PostMapping("/login")public String login(@RequestBody User user) {// 模拟登录逻辑return "登录成功，用户：" + user.getUsername();}
}// User类（简单POJO）
class User {private String username;private String password;// get/set方法...
}

4. 测试效果

调用/login接口时，控制台会输出

【日志-前置】调用时间：xxxxxx
【日志-前置】方法名：login
【日志-前置】入参：[User(username=张三, password=123)]
【日志-环绕】耗时：5ms
【日志-返回后】返回结果：登录成功，用户：张三

六、实际业务举例：用AOP实现权限校验

需求：用户调用“删除订单”接口时，必须校验是否是订单的主人。

实现步骤：

定义@CheckPermission注解（标记需要校验权限的方法）。
创建权限校验切面，在@Before通知中检查用户是否有权限。
如果无权限，直接抛出异常，阻止方法执行。

代码示例：

// 1. 自定义注解@CheckPermission
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CheckPermission {String value() default "order:delete"; // 权限标识
}// 2. 权限校验切面
@Aspect
@Component
public class PermissionAspect {@Pointcut("@annotation(com.example.demo.annotation.CheckPermission)")public void permissionPointcut() {}@Before("permissionPointcut()")public void checkPermission(JoinPoint joinPoint) {// 从请求中获取当前用户ID（实际项目中可能从Token解析）Long currentUserId = getCurrentUserIdFromRequest(); // 获取方法参数中的订单ID（假设第一个参数是订单ID）Object[] args = joinPoint.getArgs();Long orderId = (Long) args[0]; // 查询订单的主人ID（调用Service）Long orderOwnerId = orderService.getOrderOwnerId(orderId);// 校验权限if (!currentUserId.equals(orderOwnerId)) {throw new RuntimeException("无权限操作！");}}// 模拟从请求中获取用户ID（实际项目中用Spring Security等框架）private Long getCurrentUserIdFromRequest() {return 123L; // 假设当前用户ID是123}
}// 3. 在业务方法中使用@CheckPermission
@RestController
public class OrderController {@CheckPermission("order:delete") // 标记需要校验权限@PostMapping("/order/delete")public String deleteOrder(Long orderId) {orderService.deleteOrder(orderId);return "订单删除成功";}
}

效果：

如果当前用户ID（123）与订单主人ID不一致，调用/order/delete接口会直接抛出异常，阻止订单删除操作。

七、总结：AOP的优缺点与注意事项

优点：

代码解耦：公共逻辑与业务逻辑分离，业务代码更干净。
复用性强：一个切面可以应用到多个方法，减少重复代码。
灵活扩展：新增公共逻辑时，只需修改切面，无需改动业务代码。

缺点：

调试复杂：切面逻辑可能影响多个方法，错误时需要追踪切面代码。
性能开销：AOP通过动态代理实现，大量切面可能增加方法调用耗时（但日常业务中可忽略）。
学习成本：需要理解切入点表达式、通知类型等概念。

注意事项：

切入点表达式尽量具体：避免匹配到不需要的方法（比如execution(* *.*(..))会匹配所有方法，导致性能问题）。
@Around通知谨慎使用：必须调用proceed()方法，否则目标方法不会执行。
异常处理：在@AfterThrowing中捕获异常时，注意不要覆盖业务本身的异常处理逻辑。
与拦截器的区别：拦截器（Interceptor）是Spring MVC的概念，主要针对HTTP请求；AOP是更底层的面向切面，可作用于任何方法（包括Service、DAO层）。

查看全文

http://www.lryc.cn/news/574725.html