完成操作日志的记录

src/main/java/cn/iocoder/dashboard/framework/async/config/AsyncConfiguration.java

@@ -0,0 +1,9 @@
+package cn.iocoder.dashboard.framework.async.config;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableAsync;
+
+@Configuration
+@EnableAsync(proxyTargetClass = true)
+public class AsyncConfiguration {
+}

src/main/java/cn/iocoder/dashboard/framework/async/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * 异步执行，基于 Spring @Async 实现
+ */
+package cn.iocoder.dashboard.framework.async;

src/main/java/cn/iocoder/dashboard/framework/async/《芋道 Spring Boot 异步任务入门》.md

@@ -0,0 +1 @@
+<http://www.iocoder.cn/Spring-Boot/Async-Job/?dashboard>

src/main/java/cn/iocoder/dashboard/framework/logger/operatelog/config/OperateLogConfiguration.java

@@ -0,0 +1,15 @@
+package cn.iocoder.dashboard.framework.logger.operatelog.config;
+
+import cn.iocoder.dashboard.framework.logger.operatelog.core.aop.OperateLogAspect;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class OperateLogConfiguration {
+
+    @Bean
+    public OperateLogAspect operateLogAspect() {
+        return new OperateLogAspect();
+    }
+
+}

src/main/java/cn/iocoder/dashboard/framework/logger/operatelog/core/annotations/OperateLog.java

@@ -0,0 +1,52 @@
+package cn.iocoder.dashboard.framework.logger.operatelog.core.annotations;
+
+import cn.iocoder.dashboard.modules.system.enums.logger.SysOperateLogTypeEnum;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface OperateLog {
+
+    // ========== 模块字段 ==========
+
+    /**
+     * 操作模块
+     *
+     * 为空时，会尝试读取 {@link Api#value()} 属性
+     */
+    String module() default "";
+    /**
+     * 操作名
+     *
+     * 为空时，会尝试读取 {@link ApiOperation#value()} 属性
+     */
+    String name() default "";
+    /**
+     * 操作分类
+     *
+     * 实际并不是数组，因为枚举不能设置 null 作为默认值
+     */
+    SysOperateLogTypeEnum[] type() default {};
+
+    // ========== 开关字段 ==========
+
+    /**
+     * 是否记录操作日志
+     */
+    boolean enable() default true;
+    /**
+     * 是否记录方法参数
+     */
+    boolean logArgs() default true;
+    /**
+     * 是否记录方法结果的数据
+     */
+    boolean logResultData() default true;
+
+}

src/main/java/cn/iocoder/dashboard/framework/logger/operatelog/core/aop/OperateLogAspect.java

