最新公众号管理平台后端

joju-framework/joju-spring-boot-starter-biz-operatelog/joju-spring-boot-starter-biz-operatelog.iml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4" />

joju-framework/joju-spring-boot-starter-biz-operatelog/pom.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>com.jojubanking.boot</groupId>
+        <artifactId>joju-framework</artifactId>
+        <version>${revision}</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>joju-spring-boot-starter-biz-operatelog</artifactId>
+    <packaging>jar</packaging>
+
+    <name>${project.artifactId}</name>
+    <description>操作日志</description>
+    <url>https://www.jojubanking.com</url>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.jojubanking.boot</groupId>
+            <artifactId>joju-common</artifactId>
+        </dependency>
+
+        <!-- Spring 核心 -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-aop</artifactId>
+        </dependency>
+
+        <!-- Web 相关 -->
+        <dependency>
+            <groupId>com.jojubanking.boot</groupId>
+            <artifactId>joju-spring-boot-starter-web</artifactId>
+            <version>${revision}</version>
+            <scope>provided</scope>
+        </dependency>
+
+        <!-- 业务组件 -->
+        <dependency>
+            <groupId>com.jojubanking.boot</groupId>
+            <artifactId>joju-module-system-api</artifactId> <!-- 需要使用它，进行操作日志的记录 -->
+            <version>${revision}</version>
+        </dependency>
+
+        <!-- 工具类相关 -->
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
+    </dependencies>
+
+</project>

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/config/JojuOperateLogAutoConfiguration.java

