SpringBoot使用AOP原理，实现记录操作日志功能

这也是我对Spring的AOP的第一次实际应用，以前都是背概念，没有实际使用过，现在用起来还挺好用的

1、定义一个日志注解

/**
 * 操作记录注解
 *
 * @author yuanchangliang
 * @version V1.0
 * @since 2021-06-07 09:24
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {

    String value() default "";

    OperationEnum type() default OperationEnum.UNDEFINED;
}

这个日志注解也特别简单，就两个参数，
1、value代表的是‘’操作名称‘’，type代表的是操作类型，
2、type我这里的类型是我自定义的一个枚举，完全可以随便改变type的 类型，可以是String类型，也可以是Integer类型，都可以的。
3、还有我这里都设置了默认值，也是可以随便自定义的。
4、至于其他都是不需要了解的，可以理解为固定写法。

2、写一个切面类

代码在图的下面

/**
 * @author YuanChangLiang
 * @description
 * @date created in 15:30 2021/6/7
 */

@Aspect
@Slf4j
@Component
@RequiredArgsConstructor
public class SysLogAspect {
    @Pointcut("@annotation(cn.ycl.config.SysLog)")
    public void getSysLog() {
    }

    @Around(value = "getSysLog()")
    public Object operationLog(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long beginTime = System.currentTimeMillis();
        Object proceed = proceedingJoinPoint.proceed();
        long time = System.currentTimeMillis() - beginTime;
        //保存日志
        saveSysLog(proceedingJoinPoint, time);
        return proceed;
    }

    private void saveSysLog(ProceedingJoinPoint joinPoint, long time) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        SysLog sysLog = method.getAnnotation(SysLog.class);
        System.out.println("=======================操作日志打印begin=======================");
        System.out.println("操作类型：" + sysLog.type().getOperationName());
        System.out.println("具体操作：" + sysLog.value());
        System.out.println("=======================操作日志打印end=======================");
    }

}

使用我们定义的注解和切面，非常简单

我们随便写一个接口，在接口上面加上我们自定义的@SysLog的注解

    @SysLog(type = OperationEnum.PRODUCT_MANAGE , value = "产品对这个世界说几声hello")
    @PostMapping(value = "/hello22")
    public String hello2() {
        return "Hello22";
    }

在postman里调用结果如下：

完美（我没入库，只是打印，各位实际使用时可以入库）

扩展知识

一般我们的操作记录表字段如下：

一般会包括用户编号、用户名、用户的操作、操作类型、操作的方法、操作的方法时传入的参数等等
用户编号和用户名可以通过SpringSecurity之类的安全框架直接获取（这里不赘述）。
用户的操作和操作类型可以通过我们在@SysLog注解上的value和type获取。
而操作的方法，操作的入参该如何获取呢？

在上面的SysLogAspect.java中，我们获取到了proceedingJoinPoint以及signature（自觉往上翻）
1、获取操作的方法名

String methodName = signature.getName();

2、获取传入的参数

2.1不知道参数类型，直接转String

Object[] args = proceedingJoinPoint.getArgs();
List<Object> argList = Lists.newArrayList();
for (Object arg : args) {
    if (!(arg instanceof HttpServletRequestWrapper)) {
        argList.add(arg);
    }
}
    String params = JSON.toJSONString(argList);

2.2知道参数类型，一般适用于针对某一个或一两个方法进行切面的时候，不适合操作日志时使用
比如这里我知道传的参数类型是Product类型或者Animal类型

Object[] args = proceedingJoinPoint.getArgs();
        for (Object arg : args) {
            if(arg instanceof  Product){
                Product product = (Product) arg;
      				//业务操作....
            }
            else if(arg instanceof Animal){
               Animal animal = (Animal) arg;
                    //业务操作....
            }
        }

以上就是我对SpringBoot中使用Aop的全部感悟和理解了，你学会了，就至少不比我差了，因为我只会这点东西o(╥﹏╥)o

–我是“道祖且长”，一个在互联网"苟且偷生"的Java程序员