📖 code review 操作日志的实现

yudao-framework/yudao-spring-boot-starter-security/pom.xml

@@ -12,7 +12,10 @@
     <packaging>jar</packaging>
 
     <name>${project.artifactId}</name>
-    <description>用户的认证、权限的校验</description>
+    <description>
+        1. security：用户的认证、权限的校验，实现「谁」可以做「什么事」
+        2. operatelog：操作日志，实现「谁」在「什么时间」对「什么」做了「什么事」
+    </description>
     <url>https://github.com/YunaiV/ruoyi-vue-pro</url>
 
     <dependencies>

yudao-framework/yudao-spring-boot-starter-security/src/main/java/cn/iocoder/yudao/framework/operatelog/config/YudaoOperateLogV2Configuration.java

@@ -8,9 +8,8 @@ import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Primary;
 
-
 /**
- * mzt-biz-log 配置类
+ * 操作日志配置类
  *
  * @author HUIHUI
  */

yudao-framework/yudao-spring-boot-starter-security/src/main/java/cn/iocoder/yudao/framework/operatelog/core/package-info.java

@@ -1 +1,4 @@
+/**
+ * 占位，无特殊作用
+ */
 package cn.iocoder.yudao.framework.operatelog.core;

yudao-framework/yudao-spring-boot-starter-security/src/main/java/cn/iocoder/yudao/framework/operatelog/core/service/ILogRecordServiceImpl.java

@@ -11,9 +11,9 @@ import jakarta.annotation.Resource;
 import jakarta.servlet.http.HttpServletRequest;
 import lombok.extern.slf4j.Slf4j;
 
-import java.util.Collections;
 import java.util.List;
 
+// TODO @puhui999：LogRecordServiceImpl 改成这个名字哈
 /**
  * 操作日志 ILogRecordService 实现类
  *
@@ -26,11 +26,11 @@ public class ILogRecordServiceImpl implements ILogRecordService {
 
     @Resource
     private OperateLogApi operateLogApi;
-    
+
     @Override
     public void record(LogRecord logRecord) {
+        // 1. 补全通用字段
         OperateLogV2CreateReqDTO reqDTO = new OperateLogV2CreateReqDTO();
-        // 补全通用字段
         reqDTO.setTraceId(TracerUtils.getTraceId());
         // 补充用户信息
         fillUserFields(reqDTO);
@@ -38,22 +38,24 @@ public class ILogRecordServiceImpl implements ILogRecordService {
         fillModuleFields(reqDTO, logRecord);
         // 补全请求信息
         fillRequestFields(reqDTO);
-        // 异步记录日志
+
+        // 2. 异步记录日志
         operateLogApi.createOperateLogV2(reqDTO);
         // TODO 测试结束删除或搞个开关
         log.info("操作日志 ===> {}", reqDTO);
     }
 
     private static void fillUserFields(OperateLogV2CreateReqDTO reqDTO) {
+        // TODO @puhui999：使用 SecurityFrameworkUtils。因为要考虑，rpc、mq、job，它其实不是 web；
         reqDTO.setUserId(WebFrameworkUtils.getLoginUserId());
         reqDTO.setUserType(WebFrameworkUtils.getLoginUserType());
     }
 
     public static void fillModuleFields(OperateLogV2CreateReqDTO reqDTO, LogRecord logRecord) {
-        reqDTO.setType(logRecord.getType()); // 大模块类型如 crm 客户
-        reqDTO.setSubType(logRecord.getSubType());// 操作名称如 转移客户
-        reqDTO.setBizId(Long.parseLong(logRecord.getBizNo())); // 操作模块业务编号
-        reqDTO.setAction(logRecord.getAction());// 例如说，修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。
+        reqDTO.setType(logRecord.getType()); // 大模块类型，例如：CRM 客户
+        reqDTO.setSubType(logRecord.getSubType());// 操作名称，例如：转移客户
+        reqDTO.setBizId(Long.parseLong(logRecord.getBizNo())); // 业务编号，例如：客户编号
+        reqDTO.setAction(logRecord.getAction());// 操作内容，例如：修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。
         reqDTO.setExtra(logRecord.getExtra()); // 拓展字段，有些复杂的业务，需要记录一些字段 ( JSON 格式 )，例如说，记录订单编号，{ orderId: "1"}
     }
 
@@ -72,12 +74,12 @@ public class ILogRecordServiceImpl implements ILogRecordService {
 
     @Override
     public List<LogRecord> queryLog(String bizNo, String type) {
-        return Collections.emptyList();
+        throw new UnsupportedOperationException("使用 OperateLogApi 进行操作日志的查询");
     }
 
     @Override
     public List<LogRecord> queryLogByBizNo(String bizNo, String type, String subType) {
-        return Collections.emptyList();
+        throw new UnsupportedOperationException("使用 OperateLogApi 进行操作日志的查询");
     }
 
-}
+}

yudao-framework/yudao-spring-boot-starter-security/src/main/java/cn/iocoder/yudao/framework/operatelog/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * 基于 mzt-log 框架
+ * 实现操作日志功能
+ *
+ * @author HUIHUI
+ */
+package cn.iocoder.yudao.framework.operatelog;