1. AOP简介
AOP(面向切面编程)是对OOP(面向对象编程)的补充,它提供了另一种编程思想来将横切关注点(cross-cutting concerns)从核心业务逻辑中分离出来。在Spring框架中,AOP被广泛应用于处理事务、日志、权限等场景。
2. 核心概念
- 切面(Aspect): 横切关注点的模块化,比如事务管理
- 连接点(Join Point): 程序执行过程中的某个特定位置,如方法调用、异常抛出
- 通知(Advice): 在切面的某个特定连接点上执行的动作
- 切入点(Pointcut): 匹配连接点的表达式
- 目标对象(Target Object): 被通知的对象
- AOP代理(AOP Proxy): AOP框架创建的代理对象
3. 实现示例
3.1 添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
3.2 创建切面类
@Aspect
@Component
public class LoggingAspect {
private final Logger logger = LoggerFactory.getLogger(LoggingAspect.class);
// 定义切入点
@Pointcut("execution(* com.example.service.*.*(..))")
public void serviceMethodPointcut() {}
// 前置通知
@Before("serviceMethodPointcut()")
public void beforeMethod(JoinPoint joinPoint) {
String methodName = joinPoint.getSignature().getName();
logger.info("开始执行方法: {}", methodName);
}
// 后置通知
@After("serviceMethodPointcut()")
public void afterMethod(JoinPoint joinPoint) {
String methodName = joinPoint.getSignature().getName();
logger.info("方法执行完成: {}", methodName);
}
// 环绕通知
@Around("serviceMethodPointcut()")
public Object aroundMethod(ProceedingJoinPoint joinPoint) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = joinPoint.proceed();
long endTime = System.currentTimeMillis();
logger.info("方法执行时间: {}ms", (endTime - startTime));
return result;
}
// 异常通知
@AfterThrowing(pointcut = "serviceMethodPointcut()", throwing = "ex")
public void afterThrowing(JoinPoint joinPoint, Exception ex) {
String methodName = joinPoint.getSignature().getName();
logger.error("方法{}执行异常: {}", methodName, ex.getMessage());
}
}
3.3 常用切入点表达式
// 匹配service包下所有类的所有方法
execution(* com.example.service.*.*(..))
// 匹配service包及其子包下所有类的所有方法
execution(* com.example.service..*.*(..))
// 匹配一个具体的方法
execution(* com.example.service.UserService.saveUser(..))
// 匹配带有@Service注解的类的所有方法
@within(org.springframework.stereotype.Service)
// 匹配带有@Transactional注解的方法
@annotation(org.springframework.transaction.annotation.Transactional)
3.4 通知类型详解
参考博主的另一篇文章:Spring AOP通知类型详解与实战
4. 实际应用场景
4.1 方法执行时间统计
@Aspect
@Component
public class PerformanceAspect {
private final Logger logger = LoggerFactory.getLogger(PerformanceAspect.class);
@Around("@annotation(com.example.annotation.MonitorPerformance)")
public Object measureExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
long startTime = System.currentTimeMillis();
Object result = joinPoint.proceed();
long executionTime = System.currentTimeMillis() - startTime;
String methodName = joinPoint.getSignature().getName();
logger.info("方法 {} 执行耗时: {}ms", methodName, executionTime);
return result;
}
}
4.2 接口访问日志记录
@Aspect
@Component
public class ApiLogAspect {
private final Logger logger = LoggerFactory.getLogger(ApiLogAspect.class);
@Before("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
public void logApiAccess(JoinPoint joinPoint) {
ServletRequestAttributes attributes =
(ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
logger.info("请求URL: {}", request.getRequestURL().toString());
logger.info("请求方法: {}", request.getMethod());
logger.info("IP地址: {}", request.getRemoteAddr());
logger.info("类方法: {}.{}",
joinPoint.getSignature().getDeclaringTypeName(),
joinPoint.getSignature().getName());
}
}
5. 注意事项
-
代理方式:Spring AOP默认使用JDK动态代理,如果目标类没有实现接口,则使用CGLIB代理。
-
自调用问题:在同一个类中的方法调用不会触发AOP代理。例如:
@Service
public class UserService {
public void methodA() {
// 这个调用不会触发AOP
methodB();
}
@Transactional
public void methodB() {
// 业务逻辑
}
}
- 切入点顺序:当多个切面同时作用于同一个连接点时,可以通过@Order注解控制优先级:
@Aspect
@Component
@Order(1)
public class SecurityAspect {
// 安全检查逻辑
}
@Aspect
@Component
@Order(2)
public class LoggingAspect {
// 日志记录逻辑
}
6. 最佳实践
-
合理使用切入点:避免过于宽泛的切入点表达式,以免影响性能。
-
异常处理:在切面中要做好异常处理,避免影响业务流程:
@Around("execution(* com.example.service.*.*(..))")
public Object handleException(ProceedingJoinPoint joinPoint) {
try {
return joinPoint.proceed();
} catch (Throwable e) {
logger.error("方法执行异常", e);
throw new RuntimeException(e);
}
}
-
避免重复处理:确保切面之间不会重复处理同样的逻辑。
-
性能考虑:对于高频调用的方法,要谨慎使用AOP,以免影响性能。
7. 总结
Spring AOP是一个强大的功能,通过合理使用可以大大提高代码的可维护性和复用性。但要注意:
- 合理设计切面粒度
- 注意切面的性能影响
- 做好异常处理
- 遵循关注点分离原则