【重构】V2 操作日志转正，基于注解的可使用变量、可以自定义函数的通用操作日志组件

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/logger/OperateLogApi.java

@@ -2,9 +2,8 @@ package cn.iocoder.yudao.module.system.api.logger;
 
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogCreateReqDTO;
-import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogV2CreateReqDTO;
-import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogV2PageReqDTO;
-import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogV2RespDTO;
+import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogPageReqDTO;
+import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogRespDTO;
 import jakarta.validation.Valid;
 
 /**
@@ -21,19 +20,12 @@ public interface OperateLogApi {
      */
     void createOperateLog(@Valid OperateLogCreateReqDTO createReqDTO);
 
-    /**
-     * 创建操作日志
-     *
-     * @param createReqDTO 请求
-     */
-    void createOperateLogV2(@Valid OperateLogV2CreateReqDTO createReqDTO);
-
     /**
      * 获取指定模块的指定数据的操作日志分页
      *
      * @param pageReqVO 请求
      * @return 操作日志分页
      */
-    PageResult<OperateLogV2RespDTO> getOperateLogPage(OperateLogV2PageReqDTO pageReqVO);
+    PageResult<OperateLogRespDTO> getOperateLogPage(OperateLogPageReqDTO pageReqVO);
 
 }

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/logger/dto/OperateLogCreateReqDTO.java

@@ -1,123 +1,84 @@
 package cn.iocoder.yudao.module.system.api.logger.dto;
 
-import lombok.Data;
-
+import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
 import jakarta.validation.constraints.NotEmpty;
 import jakarta.validation.constraints.NotNull;
-import java.time.LocalDateTime;
-import java.util.Map;
+import lombok.Data;
 
 /**
- * 操作日志创建 Request DTO
+ * 系统操作日志 Create Request DTO
+ *
+ * @author HUIHUI
  */
 @Data
 public class OperateLogCreateReqDTO {
 
     /**
      * 链路追踪编号
+     *
+     * 一般来说，通过链路追踪编号，可以将访问日志，错误日志，链路追踪日志，logger 打印日志等，结合在一起，从而进行排错。
      */
     private String traceId;
-
     /**
      * 用户编号
+     *
+     * 关联 MemberUserDO 的 id 属性，或者 AdminUserDO 的 id 属性
      */
     @NotNull(message = "用户编号不能为空")
     private Long userId;
     /**
      * 用户类型
+     *
+     * 关联 {@link  UserTypeEnum}
      */
     @NotNull(message = "用户类型不能为空")
     private Integer userType;
-
     /**
-     * 操作模块
+     * 操作模块类型
      */
-    @NotEmpty(message = "操作模块不能为空")
-    private String module;
-
+    @NotEmpty(message = "操作模块类型不能为空")
+    private String type;
     /**
      * 操作名
      */
-    @NotEmpty(message = "操作名")
-    private String name;
-
+    @NotEmpty(message = "操作名不能为空")
+    private String subType;
     /**
-     * 操作分类
+     * 操作模块业务编号
      */
-    @NotNull(message = "操作分类不能为空")
-    private Integer type;
-
+    @NotNull(message = "操作模块业务编号不能为空")
+    private Long bizId;
     /**
-     * 操作明细
+     * 操作内容，记录整个操作的明细
+     * 例如说，修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。
      */
-    private String content;
-
+    @NotEmpty(message = "操作内容不能为空")
+    private String action;
     /**
-     * 拓展字段
+     * 拓展字段，有些复杂的业务，需要记录一些字段 ( JSON 格式 )
+     * 例如说，记录订单编号，{ orderId: "1"}
      */
-    private Map<String, Object> exts;
+    private String extra;
 
     /**
      * 请求方法名
      */
     @NotEmpty(message = "请求方法名不能为空")
     private String requestMethod;
-
     /**
      * 请求地址
      */
     @NotEmpty(message = "请求地址不能为空")
     private String requestUrl;
-
     /**
      * 用户 IP
      */
     @NotEmpty(message = "用户 IP 不能为空")
     private String userIp;
-
     /**
-     * 浏览器 UserAgent
+     * 浏览器 UA
      */
-    @NotEmpty(message = "浏览器 UserAgent 不能为空")
+    @NotEmpty(message = "浏览器 UA 不能为空")
     private String userAgent;
 
-    /**
-     * Java 方法名
-     */
-    @NotEmpty(message = "Java 方法名不能为空")
-    private String javaMethod;
-
-    /**
-     * Java 方法的参数
-     */
-    private String javaMethodArgs;
-
-    /**
-     * 开始时间
-     */
-    @NotNull(message = "开始时间不能为空")
-    private LocalDateTime startTime;
-
-    /**
-     * 执行时长，单位：毫秒
-     */
-    @NotNull(message = "执行时长不能为空")
-    private Integer duration;
-
-    /**
-     * 结果码
-     */
-    @NotNull(message = "结果码不能为空")
-    private Integer resultCode;
-
-    /**
-     * 结果提示
-     */
-    private String resultMsg;
-
-    /**
-     * 结果数据
-     */
-    private String resultData;
-
 }

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/logger/dto/OperateLogPageReqDTO.java

