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

yudao-module-system/yudao-module-system-biz/src/test/java/cn/iocoder/yudao/module/system/service/logger/OperateLogServiceImplTest.java

@@ -1,35 +1,22 @@
 package cn.iocoder.yudao.module.system.service.logger;
 
-import cn.hutool.core.map.MapUtil;
-import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
-import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
-import cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
-import cn.iocoder.yudao.framework.operatelog.core.enums.OperateTypeEnum;
 import cn.iocoder.yudao.framework.test.core.ut.BaseDbUnitTest;
 import cn.iocoder.yudao.framework.test.core.util.RandomUtils;
 import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogCreateReqDTO;
+import cn.iocoder.yudao.module.system.api.logger.dto.OperateLogPageReqDTO;
 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.user.AdminUserDO;
 import cn.iocoder.yudao.module.system.dal.mysql.logger.OperateLogMapper;
-import cn.iocoder.yudao.module.system.service.user.AdminUserService;
+import jakarta.annotation.Resource;
 import org.junit.jupiter.api.Test;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.context.annotation.Import;
 
-import jakarta.annotation.Resource;
-import java.util.Collections;
-
-import static cn.hutool.core.util.RandomUtil.randomEle;
-import static cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants.BAD_REQUEST;
 import static cn.iocoder.yudao.framework.common.util.date.LocalDateTimeUtils.buildBetweenTime;
 import static cn.iocoder.yudao.framework.common.util.date.LocalDateTimeUtils.buildTime;
 import static cn.iocoder.yudao.framework.common.util.object.ObjectUtils.cloneIgnoreId;
 import static cn.iocoder.yudao.framework.test.core.util.AssertUtils.assertPojoEquals;
-import static cn.iocoder.yudao.framework.test.core.util.RandomUtils.randomLongId;
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.mockito.Mockito.when;
 
 @Import({OperateLogServiceImpl.class})
 public class OperateLogServiceImplTest extends BaseDbUnitTest {
@@ -40,13 +27,9 @@ public class OperateLogServiceImplTest extends BaseDbUnitTest {
     @Resource
     private OperateLogMapper operateLogMapper;
 
-    @MockBean
-    private AdminUserService userService;
-
     @Test
     public void testCreateOperateLog() {
-        OperateLogCreateReqDTO reqVO = RandomUtils.randomPojo(OperateLogCreateReqDTO.class,
-                o -> o.setExts(MapUtil.<String, Object>builder("orderId", randomLongId()).build()));
+        OperateLogCreateReqDTO reqVO = RandomUtils.randomPojo(OperateLogCreateReqDTO.class);
 
         // 调研
         operateLogServiceImpl.createOperateLog(reqVO);
@@ -56,44 +39,38 @@ public class OperateLogServiceImplTest extends BaseDbUnitTest {
     }
 
     @Test
-    public void testGetOperateLogPage() {
-        // mock（用户信息）
-        AdminUserDO user = RandomUtils.randomPojo(AdminUserDO.class, o -> {
-            o.setNickname("wang");
-            o.setStatus(CommonStatusEnum.ENABLE.getStatus());
-        });
-        when(userService.getUserListByNickname("wang")).thenReturn(Collections.singletonList(user));
-        Long userId = user.getId();
-
+    public void testGetOperateLogPage_vo() {
         // 构造操作日志
         OperateLogDO operateLogDO = RandomUtils.randomPojo(OperateLogDO.class, o -> {
-            o.setUserId(userId);
-            o.setUserType(randomEle(UserTypeEnum.values()).getValue());
-            o.setModule("order");
-            o.setType(OperateTypeEnum.CREATE.getType());
-            o.setStartTime(buildTime(2021, 3, 6));
-            o.setResultCode(GlobalErrorCodeConstants.SUCCESS.getCode());
-            o.setExts(MapUtil.<String, Object>builder("orderId", randomLongId()).build());
+            o.setUserId(2048L);
+            o.setBizId(999L);
+            o.setType("订单");
+            o.setSubType("创建订单");
+            o.setAction("修改编号为 1 的用户信息");
+            o.setCreateTime(buildTime(2021, 3, 6));
         });
         operateLogMapper.insert(operateLogDO);
         // 测试 userId 不匹配
-        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setUserId(userId + 1)));
-        // 测试 module 不匹配
-        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setModule("user")));
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setUserId(1024L)));
+        // 测试 bizId 不匹配
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setBizId(888L)));
         // 测试 type 不匹配
-        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setType(OperateTypeEnum.IMPORT.getType())));
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setType("退款")));
+        // 测试 subType 不匹配
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setSubType("创建退款")));
+        // 测试 action 不匹配
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setAction("修改编号为 1 退款信息")));
         // 测试 createTime 不匹配