@@ -0,0 +1,320 @@
+package cn.iocoder.dashboard.framework.logger.operatelog.core.aop;
+
+import cn.hutool.core.exceptions.ExceptionUtil;
+import cn.hutool.core.util.ArrayUtil;
+import cn.hutool.core.util.StrUtil;
+import cn.hutool.extra.servlet.ServletUtil;
+import cn.iocoder.dashboard.common.pojo.CommonResult;
+import cn.iocoder.dashboard.framework.logger.operatelog.core.annotations.OperateLog;
+import cn.iocoder.dashboard.framework.logger.operatelog.core.service.OperateLogFrameworkService;
+import cn.iocoder.dashboard.framework.security.core.util.SecurityUtils;
+import cn.iocoder.dashboard.framework.tracer.core.util.TracerUtils;
+import cn.iocoder.dashboard.modules.system.controller.logger.vo.SysOperateLogCreateReqVO;
+import cn.iocoder.dashboard.modules.system.enums.logger.SysOperateLogTypeEnum;
+import cn.iocoder.dashboard.util.servlet.ServletUtils;
+import com.alibaba.fastjson.JSON;
+import com.google.common.collect.Maps;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import lombok.extern.slf4j.Slf4j;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.Around;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.reflect.MethodSignature;
+import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.context.request.RequestAttributes;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+import org.springframework.web.multipart.MultipartFile;
+
+import javax.annotation.Resource;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Array;
+import java.util.*;
+import java.util.function.Predicate;
+import java.util.stream.IntStream;
+
+import static cn.iocoder.dashboard.common.exception.enums.GlobalErrorCodeConstants.INTERNAL_SERVER_ERROR;
+import static cn.iocoder.dashboard.common.exception.enums.GlobalErrorCodeConstants.SUCCESS;
+
+/**
+ * 拦截使用 @ApiOperation 注解，如果满足条件，则生成操作日志。
+ * 满足如下任一条件，则会进行记录：
+ * 1. 使用 @ApiOperation + 非 @GetMapping
+ * 2. 使用 @OperateLog 注解
+ *
+ * 但是，如果声明 @OperateLog 注解时，将 enable 属性设置为 false 时，强制不记录。
+ *
+ * 为什么考虑使用 @ApiOperation 记录呢？避免有小伙伴忘记添加 @OperateLog 注解
+ *
+ * @author 芋道源码
+ */
+@Aspect
+@Slf4j
+public class OperateLogAspect {
+
+    @Resource
+    private OperateLogFrameworkService operateLogFrameworkService;
+
+    @Around("@annotation(apiOperation)")
+    public Object around(ProceedingJoinPoint joinPoint, ApiOperation apiOperation) throws Throwable {
+        // 可能也添加了 @ApiOperation 注解
+        OperateLog operateLog = getMethodAnnotation(joinPoint, OperateLog.class);
+        return around0(joinPoint, operateLog, apiOperation);
+    }
+
+    @Around("!@annotation(io.swagger.annotations.ApiOperation) && @annotation(operateLog)") // 兼容处理，只添加 @OperateLog 注解的情况
+    public Object around(ProceedingJoinPoint joinPoint, OperateLog operateLog) throws Throwable {
+        return around0(joinPoint, operateLog, null);
+    }
+
+    private Object around0(ProceedingJoinPoint joinPoint, OperateLog operateLog, ApiOperation apiOperation) throws Throwable {
+        // 记录开始时间
+        Date startTime = new Date();
+        try {
+            // 执行原有方法
+            Object result = joinPoint.proceed();
+            // 记录正常执行时的操作日志
+            this.log(joinPoint, operateLog, apiOperation, startTime, result, null);
+            return result;
+        } catch (Throwable exception) {
+            this.log(joinPoint, operateLog, apiOperation, startTime, null, exception);
+            throw exception;
+        }
+    }
+
+    private void log(ProceedingJoinPoint joinPoint, OperateLog operateLog, ApiOperation apiOperation,
+                     Date startTime, Object result, Throwable exception) {
+        try {
+            // 判断不记录的情况
+            if (!isLogEnable(joinPoint, operateLog)) {
+                return;
+            }
+            // 真正记录操作日志
+            this.log0(joinPoint, operateLog, apiOperation, startTime, result, exception);
+        } catch (Throwable ex) {
+            log.error("[log][记录操作日志时，发生异常，其中参数是 joinPoint({}) operateLog({}) apiOperation({}) result({}) exception({}) ]",
+                    joinPoint, operateLog, apiOperation, result, exception, ex);
+        }
+    }
+
+    private void log0(ProceedingJoinPoint joinPoint, OperateLog operateLog, ApiOperation apiOperation,
+                      Date startTime, Object result, Throwable exception) {
+        SysOperateLogCreateReqVO operateLogVO = new SysOperateLogCreateReqVO();
+        // 补全通用字段
+        operateLogVO.setTraceId(TracerUtils.getTraceId());
+        operateLogVO.setStartTime(startTime);
+        // 补充用户信息
+        fillUserFields(operateLogVO);
+        // 补全模块信息
+        fillModuleFields(operateLogVO, joinPoint, operateLog, apiOperation);
+        // 补全请求信息
+        fillRequestFields(operateLogVO);
+        // 补全方法信息
+        fillMethodFields(operateLogVO, joinPoint, operateLog, startTime, result, exception);
+
+        // 异步记录日志
+        operateLogFrameworkService.createOperateLogAsync(operateLogVO);
+    }
+
+    private static void fillUserFields(SysOperateLogCreateReqVO operateLogVO) {
+        operateLogVO.setUserId(SecurityUtils.getLoginUserId());
+    }
+
+    private static void fillModuleFields(SysOperateLogCreateReqVO operateLogVO,
+                                         ProceedingJoinPoint joinPoint, OperateLog operateLog, ApiOperation apiOperation) {
+        // module 属性
+        if (operateLog != null) {
+            operateLogVO.setModule(operateLog.module());
+        }
+        if (StrUtil.isEmpty(operateLogVO.getModule())) {
+            Api api = getClassAnnotation(joinPoint, Api.class);
+            if (api != null) {
+                operateLogVO.setModule(Optional.of(api.value())
+                        .orElse(ArrayUtil.isEmpty(api.tags()) ? api.tags()[0] : null));
+            }
+        }
+        // name 属性
+        if (operateLog != null) {
+            operateLogVO.setName(operateLog.name());
+        }
+        if (StrUtil.isEmpty(operateLogVO.getName()) && apiOperation != null) {
+            operateLogVO.setName(apiOperation.value());
+        }
+        // type 属性
+        if (operateLog != null && ArrayUtil.isNotEmpty(operateLog.type())) {
+            operateLogVO.setType(operateLog.type()[0].getType());
+        }
+        if (operateLogVO.getType() == null) {
+            RequestMethod requestMethod = obtainFirstMatchRequestMethod(obtainRequestMethod(joinPoint));
+            SysOperateLogTypeEnum operateLogType = convertOperateLogType(requestMethod);
+            operateLogVO.setType(operateLogType != null ? operateLogType.getType() : null);
+        }
+    }
+
+    private static void fillRequestFields(SysOperateLogCreateReqVO operateLogVO) {
+        // 获得 Request 对象
+        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
+        if (!(requestAttributes instanceof ServletRequestAttributes)) {
+            return;
+        }
+        HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
+        // 补全请求信息
+        operateLogVO.setRequestMethod(request.getMethod());
+        operateLogVO.setRequestUrl(request.getRequestURI());
+        operateLogVO.setUserIp(ServletUtil.getClientIP(request));
+        operateLogVO.setUserAgent(ServletUtils.getUserAgent(request));
+    }
+
+    private static void fillMethodFields(SysOperateLogCreateReqVO operateLogVO,
+                                         ProceedingJoinPoint joinPoint, OperateLog operateLog,
+                                         Date startTime, Object result, Throwable exception) {
+        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
+        operateLogVO.setJavaMethod(methodSignature.toString());
+        if (operateLog == null || operateLog.logArgs()) {
+            operateLogVO.setJavaMethodArgs(obtainMethodArgs(joinPoint));
+        }
+        if (operateLog == null || operateLog.logResultData()) {
+            operateLogVO.setResultData(obtainResultData(result));
+        }
+        operateLogVO.setDuration((int) (System.currentTimeMillis() - startTime.getTime()));
+        // （正常）处理 resultCode 和 resultMsg 字段
+        if (result != null) {
+            if (result instanceof CommonResult) {
+                CommonResult<?> commonResult = (CommonResult<?>) result;
+                operateLogVO.setResultCode(commonResult.getCode());
+                operateLogVO.setResultMsg(commonResult.getMsg());
+            } else {
+                operateLogVO.setResultCode(SUCCESS.getCode());
+            }
+        }
+        // （异常）处理 resultCode 和 resultMsg 字段
+        if (exception != null) {
+            operateLogVO.setResultCode(INTERNAL_SERVER_ERROR.getCode());
+            operateLogVO.setResultMsg(ExceptionUtil.getRootCauseMessage(exception));
+        }
+    }
+
+    private static boolean isLogEnable(ProceedingJoinPoint joinPoint, OperateLog operateLog) {
+        // 有 @OperateLog 注解的情况下
+        if (operateLog != null) {
+            return operateLog.enable();
+        }
+        // 没有 @ApiOperation 注解的情况下，只记录 POST、PUT、DELETE 的情况
+        return obtainFirstLogRequestMethod(obtainRequestMethod(joinPoint)) != null;
+    }
+
+    private static RequestMethod obtainFirstLogRequestMethod(RequestMethod[] requestMethods) {
+        if (ArrayUtil.isEmpty(requestMethods)) {
+            return null;
+        }
+        return Arrays.stream(requestMethods).filter(requestMethod ->
+                           requestMethod == RequestMethod.POST
+                        || requestMethod == RequestMethod.PUT
+                        || requestMethod == RequestMethod.DELETE)
+                .findFirst().orElse(null);
+    }
+
+    private static RequestMethod obtainFirstMatchRequestMethod(RequestMethod[] requestMethods) {
+        if (ArrayUtil.isEmpty(requestMethods)) {
+            return null;
+        }
+        // 优先，匹配最优的 POST、PUT、DELETE
+        RequestMethod result = obtainFirstLogRequestMethod(requestMethods);
+        if (result != null) {
+            return result;
+        }
+        // 然后，匹配次优的 GET
+        result = Arrays.stream(requestMethods).filter(requestMethod -> requestMethod == RequestMethod.GET)
+                .findFirst().orElse(null);
+        if (result != null) {
+            return result;
+        }
+        // 兜底，获得第一个
+        return requestMethods[0];
+    }
+
+    private static SysOperateLogTypeEnum convertOperateLogType(RequestMethod requestMethod) {
+        if (requestMethod == null) {
+            return null;
+        }
+        switch (requestMethod) {
+            case GET:
+                return SysOperateLogTypeEnum.GET;
+            case POST:
+                return SysOperateLogTypeEnum.CREATE;
+            case PUT:
+                return SysOperateLogTypeEnum.UPDATE;
+            case DELETE:
+                return SysOperateLogTypeEnum.DELETE;
+            default:
+                return SysOperateLogTypeEnum.OTHER;
+        }
+    }
+
+    private static RequestMethod[] obtainRequestMethod(ProceedingJoinPoint joinPoint) {
+        RequestMapping requestMapping = AnnotationUtils.getAnnotation( // 使用 Spring 的工具类，可以处理 @RequestMapping 别名注解
+                ((MethodSignature) joinPoint.getSignature()).getMethod(), RequestMapping.class);
+        return requestMapping != null ? requestMapping.method() : new RequestMethod[]{};
+    }
+
+    @SuppressWarnings("SameParameterValue")
+    private static <T extends Annotation> T getMethodAnnotation(ProceedingJoinPoint joinPoint, Class<T> annotationClass) {
+        return ((MethodSignature) joinPoint.getSignature()).getMethod().getAnnotation(annotationClass);
+    }
+
+    @SuppressWarnings("SameParameterValue")
+    private static <T extends Annotation> T getClassAnnotation(ProceedingJoinPoint joinPoint, Class<T> annotationClass) {
+        return ((MethodSignature) joinPoint.getSignature()).getMethod().getDeclaringClass().getAnnotation(annotationClass);
+    }
+
+    private static Map<String, Object> obtainMethodArgs(ProceedingJoinPoint joinPoint) {
+        // TODO 提升：参数脱敏和忽略
+        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
+        String[] argNames = methodSignature.getParameterNames();
+        Object[] argValues = joinPoint.getArgs();
+        // 拼接参数
+        Map<String, Object> args = Maps.newHashMapWithExpectedSize(argValues.length);
+        for (int i = 0; i < argNames.length; i++) {
+            String argName = argNames[i];
+            Object argValue = argValues[i];
+            // 被忽略时，标记为 ignore 字符串，避免和 null 混在一起
+            args.put(argName, !isIgnoreArgs(argValue) ? argValue : "[ignore]");
+        }
+        return args;
+    }
+
+    private static String obtainResultData(Object result) {
+        // TODO 提升：结果脱敏和忽略
+        if (result instanceof CommonResult) {
+            result = ((CommonResult<?>) result).getData();
+        }
+        return JSON.toJSONString(result);
+    }
+
+    private static boolean isIgnoreArgs(Object object) {
+        Class<?> clazz = object.getClass();
+        // 处理数组的情况
+        if (clazz.isArray()) {
+            return IntStream.range(0, Array.getLength(object))
+                    .anyMatch(index -> isIgnoreArgs(Array.get(object, index)));
+        }
+        // 递归，处理数组、Collection、Map 的情况
+        if (Collection.class.isAssignableFrom(clazz)) {
+            return ((Collection<?>) object).stream()
+                    .anyMatch((Predicate<Object>) o -> isIgnoreArgs(object));
+        }
+        if (Map.class.isAssignableFrom(clazz)) {
+            return isIgnoreArgs(((Map<?, ?>) object).values());
+        }
+        // obj
+        return object instanceof MultipartFile
+                || object instanceof HttpServletRequest
+                || object instanceof HttpServletResponse;
+    }
+
+}

