Merge remote-tracking branch 'origin/develop' into develop

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

@@ -1,18 +1,21 @@
 package cn.iocoder.yudao.module.system.api.logger;
 
 import cn.hutool.core.collection.CollUtil;
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
 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.dal.dataobject.logger.OperateLogV2DO;
 import cn.iocoder.yudao.module.system.dal.dataobject.user.AdminUserDO;
 import cn.iocoder.yudao.module.system.service.logger.OperateLogService;
 import cn.iocoder.yudao.module.system.service.user.AdminUserService;
 import jakarta.annotation.Resource;
+import org.springframework.scheduling.annotation.Async;
 import org.springframework.stereotype.Service;
 import org.springframework.validation.annotation.Validated;
 
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
@@ -39,21 +42,31 @@ public class OperateLogApiImpl implements OperateLogApi {
     }
 
     @Override
-    public List<OperateLogV2RespDTO> getOperateLogByModuleAndBizId(String module, Long bizId) {
-        List<OperateLogV2DO> logList = operateLogService.getOperateLogByModuleAndBizId(module, bizId);
-        if (CollUtil.isEmpty(logList)) {
-            return Collections.emptyList();
+    @Async
+    public void createOperateLogV2(OperateLogV2CreateReqDTO createReqDTO) {
+        operateLogService.createOperateLogV2(createReqDTO);
+    }
+
+    @Override
+    public PageResult<OperateLogV2RespDTO> getOperateLogPage(OperateLogV2PageReqDTO pageReqVO) {
+        PageResult<OperateLogV2DO> operateLogPage = operateLogService.getOperateLogPage(pageReqVO);
+        if (CollUtil.isEmpty(operateLogPage.getList())) {
+            return PageResult.empty();
         }
 
         // 获取用户
-        List<AdminUserDO> userList = adminUserService.getUserList(convertSet(logList, item -> Long.parseLong(item.getCreator())));
+        List<AdminUserDO> userList = adminUserService.getUserList(convertSet(operateLogPage.getList(), OperateLogV2DO::getUserId));
+        return BeanUtils.toBean(operateLogPage, OperateLogV2RespDTO.class).setList(setUserInfo(operateLogPage.getList(), userList));
+    }
+
+    private static List<OperateLogV2RespDTO> setUserInfo(List<OperateLogV2DO> logList, List<AdminUserDO> userList) {
         Map<Long, AdminUserDO> userMap = convertMap(userList, AdminUserDO::getId);
         return convertList(logList, item -> {
-            OperateLogV2RespDTO bean = BeanUtils.toBean(item, OperateLogV2RespDTO.class);
-            findAndThen(userMap, Long.parseLong(item.getCreator()), user -> {
-                bean.setCreatorName(user.getNickname());
+            OperateLogV2RespDTO respDTO = BeanUtils.toBean(item, OperateLogV2RespDTO.class);
+            findAndThen(userMap, item.getUserId(), user -> {
+                respDTO.setUserName(user.getNickname());
             });
-            return bean;
+            return respDTO;
         });
     }
 

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/dal/dataobject/logger/OperateLogV2DO.java

@@ -1,13 +1,19 @@
 package cn.iocoder.yudao.module.system.dal.dataobject.logger;
 
 import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
+import cn.iocoder.yudao.framework.common.pojo.CommonResult;
 import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
 import com.baomidou.mybatisplus.annotation.KeySequence;
+import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
+import java.time.LocalDateTime;
+import java.util.Map;
+
 /**
  * 操作日志表 V2
  *
@@ -19,6 +25,16 @@ import lombok.EqualsAndHashCode;
 @EqualsAndHashCode(callSuper = true)
 public class OperateLogV2DO extends BaseDO {
 
+    /**
+     * {@link #javaMethodArgs} 的最大长度
+     */
+    public static final Integer JAVA_METHOD_ARGS_MAX_LENGTH = 8000;
+
+    /**
+     * {@link #resultData} 的最大长度
+     */
+    public static final Integer RESULT_MAX_LENGTH = 4000;
+
     /**
      * 日志主键
      */
@@ -42,15 +58,14 @@ public class OperateLogV2DO extends BaseDO {
      * 关联 {@link  UserTypeEnum}
      */
     private Integer userType;
-    // TODO @puhui999：module 改成 type，name 改成 subType；
     /**
-     * 操作模块
+     * 操作模块类型
      */
-    private String module;
+    private String type;
     /**
      * 操作名
      */
-    private String name;
+    private String subType;
     /**
      * 操作模块业务编号
      */
@@ -66,8 +81,8 @@ public class OperateLogV2DO extends BaseDO {
      *
      * 例如说，记录订单编号，{ orderId: "1"}
      */
-    // TODO @puhui999：看看能不能类似 exts 搞 json 格式；
-    private String extra;
+    @TableField(typeHandler = JacksonTypeHandler.class)
+    private Map<String, Object> extra;
     /**
      * 请求方法名
      */
@@ -85,9 +100,43 @@ public class OperateLogV2DO extends BaseDO {
      */
     private String userAgent;
 
-    // TODO @芋艿：requestUrl、requestMethod
-    // TODO @芋艿：javaMethod、javaMethodArgs
-    // TODO @芋艿：startTime、duration
-    // TODO @芋艿：resultMsg、resultData
+    /**
+     * Java 方法名
+     */
+    private String javaMethod;
+    /**
+     * Java 方法的参数
+     *
+     * 实际格式为 Map<String, Object>
+     * 不使用 @TableField(typeHandler = FastjsonTypeHandler.class) 注解的原因是，数据库存储有长度限制，会进行裁剪，会导致 JSON 反序列化失败
+     * 其中，key 为参数名，value 为参数值
+     */
+    private String javaMethodArgs;
+    /**
+     * 开始时间
+     */
+    private LocalDateTime startTime;
+    /**
+     * 执行时长，单位：毫秒
+     */
+    private Integer duration;
+    /**
+     * 结果码
+     *
+     * 目前使用的 {@link CommonResult#getCode()} 属性
+     */
+    private Integer resultCode;
+    /**
+     * 结果提示
+     *
+     * 目前使用的 {@link CommonResult#getMsg()} 属性
+     */
+    private String resultMsg;
+    /**
+     * 结果数据
+     *
+     * 如果是对象，则使用 JSON 格式化
+     */
+    private String resultData;
 
 }

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/dal/mysql/logger/OperateLogV2Mapper.java

@@ -3,28 +3,18 @@ package cn.iocoder.yudao.module.system.dal.mysql.logger;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.mybatis.core.mapper.BaseMapperX;
 import cn.iocoder.yudao.framework.mybatis.core.query.LambdaQueryWrapperX;
-import cn.iocoder.yudao.module.system.controller.admin.logger.vo.operatelog.OperateLogPageReqVO;
+import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogV2PageReqDTO;
 import cn.iocoder.yudao.module.system.dal.dataobject.logger.OperateLogV2DO;
 import org.apache.ibatis.annotations.Mapper;
 
-import java.util.Collection;
-import java.util.List;
-
 @Mapper
 public interface OperateLogV2Mapper extends BaseMapperX<OperateLogV2DO> {
 
-    default PageResult<OperateLogV2DO> selectPage(OperateLogPageReqVO reqVO, Collection<Long> userIds) {
-        LambdaQueryWrapperX<OperateLogV2DO> query = new LambdaQueryWrapperX<OperateLogV2DO>()
-                .likeIfPresent(OperateLogV2DO::getModule, reqVO.getModule())
-                .inIfPresent(OperateLogV2DO::getUserId, userIds);
-        query.orderByDesc(OperateLogV2DO::getId); // 降序
-        return selectPage(reqVO, query);
-    }
-
-    default List<OperateLogV2DO> selectListByModuleAndBizId(String module, Long bizId) {
-        return selectList(new LambdaQueryWrapperX<OperateLogV2DO>()
-                .eq(OperateLogV2DO::getModule, module)
-                .eq(OperateLogV2DO::getBizId, bizId)
+    default PageResult<OperateLogV2DO> selectPage(OperateLogV2PageReqDTO pageReqVO) {
+        return selectPage(pageReqVO, new LambdaQueryWrapperX<OperateLogV2DO>()
+                .eqIfPresent(OperateLogV2DO::getType, pageReqVO.getBizType())
+                .eqIfPresent(OperateLogV2DO::getBizId, pageReqVO.getBizId())
+                .eqIfPresent(OperateLogV2DO::getUserId, pageReqVO.getUserId())
                 .orderByDesc(OperateLogV2DO::getCreateTime));
     }
 

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/bizlog/config/YudaoOperateLogV2Configuration.java

@@ -1,16 +0,0 @@
-package cn.iocoder.yudao.module.system.framework.bizlog.config;
-
-import com.mzt.logapi.starter.annotation.EnableLogRecord;
-import org.springframework.context.annotation.Configuration;
-
-// TODO @puhui999：挪到 yudao-spring-boot-starter-biz-operatelog 下，搞个 cn.iocoder.yudao.framework.operatelogv2；跑通后，我们直接就删除老的实现了；
-/**
- * mzt-biz-log 配置类
- *
- * @author HUIHUI
- */
-@Configuration(proxyBeanMethods = false)
-@EnableLogRecord(tenant = "") // 貌似用不上 tenant 这玩意给个空好啦
-public class YudaoOperateLogV2Configuration {
-
-}

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/bizlog/package-info.java

@@ -1 +0,0 @@
-package cn.iocoder.yudao.module.system.framework.bizlog;

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/bizlog/service/ILogRecordServiceImpl.java

@@ -1,85 +0,0 @@
-package cn.iocoder.yudao.module.system.framework.bizlog.service;
-
-import cn.iocoder.yudao.framework.common.util.monitor.TracerUtils;
-import cn.iocoder.yudao.framework.common.util.servlet.ServletUtils;
-import cn.iocoder.yudao.framework.web.core.util.WebFrameworkUtils;
-import cn.iocoder.yudao.module.system.service.logger.OperateLogService;
-import cn.iocoder.yudao.module.system.service.logger.bo.OperateLogV2CreateReqBO;
-import com.mzt.logapi.beans.LogRecord;
-import com.mzt.logapi.service.ILogRecordService;
-import jakarta.annotation.Resource;
-import jakarta.servlet.http.HttpServletRequest;
-import lombok.extern.slf4j.Slf4j;
-import org.springframework.stereotype.Service;
-
-import java.util.Collections;
-import java.util.List;
-
-// TODO @puhui999：这个应该搞到 operatelog 组件里哈；
-/**
- * 操作日志 ILogRecordService 实现类
- *
- * 基于 {@link OperateLogService} 实现，记录操作日志
- *
- * @author HUIHUI
- */
-@Slf4j
-@Service
-public class ILogRecordServiceImpl implements ILogRecordService {
-
-    @Resource
-    private OperateLogService operateLogService;
-
-    @Override
-    public void record(LogRecord logRecord) {
-        OperateLogV2CreateReqBO reqBO = new OperateLogV2CreateReqBO();
-        // 补全通用字段
-        reqBO.setTraceId(TracerUtils.getTraceId());
-        // 补充用户信息
-        fillUserFields(reqBO);
-        // 补全模块信息
-        fillModuleFields(reqBO, logRecord);
-        // 补全请求信息
-        fillRequestFields(reqBO);
-        // 异步记录日志
-        operateLogService.createOperateLogV2(reqBO);
-        log.info("操作日志 ===> {}", reqBO);
-    }
-
-    private static void fillUserFields(OperateLogV2CreateReqBO reqBO) {
-        reqBO.setUserId(WebFrameworkUtils.getLoginUserId());
-        reqBO.setUserType(WebFrameworkUtils.getLoginUserType());
-    }
-
-    public static void fillModuleFields(OperateLogV2CreateReqBO reqBO, LogRecord logRecord) {
-        reqBO.setModule(logRecord.getType()); // 大模块类型如 crm-客户
-        reqBO.setName(logRecord.getSubType());// 操作名称如 转移客户
-        reqBO.setBizId(Long.parseLong(logRecord.getBizNo())); // 操作模块业务编号
-        reqBO.setContent(logRecord.getAction());// 例如说，修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。
-        reqBO.setExtra(logRecord.getExtra()); // 拓展字段，有些复杂的业务，需要记录一些字段 ( JSON 格式 )，例如说，记录订单编号，{ orderId: "1"}
-    }
-
-    private static void fillRequestFields(OperateLogV2CreateReqBO reqBO) {
-        // 获得 Request 对象
-        HttpServletRequest request = ServletUtils.getRequest();
-        if (request == null) {
-            return;
-        }
-        // 补全请求信息
-        reqBO.setRequestMethod(request.getMethod());
-        reqBO.setRequestUrl(request.getRequestURI());
-        reqBO.setUserIp(ServletUtils.getClientIP(request));
-        reqBO.setUserAgent(ServletUtils.getUserAgent(request));
-    }
-
-    @Override
-    public List<LogRecord> queryLog(String bizNo, String type) {
-        return Collections.emptyList();
-    }
-
-    @Override
-    public List<LogRecord> queryLogByBizNo(String bizNo, String type, String subType) {
-        return Collections.emptyList();
-    }
-
-}

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/operatelog/package-info.java

@@ -0,0 +1 @@
+package cn.iocoder.yudao.module.system.framework.operatelog;

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/operatelog/parse/AdminUserParseFunction.java

@@ -1,4 +1,4 @@
-package cn.iocoder.yudao.module.system.framework.bizlog.function;
+package cn.iocoder.yudao.module.system.framework.operatelog.parse;
 
 import cn.hutool.core.util.ObjUtil;
 import cn.hutool.core.util.StrUtil;

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/framework/operatelog/parse/AreaParseFunction.java

@@ -1,4 +1,4 @@
-package cn.iocoder.yudao.module.system.framework.bizlog.function;
+package cn.iocoder.yudao.module.system.framework.operatelog.parse;
 
 import cn.hutool.core.util.StrUtil;
 import cn.iocoder.yudao.framework.ip.core.utils.AreaUtils;

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/logger/OperateLogService.java

@@ -2,12 +2,11 @@ package cn.iocoder.yudao.module.system.service.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.controller.admin.logger.vo.operatelog.OperateLogPageReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.logger.OperateLogDO;
 import cn.iocoder.yudao.module.system.dal.dataobject.logger.OperateLogV2DO;
-import cn.iocoder.yudao.module.system.service.logger.bo.OperateLogV2CreateReqBO;
-
-import java.util.List;
 
 /**
  * 操作日志 Service 接口
@@ -38,16 +37,14 @@ public interface OperateLogService {
      *
      * @param createReqBO 创建请求
      */
-    void createOperateLogV2(OperateLogV2CreateReqBO createReqBO);
+    void createOperateLogV2(OperateLogV2CreateReqDTO createReqBO);
 
-    // TODO @puhui999：module 改成 type
     /**
-     * 获取指定模块的指定数据的操作日志
+     * 获得操作日志分页列表
      *
-     * @param module 操作模块
-     * @param bizId  操作模块编号
-     * @return 操作日志
+     * @param pageReqVO 分页条件
+     * @return 操作日志分页列表
      */
-    List<OperateLogV2DO> getOperateLogByModuleAndBizId(String module, Long bizId);
+    PageResult<OperateLogV2DO> getOperateLogPage(OperateLogV2PageReqDTO pageReqVO);
 
 }

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/logger/OperateLogServiceImpl.java

@@ -6,13 +6,14 @@ import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
 import cn.iocoder.yudao.framework.common.util.string.StrUtils;
 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.controller.admin.logger.vo.operatelog.OperateLogPageReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.logger.OperateLogDO;
 import cn.iocoder.yudao.module.system.dal.dataobject.logger.OperateLogV2DO;
 import cn.iocoder.yudao.module.system.dal.dataobject.user.AdminUserDO;
 import cn.iocoder.yudao.module.system.dal.mysql.logger.OperateLogMapper;
 import cn.iocoder.yudao.module.system.dal.mysql.logger.OperateLogV2Mapper;
-import cn.iocoder.yudao.module.system.service.logger.bo.OperateLogV2CreateReqBO;
 import cn.iocoder.yudao.module.system.service.user.AdminUserService;
 import jakarta.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
@@ -20,7 +21,6 @@ import org.springframework.stereotype.Service;
 import org.springframework.validation.annotation.Validated;
 
 import java.util.Collection;
-import java.util.List;
 
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
 import static cn.iocoder.yudao.module.system.dal.dataobject.logger.OperateLogDO.JAVA_METHOD_ARGS_MAX_LENGTH;
@@ -69,14 +69,17 @@ public class OperateLogServiceImpl implements OperateLogService {
     // ======================= LOG V2 =======================
 
     @Override
-    public void createOperateLogV2(OperateLogV2CreateReqBO createReqBO) {
+    public void createOperateLogV2(OperateLogV2CreateReqDTO createReqBO) {
         OperateLogV2DO log = BeanUtils.toBean(createReqBO, OperateLogV2DO.class);
+        log.setJavaMethodArgs(StrUtils.maxLength(log.getJavaMethodArgs(), JAVA_METHOD_ARGS_MAX_LENGTH));
+        log.setResultData(StrUtils.maxLength(log.getResultData(), RESULT_MAX_LENGTH));
         operateLogV2Mapper.insert(log);
     }
 
+
     @Override
-    public List<OperateLogV2DO> getOperateLogByModuleAndBizId(String module, Long bizId) {
-        return operateLogV2Mapper.selectListByModuleAndBizId(module, bizId);
+    public PageResult<OperateLogV2DO> getOperateLogPage(OperateLogV2PageReqDTO pageReqVO) {
+        return operateLogV2Mapper.selectPage(pageReqVO);
     }
 
 }

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/logger/bo/OperateLogV2CreateReqBO.java

@@ -1,83 +0,0 @@
-package cn.iocoder.yudao.module.system.service.logger.bo;
-
-import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
-import jakarta.validation.constraints.NotEmpty;
-import lombok.Data;
-
-/**
- * 系统操作日志 Create Req BO
- *
- * @author HUIHUI
- */
-@Data
-public class OperateLogV2CreateReqBO {
-
-    /**
-     * 链路追踪编号
-     *
-     * 一般来说，通过链路追踪编号，可以将访问日志，错误日志，链路追踪日志，logger 打印日志等，结合在一起，从而进行排错。
-     */
-    private String traceId;
-    /**
-     * 用户编号
-     *
-     * 关联 MemberUserDO 的 id 属性，或者 AdminUserDO 的 id 属性
-     */
-    @NotEmpty(message = "用户编号不能为空")
-    private Long userId;
-    /**
-     * 用户类型
-     *
-     * 关联 {@link  UserTypeEnum}
-     */
-    @NotEmpty(message = "用户类型不能为空")
-    private Integer userType;
-    /**
-     * 操作模块
-     */
-    @NotEmpty(message = "操作模块不能为空")
-    private String module;
-    /**
-     * 操作名
-     */
-    @NotEmpty(message = "操作名不能为空")
-    private String name;
-    /**
-     * 操作模块业务编号
-     */
-    @NotEmpty(message = "操作模块业务编号不能为空")
-    private Long bizId;
-    /**
-     * 操作内容，记录整个操作的明细
-     * 例如说，修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。
-     */
-    @NotEmpty(message = "操作内容不能为空")
-    private String content;
-    /**
-     * 拓展字段，有些复杂的业务，需要记录一些字段 ( 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;
-
-}