feat: Api log 记录注解 logType 改为 String

cadecode · cadecode · commit 9c26e8b11f44 · 2023-08-13T15:07:40.000+08:00
diff --git a/common/plugin/log/pom.xml b/common/plugin/log/pom.xml
@@ -16,9 +16,5 @@
             <groupId>com.github.cadecode</groupId>
             <artifactId>uni-boot-common-core</artifactId>
         </dependency>
-        <dependency>
-            <groupId>com.github.cadecode</groupId>
-            <artifactId>uni-boot-common-plugin-mybatis</artifactId>
-        </dependency>
     </dependencies>
 </project>
diff --git a/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/annotation/ApiLogger.java b/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/annotation/ApiLogger.java
@@ -1,8 +1,6 @@
 package com.github.cadecode.uniboot.common.plugin.log.annotation;
 
 
-import com.github.cadecode.uniboot.common.plugin.log.enums.LogTypeEnum;
-
 import java.lang.annotation.*;
 
 /**
@@ -17,7 +15,7 @@
 public @interface ApiLogger {
     boolean value() default true;
 
-    LogTypeEnum type() default LogTypeEnum.OTHER;
+    String type() default "";
 
     String description() default "";
 
diff --git a/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/aspect/ApiLoggerAspect.java b/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/aspect/ApiLoggerAspect.java
@@ -5,7 +5,8 @@
 import com.github.cadecode.uniboot.common.core.util.JacksonUtil;
 import com.github.cadecode.uniboot.common.plugin.log.annotation.ApiLogger;
 import com.github.cadecode.uniboot.common.plugin.log.handler.AbstractApiLogHandler;
-import lombok.*;
+import com.github.cadecode.uniboot.common.plugin.log.model.BaseLogInfo;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
@@ -16,8 +17,6 @@
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
 
-import javax.servlet.http.HttpServletRequest;
-
 /**
  * 请求响应信息日志 AOP 类
  *
@@ -91,7 +90,7 @@ public void handleLogger(ProceedingJoinPoint point, ApiLogger apiLogger, Object
             return;
         }
         try {
-            String resultStr = null;
+            String resultStr;
             boolean exceptional = false;
             if (ObjectUtil.isNotNull(throwable)) {
                 exceptional = true;
@@ -101,34 +100,22 @@ public void handleLogger(ProceedingJoinPoint point, ApiLogger apiLogger, Object
                     resultStr = JacksonUtil.toJson(result);
                 } catch (Exception e) {
                     resultStr = ExceptionUtil.stacktraceToString(e);
-                    log.error("API log [{}]: request result to json fail", apiLogger.type().getType(), e);
+                    log.error("API log [{}]: request result to json fail", apiLogger.type(), e);
                 }
             }
             BaseLogInfo baseLogInfo = BaseLogInfo.builder().apiLogger(apiLogger).request(attributes.getRequest())
                     .resultStr(resultStr).timeCost(timeCost).exceptional(exceptional).build();
             Object logObj = apiLogHandler.generateLog(point, baseLogInfo);
             // 打印日志
-            log.info("API log [{}]: {}", apiLogger.type().getType(), JacksonUtil.toJson(logObj));
+            log.info("API log [{}]: {}", apiLogger.type(), JacksonUtil.toJson(logObj));
             // 持久化
             try {
                 apiLogHandler.save(apiLogger, logObj);
             } catch (Exception e) {
-                log.error("API log [{}]: save async fail", apiLogger.type().getType(), e);
+                log.error("API log [{}]: save async fail", apiLogger.type(), e);
             }
         } catch (Exception e) {
-            log.error("API log [{}]: handle logger fail", apiLogger.type().getType(), e);
+            log.error("API log [{}]: handle logger fail", apiLogger.type(), e);
         }
     }
-
-    @Data
-    @AllArgsConstructor
-    @NoArgsConstructor
-    @Builder
-    public static class BaseLogInfo {
-        private ApiLogger apiLogger;
-        private Boolean exceptional;
-        private HttpServletRequest request;
-        private String resultStr;
-        private Long timeCost;
-    }
 }
diff --git a/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/enums/LogTypeEnum.java b/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/enums/LogTypeEnum.java
diff --git a/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/handler/AbstractApiLogHandler.java b/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/handler/AbstractApiLogHandler.java
@@ -2,7 +2,7 @@
 
 import cn.hutool.core.collection.CollUtil;
 import com.github.cadecode.uniboot.common.plugin.log.annotation.ApiLogger;
-import com.github.cadecode.uniboot.common.plugin.log.aspect.ApiLoggerAspect.BaseLogInfo;
+import com.github.cadecode.uniboot.common.plugin.log.model.BaseLogInfo;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
 import org.aspectj.lang.ProceedingJoinPoint;
@@ -45,7 +45,7 @@ public static Map<String, Object> getRequestParams(JoinPoint joinPoint, ApiLogge
             return Collections.emptyMap();
         }
         if (names.length != args.length) {
-            log.error("API log [{}]: method [{}] param and the pass value do not match", apiLogger.type().getType(), methodSignature.getName());
+            log.error("API log [{}]: method [{}] param and the pass value do not match", apiLogger.type(), methodSignature.getName());
             return Collections.emptyMap();
         }
         Map<String, Object> map = new HashMap<>();
diff --git a/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/model/BaseLogInfo.java b/common/plugin/log/src/main/java/com/github/cadecode/uniboot/common/plugin/log/model/BaseLogInfo.java
@@ -0,0 +1,27 @@
+package com.github.cadecode.uniboot.common.plugin.log.model;
+
+import com.github.cadecode.uniboot.common.plugin.log.annotation.ApiLogger;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * api log 信息
+ *
+ * @author Cade Li
+ * @since 2023/8/13
+ */
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+@Builder
+public class BaseLogInfo {
+    private ApiLogger apiLogger;
+    private Boolean exceptional;
+    private HttpServletRequest request;
+    private String resultStr;
+    private Long timeCost;
+}
diff --git a/framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/bean/dto/SysLogDto.java b/framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/bean/dto/SysLogDto.java
@@ -1,6 +1,5 @@
 package com.github.cadecode.uniboot.framework.api.bean.dto;
 
