使用SpringAOP获取用户操作日志入库

使用SpringAOP获取用户操作日志入库是一个常见的场景，可以通过AOP的方式实现，在用户操作某个方法时自动记录用户的操作日志，并将日志写入数据库中，方便后续的查询和分析。以下是实现该功能的完整攻略：

1. 配置依赖库

首先，需要在pom.xml中配置依赖库，包括Spring AOP和Mybatis等库。示例代码如下：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aop</artifactId>
    <version>${spring.version}</version>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>${mybatis.version}</version>
</dependency>

2. 定义日志实体类

定义一个实体类，表示操作日志的信息，包括用户名、操作时间、操作方法等等。示例代码如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class OperationLog {
    private String username;
    private LocalDateTime operationTime;
    private String operationMethod;
    private String operationResult;
}

3. 编写AOP切面

在AOP切面中，定义一个切入点，匹配所有需要记录操作日志的方法，然后在方法执行前后进行处理，记录日志信息并存入数据库中。示例代码如下：

@Aspect
@Component
public class OperationLogAspect {
    @Autowired
    private OperationLogMapper operationLogMapper;

    @Pointcut("@annotation(Loggable)")
    public void loggableMethod() {}

    @Before("loggableMethod()")
    public void logOperationBefore(JoinPoint joinPoint) {
        OperationLog operationLog = createOperationLog(joinPoint, "start");
        operationLogMapper.insert(operationLog);
    }

    @AfterReturning(value = "loggableMethod()", returning = "returnValue")
    public void logOperationAfter(JoinPoint joinPoint, Object returnValue) {
        OperationLog operationLog = createOperationLog(joinPoint, "success");
        operationLog.setOperationResult(String.valueOf(returnValue));
        operationLogMapper.insert(operationLog);
    }

    @AfterThrowing(value = "loggableMethod()", throwing = "e")
    public void logOperationError(JoinPoint joinPoint, Throwable e) {
        OperationLog operationLog = createOperationLog(joinPoint, "error");
        operationLog.setOperationResult(e.getMessage());
        operationLogMapper.insert(operationLog);
    }

    private OperationLog createOperationLog(JoinPoint joinPoint, String operationResult) {
        OperationLog operationLog = new OperationLog();
        operationLog.setUsername(SecurityContextHolder.getContext().getAuthentication().getName());
        operationLog.setOperationTime(LocalDateTime.now());
        operationLog.setOperationMethod(joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        operationLog.setOperationResult(operationResult);
        return operationLog;
    }
}

在该示例中，我们使用了三个Advice，分别代表方法执行前、执行后和执行异常时的处理逻辑。createOperationLog方法用于创建操作日志实体对象，根据JoinPoint获取相关的方法信息、用户名信息等等。

4. 在需要日志记录的方法上添加注解

在需要记录操作日志的方法上添加一个注解，用于标记该方法需要进行日志记录。示例代码如下：

@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @Loggable
    @PostMapping("/users")
    public User createUser(@Validated @RequestBody User user) {
        return userService.createUser(user);
    }
}

在该示例中，我们在createUser方法上加入了@Loggable注解，表示该方法需要进行日志记录。

5. 完成Mapper的实现

最后，我们需要实现OperationLogMapper接口，使用Mybatis框架将实体类映射为数据库表，并将操作日志写入数据库中。示例代码如下：

@Mapper
public interface OperationLogMapper {
    @Insert("insert into operation_log(username, operation_time, operation_method, operation_result) values (#{username}, #{operationTime}, #{operationMethod}, #{operationResult})")
    void insert(OperationLog operationLog);
}

以上就是使用Spring AOP获取用户操作日志入库的完整攻略，通过AOP切面实现日志记录，可以大幅度提高代码的复用性和可维护性。