Java AOP实现用户操作日志记录（入门指导）

2023-10-21 19:34:27

在Java中使用AOP实现用户操作日志记录的全面指南

在软件开发中，日志记录对于追踪和记录系统事件和信息至关重要，帮助我们快速定位和解决问题。其中，用户操作日志记录尤为重要，它记录用户在系统中的各种操作，以便进行追踪和审计。

什么是AOP？

AOP（面向方面编程）是一种编程技术，允许我们在不修改现有代码的情况下增强程序功能。Spring AOP框架提供了注解，可拦截方法并添加日志记录功能。

如何使用AOP实现用户操作日志记录？

1. 引入Spring AOP依赖

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-aop</artifactId>
  <version>5.3.18</version>
</dependency>

2. 创建日志记录类

public class UserOperationLogger {
  public void log(String operation, String username, String details) {
    // 将日志信息写入数据库或文件
    System.out.println("记录操作：" + operation + "，用户：" + username + "，详细信息：" + details);
  }
}

3. 创建日志切面

@Aspect
@Component
public class UserOperationLogAspect {
  @Autowired
  private UserOperationLogger logger;

  @Pointcut("@annotation(com.example.demo.annotation.UserOperationLog)")
  public void pointcut() {}

  @Around("pointcut()")
  public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
    String operation = joinPoint.getSignature().getName();
    String username = "admin"; // 从当前登录用户中获取用户名
    String details = ""; // 从请求参数中获取操作详细信息

    logger.log(operation, username, details);

    return joinPoint.proceed();
  }
}

4. 标注需要记录日志的方法

@RestController
@RequestMapping("/user")
public class UserController {
  @UserOperationLog
  @PostMapping("/create")
  public User create(@RequestBody User user) {
    // 创建用户
    return user;
  }
}

5. 测试

执行创建用户操作，日志记录类将记录该操作，并在控制台或日志文件中输出日志信息。

示例代码

// 日志记录注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface UserOperationLog {}

// 测试控制器
@RestController
@RequestMapping("/user")
public class UserController {
  @UserOperationLog
  @PostMapping("/create")
  public User create(@RequestBody User user) {
    // 创建用户
    return user;
  }
}