在 Spring Boot 中使用 AOP 实现接口访问日志记录

后端

2024-01-18 03:40:42

AOP 的魅力

AOP（面向方面编程）是一种编程范式，它允许开发者在不修改现有代码的情况下向应用程序添加横切关注点，例如日志记录、安全或事务管理。在 Spring Boot 中，AOP 是一个强大的工具，可以大大简化应用程序开发并提高代码的可维护性。

统一接口访问日志记录

在分布式系统中，记录接口访问日志对于故障排除、审计和性能分析至关重要。使用 AOP，我们可以为所有接口访问操作建立一个统一的日志记录机制，从而简化日志收集和分析流程。

实施步骤

1. 声明切面

切面是 AOP 的核心，它定义了要拦截的连接点（例如方法调用）以及要应用的建议（例如日志记录）。

@Aspect
@Component
public class ControllerLoggingAspect {

    private Logger logger = LoggerFactory.getLogger(ControllerLoggingAspect.class);

    @Pointcut("execution(* com.example.demo.controller..*.*(..))")
    public void controllerMethod() { }

    @Before("controllerMethod()")
    public void logBefore(JoinPoint joinPoint) {
        logger.info("Calling method: " + joinPoint.getSignature().getName());
    }

    @AfterReturning(pointcut = "controllerMethod()", returning = "result")
    public void logAfterReturning(JoinPoint joinPoint, Object result) {
        logger.info("Method returned: " + result);
    }
}