SpringBoot AOP记录操作日志

谁借莪１个温暖的怀抱￠ 2022-12-06 12:37 165阅读 0赞

新建枚举类记录操作类型

public enum OperationType {
        /**
         * 操作类型
         */
        UNKNOWN("unknown"),
        DELETE("delete"),
        SELECT("select"),
        UPDATE("update"),
        INSERT("insert");
    
        private String value;
    
        public String getValue() {
            return value;
        }
    
        public void setValue(String value) {
            this.value = value;
        }
    
        OperationType(String s) {
            this.value = s;
        }
    }

新建枚举类记录被操作单元

public enum OperationUnit {
        /**
         * 被操作的单元
         */
        UNKNOWN("unknown"),
        USER("user"),
        EMPLOYEE("employee"),
        Redis("redis");
    
        private String value;
    
        OperationUnit(String value) {
            this.value = value;
        }
    
        public String getValue() {
            return value;
        }
    
        public void setValue(String value) {
            this.value = value;
        }
    }

创建日志注解

@Documented
    @Target({ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface ApiOperatLog {
        /**
         * 方法描述,可使用占位符获取参数:{
       {tel}}
         */
        String detail() default "";
    
        /**
         * 日志等级:自己定，此处分为1-9
         */
        int level() default 0;
    
        /**
         * 操作类型(enum):主要是select,insert,update,delete
         */
        OperationType operationType() default OperationType.UNKNOWN;
    
        /**
         * 被操作的对象(此处使用enum):可以是任何对象，如表名(user)，或者是工具(redis)
         */
        OperationUnit operationUnit() default OperationUnit.UNKNOWN;
    }

编写AOP类记录日志信息

@Slf4j
    @Aspect
    @Component
    public class LogAspect {
        /**
         * 此处的切点是注解的方式，也可以用包名的方式达到相同的效果
         * '@Pointcut("execution(* com.wwj.springboot.service.impl.*.*(..))")'
         */
        @Pointcut("@annotation(cn.it.annotation.ApiOperatLog)")
        public void operationLog(){}
    
    
        /**
         * 环绕增强，相当于MethodInterceptor
         */
        @Around("operationLog()")
        public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
            Object res = null;
            long time = System.currentTimeMillis();
            try {
                res =  joinPoint.proceed();
                time = System.currentTimeMillis() - time;
                return res;
            } finally {
                try {
                    //方法执行完成后增加日志
                    addOperationLog(joinPoint,res,time);
                }catch (Exception e){
                    log.error("LogAspect 操作失败：" + e.getMessage());
                }
            }
        }
    
        @Async
        public void addOperationLog(JoinPoint joinPoint, Object res, long time){
            MethodSignature signature = (MethodSignature)joinPoint.getSignature();
            OperationLog operationLog = new OperationLog();
            operationLog.setRunTime(time);
            operationLog.setReturnValue(JSON.toJSONString(res));
            operationLog.setId(UUID.randomUUID().toString());
            operationLog.setArgs(JSON.toJSONString(joinPoint.getArgs()));
            operationLog.setCreateTime(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
            operationLog.setMethod(signature.getDeclaringTypeName() + "." + signature.getName());
            operationLog.setUserId("#{currentUserId}");
            operationLog.setUserName("#{currentUserName}");
            ApiOperatLog annotation = signature.getMethod().getAnnotation(ApiOperatLog.class);
            if(annotation != null){
                operationLog.setLevel(annotation.level());
                operationLog.setDescribe(getDetail(((MethodSignature)joinPoint.getSignature()).getParameterNames(),joinPoint.getArgs(),annotation));
                operationLog.setOperationType(annotation.operationType().getValue());
                operationLog.setOperationUnit(annotation.operationUnit().getValue());
            }
            //TODO 这里保存日志
            log.info("记录日志:" + operationLog.toString());
        }
    
        /**
         * 对当前登录用户和占位符处理
         * @param argNames 方法参数名称数组
         * @param args 方法参数数组
         * @param annotation 注解信息
         * @return 返回处理后的描述
         */
        private String getDetail(String[] argNames, Object[] args, ApiOperatLog annotation){
    
            Map<Object, Object> map = new HashMap<>(4);
            for(int i = 0;i < argNames.length;i++){
                map.put(argNames[i],args[i]);
            }
    
            String detail = annotation.detail();
            try {
                detail = annotation.detail();
            }catch (Exception e){
                e.printStackTrace();
            }
            return detail;
        }
    }

OK！

接下进行测试：

@ApiOperatLog(detail = "测试",operationType = OperationType.UNKNOWN,operationUnit = OperationUnit.UNKNOWN)
        @GetMapping("/get")
        public String test(@RequestParam("name") String name){
            return  name;
        }