src/main/java/cn/iocoder/dashboard/framework/logger/operatelog/core/package-info.java

@@ -0,0 +1 @@
+package cn.iocoder.dashboard.framework.logger.operatelog.core;

src/main/java/cn/iocoder/dashboard/framework/logger/operatelog/core/service/OperateLogFrameworkService.java

@@ -0,0 +1,14 @@
+package cn.iocoder.dashboard.framework.logger.operatelog.core.service;
+
+import cn.iocoder.dashboard.modules.system.controller.logger.vo.SysOperateLogCreateReqVO;
+
+public interface OperateLogFrameworkService {
+
+    /**
+     * 要不记录操作日志
+     *
+     * @param reqVO 操作日志请求
+     */
+    void createOperateLogAsync(SysOperateLogCreateReqVO reqVO);
+
+}

src/main/java/cn/iocoder/dashboard/framework/logger/package-info.java

@@ -5,6 +5,6 @@
  * 2. API 日志：包含两类
  *      2.1 API 访问日志：记录用户访问 API 的访问日志，定期归档历史日志。
  *      2.2 API 异常日志：记录用户访问 API 的系统异常，方便日常排查问题与告警。
- * 3. 通用 Logger 日志：将 {@link org.slf4j.Logger} 打印的日志，只满足大于等于 {@link org.slf4j.event.Level} 进行持久化，可以理解成简易的“日志中心”。
+ * 3. 通用 Logger 日志：将 {@link org.slf4j.Logger} 打印的日志，只满足大于等于配置的 {@link org.slf4j.event.Level} 进行持久化，可以理解成简易的“日志中心”。
  */
 package cn.iocoder.dashboard.framework.logger;

