SpringBoot 实战：借助 AOP 与注解轻松记录操作日志

在当今的软件开发中，记录操作日志对于系统的监控、故障排查和审计至关重要。Spring Boot 作为一款流行的开发框架，提供了强大的功能来实现这一需求。本文将介绍如何借助 AOP（面向切面编程）和注解，轻松记录操作日志。

我们需要在项目中引入相关的依赖，例如 Spring AOP 的依赖和日志框架（如 Logback 或 Log4j）的依赖。

接下来，定义一个注解来标识需要记录操作日志的方法。例如：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogOperation {
    String description();
}

然后，创建一个 AOP 切面类，用于拦截被注解标记的方法，并记录操作日志。

@Aspect
@Component
public class LoggingAspect {

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

    @Pointcut("@annotation(com.example.LogOperation)")
    public void loggableMethod() {}

    @Before("loggableMethod()")
    public void beforeMethod(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        LogOperation logOperation = method.getAnnotation(LogOperation.class);
        String description = logOperation.description();
        logger.info("准备执行操作：" + description);
    }

    @AfterReturning(pointcut = "loggableMethod()", returning = "result")
    public void afterMethodReturning(JoinPoint joinPoint, Object result) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        LogOperation logOperation = method.getAnnotation(LogOperation.class);
        String description = logOperation.description();
        logger.info("操作完成：" + description + "，结果：" + result);
    }

    @AfterThrowing(pointcut = "loggableMethod()", throwing = "ex")
    public void afterMethodThrowing(JoinPoint joinPoint, Exception ex) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        LogOperation logOperation = method.getAnnotation(LogOperation.class);
        String description = logOperation.description();
        logger.error("操作异常：" + description + "，异常信息：" + ex.getMessage());
    }
}

在需要记录操作日志的方法上添加自定义注解，并指定描述信息。

@LogOperation(description = "用户登录操作")
public void login(String username, String password) {
    // 登录逻辑
}

通过以上的配置和代码实现，当调用被注解标记的方法时，AOP 切面会自动记录相应的操作日志，包括操作前的准备、操作的结果以及异常情况。

利用 Spring Boot 的 AOP 和注解机制，能够以简洁高效的方式实现操作日志的记录，为系统的运维和管理提供有力的支持。这不仅有助于提高开发效率，还能增强系统的可维护性和稳定性。