Spring Aop - 切面日志

场景

   对于某一个模块的数据，用户有权对数据进行修改，用户修改成功后需要留存用户的修改记录，记录修改人及修改时间，作为日后查询的凭证。

思路

常规思路 ：在每个方法中添加记录日志的操作，简单粗暴，但是代码冗余度高，且修改难度大、耦合度高，不太友好。

AOP ： 通过切面达到目的， 使用 @Pointcut() 注解切中所需方法，在一个切面类中进行对应操作。日志记录与实际功能解耦，代码耦合度底，且便于修改与拓展。

实现

定义日志类，添加需要记录的日志属性。

import lombok.Data;

import java.time.LocalDateTime;

@Data
public class AspectLog {

    private String method;

    private Object[] params;

    private String cla;

    private LocalDateTime createTime;

}

定义切面类，编写切面日志实现。需求要求修改成功后才记录操作日志，所以可以使用 ThreadLocal 来定义一个线程变量，在不同通知节点进行操作，如，在前置通知进行日志信息生成，在后置通知中记录日志（日志记录可以考虑使用 MQ 解耦）。

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

@Slf4j
@Aspect
@Component("saveLogAspect")
public class LogAspect {

    private static final ThreadLocal<AspectLog> OPERATE_LOG = new ThreadLocal<>();

    @Pointcut("execution(* *.*..*Controller.save*(..))")
    public void pointcut() {

    }
    
    @Before("pointcut()")
    public void before(JoinPoint joinPoint) {
        try {
            //获取被切中方法的类
            Class<?> targetClass = joinPoint.getTarget ().getClass();
            //获取被切中过的方法
            String method = joinPoint.getSignature().getName();
            //获取被切中方法的参数:
            Object[] params = joinPoint.getArgs();
            AspectLog log = new AspectLog();
            log.setMethod(method);
            log.setParams(params);
            log.setCla(targetClass.getTypeName());
            OPERATE_LOG.set(log);
        } catch (Exception e) {
            log.error("生成切面日志信息出错！");
        }
    }

    @AfterReturning("pointcut()")
    public void afterReturning() {
        try {
            //存日志
            AspectLog log = OPERATE_LOG.get();
            log.setCreateTime(LocalDateTime.now());
            //保存,

        } catch (Exception e) {
            log.error("保存切面日志信息出错！");
        } finally {
            //清除线程变量
            OPERATE_LOG.remove();
        }
    }

    @AfterThrowing(value = "pointcut()")
    public void afterThrowing() {
        OPERATE_LOG.remove();
    }

}

编写控制类，进行测试。

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class AopController {

    @ResponseBody
    @RequestMapping("saveAopLog")
    public String saveAopLog(@RequestParam(required = false, name = "name", defaultValue = "aopTestName") String name){
        return "success";
    }

}