大道至简：Spring Boot 操作日志记录自定义注解解析

2023-10-05 13:08:48

在软件开发中，操作日志记录是一个常见的需求，它可以帮助我们跟踪用户的操作行为，便于故障排查和审计。Spring Boot 作为一种流行的 Java 框架，提供了丰富的功能，其中就包括对操作日志记录的支持。

通常情况下，我们可以通过在控制器方法中手动添加日志记录代码来实现操作日志记录，但这种方式代码冗余，维护不便。为了简化代码，提高开发效率，我们可以使用自定义注解来实现操作日志记录。

首先，我们需要定义一个自定义注解，该注解用于标记需要记录操作日志的方法。例如，我们可以定义一个名为 @LogOperation 的注解，如下所示：

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogOperation {

    String value() default "";

}

其中，@Target(ElementType.METHOD) 表示该注解只能用于方法，@Retention(RetentionPolicy.RUNTIME) 表示该注解在运行时依然存在。

然后，我们需要创建一个日志记录切面，用于拦截所有标记了 @LogOperation 注解的方法，并记录操作日志。例如，我们可以创建一个名为 LogOperationAspect 的切面，如下所示：

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

@Aspect
@Component
public class LogOperationAspect {

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

    @Around("logOperationPointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        // 获取方法上的 @LogOperation 注解
        Method method = joinPoint.getSignature().getMethod();
        LogOperation logOperation = method.getAnnotation(LogOperation.class);

        // 获取操作日志记录内容
        String logContent = logOperation.value();

        // 记录操作日志
        // TODO: 这里可以根据实际情况选择合适的日志记录框架，如 Log4j、Slf4j 等
        System.out.println("操作日志: " + logContent);

        // 执行目标方法
        return joinPoint.proceed();
    }

}

其中，@Pointcut("@annotation(com.example.demo.annotation.LogOperation)") 表示切入点是所有标记了 @LogOperation 注解的方法，@Around("logOperationPointcut()") 表示在切入点方法执行前后执行 advice。

最后，我们需要在 Spring Boot 应用中注册该切面，例如，可以在 Spring Boot 的配置文件 application.properties 中添加如下配置：