-import com.github.cadecode.uniboot.common.plugin.log.enums.LogTypeEnum;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -23,7 +22,7 @@ public class SysLogDto {
     @Builder
     public static class SysLogSaveDto {
 
-        private LogTypeEnum logType;
+        private String logType;
 
         private String url;
 
diff --git a/framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/consts/LogType.java b/framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/consts/LogType.java
@@ -0,0 +1,32 @@
+package com.github.cadecode.uniboot.framework.api.consts;
+
+/**
+ * Api log 类型
+ *
+ * @author Cade Li
+ * @since 2023/8/13
+ */
+public interface LogType {
+
+    /**
+     * curd
+     */
+    String QUERY = "Query";
+    String UPDATE = "Update";
+    String REMOVE = "Remove";
+    String ADD = "Add";
+    /**
+     * 鉴权
+     */
+    String AUTH = "Auth";
+    /**
+     * 导入导出
+     */
+    String IMPORT = "Import";
+    String EXPORT = "Export";
+    /**
+     * 上传下载
+     */
+    String UPLOAD = "Upload";
+    String DOWNLOAD = "Download";
+}
diff --git a/framework/framework_base/src/main/java/com/github/cadecode/uniboot/framework/base/plugin/ApiLogHandler.java b/framework/framework_base/src/main/java/com/github/cadecode/uniboot/framework/base/plugin/ApiLogHandler.java
@@ -8,8 +8,8 @@
 import cn.hutool.http.useragent.UserAgentUtil;
 import com.github.cadecode.uniboot.common.core.util.JacksonUtil;
 import com.github.cadecode.uniboot.common.plugin.log.annotation.ApiLogger;
-import com.github.cadecode.uniboot.common.plugin.log.aspect.ApiLoggerAspect.BaseLogInfo;
 import com.github.cadecode.uniboot.common.plugin.log.handler.AbstractApiLogHandler;
+import com.github.cadecode.uniboot.common.plugin.log.model.BaseLogInfo;
 import com.github.cadecode.uniboot.framework.api.bean.dto.SysLogDto.SysLogSaveDto;
 import com.github.cadecode.uniboot.framework.api.consts.HttpConst;
 import com.github.cadecode.uniboot.framework.api.feignclient.SysLogClient;
@@ -53,7 +53,7 @@ public SysLogSaveDto generateLog(ProceedingJoinPoint point, BaseLogInfo baseLogI
             paramsJson = JacksonUtil.toJson(getRequestParams(point, apiLogger));
         } catch (Exception e) {
             paramsJson = ExceptionUtil.stacktraceToString(e);
-            log.error("API log [{}]: request params to json fail", apiLogger.type().getType(), e);
+            log.error("API log [{}]: request params to json fail", apiLogger.type(), e);
         }
         // 获取描述
         String description = apiLogger.description();
@@ -102,7 +102,7 @@ public void save(ApiLogger apiLogger, Object o) {
         try {
             sysLogClient.save(Collections.singletonList(dto));
         } catch (Exception e) {
-            log.error("API log [{}]: save fail", apiLogger.type().getType(), e);
+            log.error("API log [{}]: save fail", apiLogger.type(), e);
         }
     }
 }
diff --git a/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/bean/po/SysLog.java b/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/bean/po/SysLog.java
@@ -1,7 +1,6 @@
 package com.github.cadecode.uniboot.framework.svc.bean.po;
 
 import com.baomidou.mybatisplus.annotation.*;
-import com.github.cadecode.uniboot.common.plugin.log.enums.LogTypeEnum;
 import com.github.cadecode.uniboot.common.plugin.mybatis.converter.BoolToIntTypeHandler;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -26,7 +25,7 @@ public class SysLog {
     @TableId(type = IdType.ASSIGN_ID)
     private Long id;
 
-    private LogTypeEnum logType;
+    private String logType;
     /**
      * url
      */
diff --git a/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/bean/vo/SysLogVo.java b/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/bean/vo/SysLogVo.java
@@ -1,6 +1,5 @@
 package com.github.cadecode.uniboot.framework.svc.bean.vo;
 
-import com.github.cadecode.uniboot.common.plugin.log.enums.LogTypeEnum;
 import lombok.Data;
 
 import java.util.Date;
@@ -18,7 +17,7 @@ public static class SysLogPageVo {
 
         private Long id;
 
-        private LogTypeEnum logType;
+        private String logType;
 
         private String url;
 
diff --git a/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/controller/AuthController.java b/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/controller/AuthController.java
@@ -2,7 +2,7 @@
 
 import com.github.cadecode.uniboot.common.core.web.response.ApiResult;
 import com.github.cadecode.uniboot.common.plugin.log.annotation.ApiLogger;
-import com.github.cadecode.uniboot.common.plugin.log.enums.LogTypeEnum;
+import com.github.cadecode.uniboot.framework.api.consts.LogType;
 import com.github.cadecode.uniboot.framework.base.annotation.ApiFormat;
 import com.github.cadecode.uniboot.framework.svc.config.FrameSecurityConfig;
 import io.swagger.annotations.Api;
@@ -31,14 +31,14 @@ public class AuthController {
 
     private final AuthClient authClient;
 
-    @ApiLogger(type = LogTypeEnum.AUTH, enableSave = true, description = "用户登录")
+    @ApiLogger(type = LogType.AUTH, enableSave = true, description = "用户登录")
     @ApiOperation("登录")
     @PostMapping("login")
     public ApiResult<?> login(@RequestParam String username, @RequestParam String password) {
         return authClient.login(username, password);
     }
 
-    @ApiLogger(type = LogTypeEnum.AUTH, enableSave = true, description = "用户注销")
+    @ApiLogger(type = LogType.AUTH, enableSave = true, description = "用户注销")
     @ApiOperation("注销")
     @PostMapping("logout")
     public ApiResult<?> logout() {
diff --git a/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/request/SysLogRequest.java b/framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/request/SysLogRequest.java
@@ -1,7 +1,6 @@
 package com.github.cadecode.uniboot.framework.svc.request;
 
 import com.github.cadecode.uniboot.common.core.web.response.PageParams;
-import com.github.cadecode.uniboot.common.plugin.log.enums.LogTypeEnum;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -22,7 +21,7 @@ public static class SysLogPageRequest extends PageParams {
 
         private Date startTime;
         private Date endTime;
-        private List<LogTypeEnum> logTypeList;
+        private List<String> logTypeList;
         private String url;
         private String accessUser;
         private Boolean exceptional;
@@ -32,7 +31,7 @@ public static class SysLogPageRequest extends PageParams {
     @Data
     public static class SysLogSaveRequest {
 
-        private LogTypeEnum logType;
+        private String logType;
 
         private String url;
 