@@ -0,0 +1,23 @@
+package com.jojubanking.boot.framework.operatelog.config;
+
+import com.jojubanking.boot.framework.operatelog.core.aop.OperateLogAspect;
+import com.jojubanking.boot.framework.operatelog.core.service.OperateLogFrameworkService;
+import com.jojubanking.boot.framework.operatelog.core.service.OperateLogFrameworkServiceImpl;
+import com.jojubanking.boot.module.system.api.logger.OperateLogApi;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class JojuOperateLogAutoConfiguration {
+
+    @Bean
+    public OperateLogAspect operateLogAspect() {
+        return new OperateLogAspect();
+    }
+
+    @Bean
+    public OperateLogFrameworkService operateLogFrameworkService(OperateLogApi operateLogApi) {
+        return new OperateLogFrameworkServiceImpl(operateLogApi);
+    }
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/annotations/OperateLog.java

@@ -0,0 +1,57 @@
+package com.jojubanking.boot.framework.operatelog.core.annotations;
+
+import com.jojubanking.boot.framework.operatelog.core.enums.OperateTypeEnum;
+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;
+
+/**
+ * 操作日志注解
+ *
+ * @author TW
+ */
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface OperateLog {
+
+    // ========== 模块字段 ==========
+
+    /**
+     * 操作模块
+     *
+     * 为空时，会尝试读取 {@link Api#value()} 属性
+     */
+    String module() default "";
+    /**
+     * 操作名
+     *
+     * 为空时，会尝试读取 {@link ApiOperation#value()} 属性
+     */
+    String name() default "";
+    /**
+     * 操作分类
+     *
+     * 实际并不是数组，因为枚举不能设置 null 作为默认值
+     */
+    OperateTypeEnum[] type() default {};
+
+    // ========== 开关字段 ==========
+
+    /**
+     * 是否记录操作日志
+     */
+    boolean enable() default true;
+    /**
+     * 是否记录方法参数
+     */
+    boolean logArgs() default true;
+    /**
+     * 是否记录方法结果的数据
+     */
+    boolean logResultData() default true;
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/aop/OperateLogAspect.java

@@ -0,0 +1,374 @@
+package com.jojubanking.boot.framework.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 com.jojubanking.boot.framework.common.enums.UserTypeEnum;
+import com.jojubanking.boot.framework.common.pojo.CommonResult;
+import com.jojubanking.boot.framework.common.util.json.JsonUtils;
+import com.jojubanking.boot.framework.common.util.monitor.TracerUtils;
+import com.jojubanking.boot.framework.common.util.servlet.ServletUtils;
+import com.jojubanking.boot.framework.operatelog.core.enums.OperateTypeEnum;
+import com.jojubanking.boot.framework.operatelog.core.service.OperateLog;
+import com.jojubanking.boot.framework.operatelog.core.service.OperateLogFrameworkService;
+import com.jojubanking.boot.framework.web.core.util.WebFrameworkUtils;
+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.validation.BindingResult;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+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 com.jojubanking.boot.framework.common.exception.enums.GlobalErrorCodeConstants.INTERNAL_SERVER_ERROR;
+import static com.jojubanking.boot.framework.common.exception.enums.GlobalErrorCodeConstants.SUCCESS;
+
+/**
+ * 拦截使用 @OperateLog 注解，如果满足条件，则生成操作日志。
+ * 满足如下任一条件，则会进行记录：
+ * 1. 使用 @ApiOperation + 非 @GetMapping
+ * 2. 使用 @OperateLog 注解
+ * <p>
+ * 但是，如果声明 @OperateLog 注解时，将 enable 属性设置为 false 时，强制不记录。
+ *
+ * @author TW
+ */
+@Aspect
+@Slf4j
+public class OperateLogAspect {
+
+    /**
+     * 用于记录操作内容的上下文
+     *
+     * @see OperateLog#getContent()
+     */
+    private static final ThreadLocal<String> CONTENT = new ThreadLocal<>();
+    /**
+     * 用于记录拓展字段的上下文
+     *
+     * @see OperateLog#getExts()
+     */
+    private static final ThreadLocal<Map<String, Object>> EXTS = new ThreadLocal<>();
+
+    @Resource
+    private OperateLogFrameworkService operateLogFrameworkService;
+
+    @Around("@annotation(apiOperation)")
+    public Object around(ProceedingJoinPoint joinPoint, ApiOperation apiOperation) throws Throwable {
+        // 可能也添加了 @ApiOperation 注解
+        com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog operateLog = getMethodAnnotation(joinPoint,
+                com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog.class);
+        return around0(joinPoint, operateLog, apiOperation);
+    }
+
+    @Around("!@annotation(io.swagger.annotations.ApiOperation) && @annotation(operateLog)")
+    // 兼容处理，只添加 @OperateLog 注解的情况
+    public Object around(ProceedingJoinPoint joinPoint,
+                         com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog operateLog) throws Throwable {
+        return around0(joinPoint, operateLog, null);
+    }
+
+    private Object around0(ProceedingJoinPoint joinPoint,
+                           com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog operateLog,
+                           ApiOperation apiOperation) throws Throwable {
+        // 目前，只有管理员，才记录操作日志！所以非管理员，直接调用，不进行记录
+        Integer userType = WebFrameworkUtils.getLoginUserType();
+        if (!Objects.equals(userType, UserTypeEnum.ADMIN.getValue())) {
+            return joinPoint.proceed();
+        }
+
+        // 记录开始时间
+        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;
+        } finally {
+            clearThreadLocal();
+        }
+    }
+
+    public static void setContent(String content) {
+        CONTENT.set(content);
+    }
+
+    public static void addExt(String key, Object value) {
+        if (EXTS.get() == null) {
+            EXTS.set(new HashMap<>());
+        }
+        EXTS.get().put(key, value);
+    }
+
+    private static void clearThreadLocal() {
+        CONTENT.remove();
+        EXTS.remove();
+    }
+
+    private void log(ProceedingJoinPoint joinPoint,
+                     com.jojubanking.boot.framework.operatelog.core.annotations.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,
+                      com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog operateLog,
+                      ApiOperation apiOperation,
+                      Date startTime, Object result, Throwable exception) {
+        OperateLog operateLogObj = new OperateLog();
+        // 补全通用字段
+        operateLogObj.setTraceId(TracerUtils.getTraceId());
+        operateLogObj.setStartTime(startTime);
+        // 补充用户信息
+        fillUserFields(operateLogObj);
+        // 补全模块信息
+        fillModuleFields(operateLogObj, joinPoint, operateLog, apiOperation);
+        // 补全请求信息
+        fillRequestFields(operateLogObj);
+        // 补全方法信息
+        fillMethodFields(operateLogObj, joinPoint, operateLog, startTime, result, exception);
+
+        // 异步记录日志
+        operateLogFrameworkService.createOperateLog(operateLogObj);
+    }
+
+    private static void fillUserFields(OperateLog operateLogObj) {
+        operateLogObj.setUserId(WebFrameworkUtils.getLoginUserId());
+        operateLogObj.setUserType(WebFrameworkUtils.getLoginUserType());
+    }
+
+    private static void fillModuleFields(OperateLog operateLogObj,
+                                         ProceedingJoinPoint joinPoint,
+                                         com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog operateLog,
+                                         ApiOperation apiOperation) {
+        // module 属性
+        if (operateLog != null) {
+            operateLogObj.setModule(operateLog.module());
+        }
+        if (StrUtil.isEmpty(operateLogObj.getModule())) {
+            Api api = getClassAnnotation(joinPoint, Api.class);
+            if (api != null) {
+                // 优先读取 @API 的 name 属性
+                if (StrUtil.isNotEmpty(api.value())) {
+                    operateLogObj.setModule(api.value());
+                }
+                // 没有的话，读取 @API 的 tags 属性
+                if (StrUtil.isEmpty(operateLogObj.getModule()) && ArrayUtil.isNotEmpty(api.tags())) {
+                    operateLogObj.setModule(api.tags()[0]);
+                }
+            }
+        }
+        // name 属性
+        if (operateLog != null) {
+            operateLogObj.setName(operateLog.name());
+        }
+        if (StrUtil.isEmpty(operateLogObj.getName()) && apiOperation != null) {
+            operateLogObj.setName(apiOperation.value());
+        }
+        // type 属性
+        if (operateLog != null && ArrayUtil.isNotEmpty(operateLog.type())) {
+            operateLogObj.setType(operateLog.type()[0].getType());
+        }
+        if (operateLogObj.getType() == null) {
+            RequestMethod requestMethod = obtainFirstMatchRequestMethod(obtainRequestMethod(joinPoint));
+            OperateTypeEnum operateLogType = convertOperateLogType(requestMethod);
+            operateLogObj.setType(operateLogType != null ? operateLogType.getType() : null);
+        }
+        // content 和 exts 属性
+        operateLogObj.setContent(CONTENT.get());
+        operateLogObj.setExts(EXTS.get());
+    }
+
+    private static void fillRequestFields(OperateLog operateLogObj) {
+        // 获得 Request 对象
+        HttpServletRequest request = ServletUtils.getRequest();
+        if (request == null) {
+            return;
+        }
+        // 补全请求信息
+        operateLogObj.setRequestMethod(request.getMethod());
+        operateLogObj.setRequestUrl(request.getRequestURI());
+        operateLogObj.setUserIp(ServletUtil.getClientIP(request));
+        operateLogObj.setUserAgent(ServletUtils.getUserAgent(request));
+    }
+
+    private static void fillMethodFields(OperateLog operateLogObj,
+                                         ProceedingJoinPoint joinPoint,
+                                         com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog operateLog,
+                                         Date startTime, Object result, Throwable exception) {
+        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
+        operateLogObj.setJavaMethod(methodSignature.toString());
+        if (operateLog == null || operateLog.logArgs()) {
+            operateLogObj.setJavaMethodArgs(obtainMethodArgs(joinPoint));
+        }
+        if (operateLog == null || operateLog.logResultData()) {
+            operateLogObj.setResultData(obtainResultData(result));
+        }
+        operateLogObj.setDuration((int) (System.currentTimeMillis() - startTime.getTime()));
+        // （正常）处理 resultCode 和 resultMsg 字段
+        if (result instanceof CommonResult) {
+            CommonResult<?> commonResult = (CommonResult<?>) result;
+            operateLogObj.setResultCode(commonResult.getCode());
+            operateLogObj.setResultMsg(commonResult.getMsg());
+        } else {
+            operateLogObj.setResultCode(SUCCESS.getCode());
+        }
+        // （异常）处理 resultCode 和 resultMsg 字段
+        if (exception != null) {
+            operateLogObj.setResultCode(INTERNAL_SERVER_ERROR.getCode());
+            operateLogObj.setResultMsg(ExceptionUtil.getRootCauseMessage(exception));
+        }
+    }
+
+    private static boolean isLogEnable(ProceedingJoinPoint joinPoint,
+                                       com.jojubanking.boot.framework.operatelog.core.annotations.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 OperateTypeEnum convertOperateLogType(RequestMethod requestMethod) {
+        if (requestMethod == null) {
+            return null;
+        }
+        switch (requestMethod) {
+            case GET:
+                return OperateTypeEnum.GET;
+            case POST:
+                return OperateTypeEnum.CREATE;
+            case PUT:
+                return OperateTypeEnum.UPDATE;
+            case DELETE:
+                return OperateTypeEnum.DELETE;
+            default:
+                return OperateTypeEnum.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 String 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 JsonUtils.toJsonString(args);
+    }
+
+    private static String obtainResultData(Object result) {
+        // TODO 提升：结果脱敏和忽略
+        if (result instanceof CommonResult) {
+            result = ((CommonResult<?>) result).getData();
+        }
+        return JsonUtils.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>) OperateLogAspect::isIgnoreArgs);
+        }
+        if (Map.class.isAssignableFrom(clazz)) {
+            return isIgnoreArgs(((Map<?, ?>) object).values());
+        }
+        // obj
+        return object instanceof MultipartFile
+                || object instanceof HttpServletRequest
+                || object instanceof HttpServletResponse
+                || object instanceof BindingResult;
+    }
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/enums/OperateTypeEnum.java

@@ -0,0 +1,55 @@
+package com.jojubanking.boot.framework.operatelog.core.enums;
+
+import com.jojubanking.boot.framework.operatelog.core.annotations.OperateLog;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+/**
+ * 操作日志的操作类型
+ *
+ * @author ruoyi
+ */
+@Getter
+@AllArgsConstructor
+public enum OperateTypeEnum {
+
+    /**
+     * 查询
+     *
+     * 绝大多数情况下，不会记录查询动作，因为过于大量显得没有意义。
+     * 在有需要的时候，通过声明 {@link OperateLog} 注解来记录
+     */
+    GET(1),
+    /**
+     * 新增
+     */
+    CREATE(2),
+    /**
+     * 修改
+     */
+    UPDATE(3),
+    /**
+     * 删除
+     */
+    DELETE(4),
+    /**
+     * 导出
+     */
+    EXPORT(5),
+    /**
+     * 导入
+     */
+    IMPORT(6),
+    /**
+     * 其它
+     *
+     * 在无法归类时，可以选择使用其它。因为还有操作名可以进一步标识
+     */
+    OTHER(0);
+
+    /**
+     * 类型
+     */
+    private final Integer type;
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/package-info.java

@@ -0,0 +1 @@
+package com.jojubanking.boot.framework.operatelog.core;

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/service/OperateLog.java

@@ -0,0 +1,110 @@
+package com.jojubanking.boot.framework.operatelog.core.service;
+
+import lombok.Data;
+
+import java.util.Date;
+import java.util.Map;
+
+/**
+ * 操作日志
+ *
+ * @author TW
+ */
+@Data
+public class OperateLog {
+
+    /**
+     * 链路追踪编号
+     */
+    private String traceId;
+
+    /**
+     * 用户编号
+     */
+    private Long userId;
+    /**
+     * 用户类型
+     */
+    private Integer userType;
+
+    /**
+     * 操作模块
+     */
+    private String module;
+
+    /**
+     * 操作名
+     */
+    private String name;
+
+    /**
+     * 操作分类
+     */
+    private Integer type;
+
+    /**
+     * 操作明细
+     */
+    private String content;
+
+    /**
+     * 拓展字段
+     */
+    private Map<String, Object> exts;
+
+    /**
+     * 请求方法名
+     */
+    private String requestMethod;
+
+    /**
+     * 请求地址
+     */
+    private String requestUrl;
+
+    /**
+     * 用户 IP
+     */
+    private String userIp;
+
+    /**
+     * 浏览器 UserAgent
+     */
+    private String userAgent;
+
+    /**
+     * Java 方法名
+     */
+    private String javaMethod;
+
+    /**
+     * Java 方法的参数
+     */
+    private String javaMethodArgs;
+
+    /**
+     * 开始时间
+     */
+    private Date startTime;
+
+    /**
+     * 执行时长，单位：毫秒
+     */
+    private Integer duration;
+
+    /**
+     * 结果码
+     */
+    private Integer resultCode;
+
+    /**
+     * 结果提示
+     */
+    private String resultMsg;
+
+    /**
+     * 结果数据
+     */
+    private String resultData;
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/service/OperateLogFrameworkService.java

@@ -0,0 +1,17 @@
+package com.jojubanking.boot.framework.operatelog.core.service;
+
+/**
+ * 操作日志 Framework Service 接口
+ *
+ * @author TW
+ */
+public interface OperateLogFrameworkService {
+
+    /**
+     * 记录操作日志
+     *
+     * @param operateLog 操作日志请求
+     */
+    void createOperateLog(OperateLog operateLog);
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/service/OperateLogFrameworkServiceImpl.java

@@ -0,0 +1,28 @@
+package com.jojubanking.boot.framework.operatelog.core.service;
+
+import cn.hutool.core.bean.BeanUtil;
+import com.jojubanking.boot.module.system.api.logger.OperateLogApi;
+import com.jojubanking.boot.module.system.api.logger.dto.OperateLogCreateReqDTO;
+import lombok.RequiredArgsConstructor;
+import org.springframework.scheduling.annotation.Async;
+
+/**
+ * 操作日志 Framework Service 实现类
+ *
+ * 基于 {@link OperateLogApi} 实现，记录操作日志
+ *
+ * @author TW
+ */
+@RequiredArgsConstructor
+public class OperateLogFrameworkServiceImpl implements OperateLogFrameworkService {
+
+    private final OperateLogApi operateLogApi;
+
+    @Override
+    @Async
+    public void createOperateLog(OperateLog operateLog) {
+        OperateLogCreateReqDTO reqDTO = BeanUtil.copyProperties(operateLog, OperateLogCreateReqDTO.class);
+        operateLogApi.createOperateLog(reqDTO);
+    }
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/core/util/OperateLogUtils.java

@@ -0,0 +1,21 @@
+package com.jojubanking.boot.framework.operatelog.core.util;
+
+import com.jojubanking.boot.framework.operatelog.core.aop.OperateLogAspect;
+
+/**
+ * 操作日志工具类
+ * 目前主要的作用，是提供给业务代码，记录操作明细和拓展字段
+ *
+ * @author TW
+ */
+public class OperateLogUtils {
+
+    public static void setContent(String content) {
+        OperateLogAspect.setContent(content);
+    }
+
+    public static void addExt(String key, Object value) {
+        OperateLogAspect.addExt(key, value);
+    }
+
+}

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/java/com/jojubanking/boot/framework/operatelog/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * 用户操作日志：记录用户的操作，用于对用户的操作的审计与追溯，永久保存。
+ *
+ * @author TW
+ */
+package com.jojubanking.boot.framework.operatelog;

joju-framework/joju-spring-boot-starter-biz-operatelog/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+  com.jojubanking.boot.framework.operatelog.config.JojuOperateLogAutoConfiguration

joju-framework/joju-spring-boot-starter-biz-operatelog/target/classes/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+  com.jojubanking.boot.framework.operatelog.config.JojuOperateLogAutoConfiguration

joju-framework/joju-spring-boot-starter-biz-operatelog/target/maven-archiver/pom.properties

@@ -0,0 +1,5 @@
+#Generated by Maven
+#Wed Jan 14 17:48:05 CST 2026
+version=2.0.0-beta
+groupId=com.jojubanking.boot
+artifactId=joju-spring-boot-starter-biz-operatelog

joju-framework/joju-spring-boot-starter-biz-operatelog/target/maven-status/maven-compiler-plugin/compile/default-compile/createdFiles.lst

@@ -0,0 +1,9 @@
+com\jojubanking\boot\framework\operatelog\core\annotations\OperateLog.class
+com\jojubanking\boot\framework\operatelog\core\service\OperateLogFrameworkServiceImpl.class
+com\jojubanking\boot\framework\operatelog\config\JojuOperateLogAutoConfiguration.class
+com\jojubanking\boot\framework\operatelog\core\service\OperateLogFrameworkService.class
+com\jojubanking\boot\framework\operatelog\core\enums\OperateTypeEnum.class
+com\jojubanking\boot\framework\operatelog\core\util\OperateLogUtils.class
+com\jojubanking\boot\framework\operatelog\core\aop\OperateLogAspect$1.class
+com\jojubanking\boot\framework\operatelog\core\aop\OperateLogAspect.class
+com\jojubanking\boot\framework\operatelog\core\service\OperateLog.class

joju-framework/joju-spring-boot-starter-biz-operatelog/target/maven-status/maven-compiler-plugin/compile/default-compile/inputFiles.lst

@@ -0,0 +1,10 @@
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\package-info.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\service\OperateLog.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\service\OperateLogFrameworkService.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\service\OperateLogFrameworkServiceImpl.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\package-info.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\config\JojuOperateLogAutoConfiguration.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\util\OperateLogUtils.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\enums\OperateTypeEnum.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\annotations\OperateLog.java
+D:\workspace\nxwj\掌医管理平台\jojuboot\joju-framework\joju-spring-boot-starter-biz-operatelog\src\main\java\com\jojubanking\boot\framework\operatelog\core\aop\OperateLogAspect.java