-        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setStartTime(buildTime(2021, 2, 6))));
-        // 测试 resultCode 不匹配
-        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setResultCode(BAD_REQUEST.getCode())));
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setCreateTime(buildTime(2021, 2, 6))));
 
         // 构造调用参数
         OperateLogPageReqVO reqVO = new OperateLogPageReqVO();
-        reqVO.setUserNickname("wang");
-        reqVO.setModule("order");
-        reqVO.setType(OperateTypeEnum.CREATE.getType());
-        reqVO.setStartTime(buildBetweenTime(2021, 3, 5, 2021, 3, 7));
-        reqVO.setSuccess(true);
+        reqVO.setUserId(2048L);
+        reqVO.setBizId(999L);
+        reqVO.setType("订");
+        reqVO.setSubType("订单");
+        reqVO.setAction("用户信息");
+        reqVO.setCreateTime(buildBetweenTime(2021, 3, 5, 2021, 3, 7));
 
         // 调用
         PageResult<OperateLogDO> pageResult = operateLogServiceImpl.getOperateLogPage(reqVO);
@@ -103,4 +80,34 @@ public class OperateLogServiceImplTest extends BaseDbUnitTest {
         assertPojoEquals(operateLogDO, pageResult.getList().get(0));
     }
 
+    @Test
+    public void testGetOperateLogPage_dto() {
+        // 构造操作日志
+        OperateLogDO operateLogDO = RandomUtils.randomPojo(OperateLogDO.class, o -> {
+            o.setUserId(2048L);
+            o.setBizId(999L);
+            o.setType("订单");
+        });
+        operateLogMapper.insert(operateLogDO);
+        // 测试 userId 不匹配
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setUserId(1024L)));
+        // 测试 bizId 不匹配
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setBizId(888L)));
+        // 测试 type 不匹配
+        operateLogMapper.insert(cloneIgnoreId(operateLogDO, o -> o.setType("退款")));
+
+        // 构造调用参数
+        OperateLogPageReqDTO reqDTO = new OperateLogPageReqDTO();
+        reqDTO.setUserId(2048L);
+        reqDTO.setBizId(999L);
+        reqDTO.setType("订单");
+
+        // 调用
+        PageResult<OperateLogDO> pageResult = operateLogServiceImpl.getOperateLogPage(reqDTO);
+        // 断言，只查到了一条符合条件的
+        assertEquals(1, pageResult.getTotal());
+        assertEquals(1, pageResult.getList().size());
+        assertPojoEquals(operateLogDO, pageResult.getList().get(0));
+    }
+
 }

yudao-module-system/yudao-module-system-biz/src/test/resources/sql/create_tables.sql

@@ -202,22 +202,15 @@ CREATE TABLE IF NOT EXISTS `system_operate_log` (
     `trace_id`         varchar(64)   NOT NULL DEFAULT '',
     `user_id`          bigint(20)    NOT NULL,
     "user_type" tinyint not null default '0',
-    `module`           varchar(50)   NOT NULL,
-    `name`             varchar(50)   NOT NULL,
-    `type`     bigint(4)     NOT NULL DEFAULT '0',
-    `content`          varchar(2000) NOT NULL DEFAULT '',
-    `exts`             varchar(512)  NOT NULL DEFAULT '',
+    `type`           varchar(50)   NOT NULL,
+    `sub_type`             varchar(50)   NOT NULL,
+    `biz_id`          bigint(20)    NOT NULL,
+    `action`          varchar(2000) NOT NULL DEFAULT '',
+    `extra`             varchar(512)  NOT NULL DEFAULT '',
     `request_method`   varchar(16)            DEFAULT '',
     `request_url`      varchar(255)           DEFAULT '',
     `user_ip`          varchar(50)            DEFAULT NULL,
     `user_agent`       varchar(200)           DEFAULT NULL,
-    `java_method`      varchar(512)  NOT NULL DEFAULT '',
-    `java_method_args` varchar(8000)          DEFAULT '',
-    `start_time`       datetime      NOT NULL,
-    `duration`         int(11)       NOT NULL,
-    `result_code`      int(11)       NOT NULL DEFAULT '0',
-    `result_msg`       varchar(512)           DEFAULT '',
-    `result_data`      varchar(4000)          DEFAULT '',
     `creator`        varchar(64)            DEFAULT '',
     `create_time`      datetime      NOT NULL DEFAULT CURRENT_TIMESTAMP,
     `updater`        varchar(64)            DEFAULT '',