src/main/java/cn/iocoder/dashboard/framework/tracer/core/util/TracerUtils.java

@@ -0,0 +1,36 @@
+package cn.iocoder.dashboard.framework.tracer.core.util;
+
+import cn.hutool.core.util.StrUtil;
+import org.apache.skywalking.apm.toolkit.trace.TraceContext;
+
+import java.util.UUID;
+
+/**
+ * 链路追踪工具类
+ *
+ * @author 芋道源码
+ */
+public class TracerUtils {
+
+    /**
+     * 获得链路追踪编号
+     *
+     * 一般来说，通过链路追踪编号，可以将访问日志，错误日志，链路追踪日志，logger 打印日志等，结合在一起，从而进行排错。
+     *
+     * 默认情况下，我们使用 Apache SkyWalking 的 traceId 作为链路追踪编号。当然，可能会存在并未引入 Skywalking 的情况，此时使用 UUID 。
+     *
+     * @return 链路追踪编号
+     */
+    public static String getTraceId() {
+        // 通过 SkyWalking 获取链路编号
+        try {
+            String traceId = TraceContext.traceId();
+            if (StrUtil.isNotBlank(traceId)) {
+                return traceId;
+            }
+        } catch (Throwable ignore) {}
+        // TODO 芋艿 多次调用会问题
+        return UUID.randomUUID().toString();
+    }
+
+}

src/main/java/cn/iocoder/dashboard/framework/tracer/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * 链路追踪
+ *
+ * 主要目的，是生成全局的链路追踪编号
+ */
+package cn.iocoder.dashboard.framework.tracer;