@@ -9,12 +9,12 @@ import lombok.Data;
  * @author HUIHUI
  */
 @Data
-public class OperateLogV2PageReqDTO extends PageParam {
+public class OperateLogPageReqDTO extends PageParam {
 
     /**
      * 模块类型
      */
-    private String bizType;
+    private String type;
     /**
      * 模块数据编号
      */

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/logger/dto/OperateLogRespDTO.java

@@ -13,7 +13,7 @@ import java.time.LocalDateTime;
  * @author HUIHUI
  */
 @Data
-public class OperateLogV2RespDTO implements VO {
+public class OperateLogRespDTO implements VO {
 
     /**
      * 日志编号

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/logger/dto/OperateLogV2CreateReqDTO.java

@@ -1,84 +0,0 @@
-package cn.iocoder.yudao.module.system.api.logger.dto;
-
-import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
-import jakarta.validation.constraints.NotEmpty;
-import jakarta.validation.constraints.NotNull;
-import lombok.Data;
-
-/**
- * 系统操作日志 Create Request DTO
- *
- * @author HUIHUI
- */
-@Data
-public class OperateLogV2CreateReqDTO {
-
-    /**
-     * 链路追踪编号
-     *
-     * 一般来说，通过链路追踪编号，可以将访问日志，错误日志，链路追踪日志，logger 打印日志等，结合在一起，从而进行排错。
-     */
-    private String traceId;
-    /**
-     * 用户编号
-     *
-     * 关联 MemberUserDO 的 id 属性，或者 AdminUserDO 的 id 属性
-     */
-    @NotNull(message = "用户编号不能为空")
-    private Long userId;
-    /**
-     * 用户类型
-     *
-     * 关联 {@link  UserTypeEnum}
-     */
-    @NotNull(message = "用户类型不能为空")
-    private Integer userType;
-    /**
-     * 操作模块类型
-     */
-    @NotEmpty(message = "操作模块类型不能为空")
-    private String type;
-    /**
-     * 操作名
-     */
-    @NotEmpty(message = "操作名不能为空")
-    private String subType;
-    /**
-     * 操作模块业务编号
-     */
-    @NotNull(message = "操作模块业务编号不能为空")
-    private Long bizId;
-    /**
-     * 操作内容，记录整个操作的明细
-     * 例如说，修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。
-     */
-    @NotEmpty(message = "操作内容不能为空")
-    private String action;
-    /**
-     * 拓展字段，有些复杂的业务，需要记录一些字段 ( JSON 格式 )
-     * 例如说，记录订单编号，{ orderId: "1"}
-     */
-    private String extra;
-
-    /**
-     * 请求方法名
-     */
-    @NotEmpty(message = "请求方法名不能为空")
-    private String requestMethod;
-    /**
-     * 请求地址
-     */
-    @NotEmpty(message = "请求地址不能为空")
-    private String requestUrl;
-    /**
-     * 用户 IP
-     */
-    @NotEmpty(message = "用户 IP 不能为空")
-    private String userIp;
-    /**
-     * 浏览器 UA
-     */
-    @NotEmpty(message = "浏览器 UA 不能为空")
-    private String userAgent;
-
-}