Merge pull request #191 from KEHFAN/20240708-recordOperation

JiazhenBao · web-flow · commit 8f39db1f41a4 · 2024-09-25T15:21:06.000+08:00
20240708 record operation
diff --git a/record-operation/README.md b/record-operation/README.md
@@ -52,6 +52,15 @@ record-operation一个利用Java提供的AOP机制来打印请求日志的依赖
 
 注意：如果为其它字符则会导致类型不一致导致发布失败。需要去排查你的应用参数是否输入正确。
 
+2.方法：saveLog(String log)
+1. - 功能：用于存储日志数据
+   - 参数：log,拦截的日志信息
+   - 返回值：Boolean
+   - 用途：用户自定义日志存储逻辑
+
+用户可直接双击saveLog，自定义log的解析逻辑，并将其按指定的方式存储（文件、数据库）
+![img.png](覆写saveLog逻辑.png)
+
 ## 应用演示链接
 
 1.引入依赖库
diff --git a/record-operation/pom.xml b/record-operation/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>com.wgx</groupId>
     <artifactId>record-operation</artifactId>
-    <version>1.0.4</version>
+    <version>1.0.7</version>
     <name>操作记录依赖库</name>
     <description>打印每次请求日志：全类名+方法名、请求ip，请求url，入参、出参；出现异常时打印error日志：异常信息、异常方法、异常栈、请求参数、请求IP</description>
 
@@ -54,7 +54,6 @@
             <scope>provided</scope>
             <version>1.7.30</version>
         </dependency>
-
         <dependency>
             <artifactId>nasl-metadata-collector</artifactId>
             <groupId>com.netease.lowcode</groupId>
diff --git a/record-operation/src/main/java/com/wgx/aop/LoggingAspect.java b/record-operation/src/main/java/com/wgx/aop/LoggingAspect.java
@@ -4,19 +4,32 @@
 import com.netease.lowcode.core.EnvironmentType;
 import com.netease.lowcode.core.annotation.Environment;
 import com.netease.lowcode.core.annotation.NaslConfiguration;
+import com.wgx.logics.DataWriter;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Pointcut;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.ApplicationContext;
 import org.springframework.core.annotation.Order;
 import org.springframework.stereotype.Component;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
+import org.springframework.web.multipart.MultipartFile;
 
 import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import java.lang.reflect.Method;
+import java.text.MessageFormat;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
 
 
 @Aspect
@@ -52,6 +65,9 @@ public class LoggingAspect {
     })
     private String loggingClassNames;
 
+    @Autowired
+    private ApplicationContext applicationContext;
+
     //切点匹配类上有@Controller、@RestController注解的类下的所有方法
     @Pointcut("within(@org.springframework.stereotype.Controller *) || within(@org.springframework.web.bind.annotation.RestController *)")
     public void controller() {}
@@ -62,6 +78,15 @@ public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
             return joinPoint.proceed();
         }
 
+        Object recordService = null;
+        Method saveLog = null;
+        try {
+            recordService = applicationContext.getBean("saveLogOverriddenRecord_operationCustomizeService");
+            saveLog = recordService.getClass().getMethod("saveLogOverriddenRecord_operation", String.class);
+        } catch (NoSuchBeanDefinitionException e) {
+            // do nothing
+        }
+
         long startTime = System.currentTimeMillis();
 
         // Ensure the current request attributes are available.
@@ -80,35 +105,59 @@ public Object logAround(ProceedingJoinPoint joinPoint) throws Throwable {
         } catch (Throwable ex) {
             exceptionThrown = true;
             if ("error".equals(loggingFormat)) {
+                String msg = MessageFormat.format("Error in {0}#{1} - IP: {2} - URL: {3} - Args: {4} - Exception: {5}",
+                        joinPoint.getSignature().getDeclaringTypeName(),
+                        joinPoint.getSignature().getName(),
+                        requestIP,
+                        requestURL,
+                        serializeArgs(args),
+                        ex.toString());
                 logger.error("Error in {}#{} - IP: {} - URL: {} - Args: {} - Exception: {}",
                         joinPoint.getSignature().getDeclaringTypeName(),
                         joinPoint.getSignature().getName(),
                         requestIP,
                         requestURL,
-                        serializeObject(args),
+                        serializeArgs(args),
                         ex.toString());
                 logger.error("Exception stack trace:", ex);
+                DataWriter.invoke(recordService, saveLog, msg);
             }
             throw ex; // rethrow the exception
         } finally {
             long executionTime = System.currentTimeMillis() - startTime;
             if (!exceptionThrown) {
                 if ("simple".equals(loggingFormat)) {
+                    String msg = MessageFormat.format("Completed {0}#{} - IP: {1} - URL: {2} - Duration: {3} ms",
+                            joinPoint.getSignature().getDeclaringTypeName(),
+                            joinPoint.getSignature().getName(),
+                            requestIP,
+                            requestURL,
+                            executionTime);
                     logger.info("Completed {}#{} - IP: {} - URL: {} - Duration: {} ms",
                             joinPoint.getSignature().getDeclaringTypeName(),
                             joinPoint.getSignature().getName(),
                             requestIP,
                             requestURL,
                             executionTime);
+                    DataWriter.invoke(recordService, saveLog, msg);
                 }else if ("detailed".equals(loggingFormat)) {
+                    String msg = MessageFormat.format("Completed {0}#{1} - IP: {2} - URL: {3} - Args: {4} - Result: {5} - Duration: {6} ms",
+                            joinPoint.getSignature().getDeclaringTypeName(),
+                            joinPoint.getSignature().getName(),
+                            requestIP,
+                            requestURL,
+                            serializeArgs(args),
+                            serializeObject(result),
+                            executionTime);
                     logger.info("Completed {}#{} - IP: {} - URL: {} - Args: {} - Result: {} - Duration: {} ms",
                             joinPoint.getSignature().getDeclaringTypeName(),
                             joinPoint.getSignature().getName(),
                             requestIP,
                             requestURL,
-                            serializeObject(args),
+                            serializeArgs(args),
                             serializeObject(result),
                             executionTime);
+                    DataWriter.invoke(recordService, saveLog, msg);
                 }
             }
         }
@@ -141,6 +190,27 @@ private boolean shouldLog(ProceedingJoinPoint joinPoint) {
         return true;
     }
 
+    private String serializeArgs(Object[] args) {
+        if (Objects.nonNull(args)) {
+            List<Object> objList = new ArrayList<>();
+            Arrays.asList(args).forEach(obj -> {
+                if (obj instanceof HttpServletRequest || obj instanceof HttpServletResponse) {
+                    return;
+                }
+                if (obj instanceof List) {
+                    List<?> argsObjList = (List<?>) obj;
+                    if (Objects.nonNull(argsObjList) && !argsObjList.isEmpty() && argsObjList.get(0) instanceof MultipartFile) {
+                        return;
+                    }
+                }
+                objList.add(obj);
+            });
+
+            return JSON.toJSONString(objList.toArray());
+        }
+        return JSON.toJSONString(args);
+    }
+
     private String serializeObject(Object obj) {
         try {
             return JSON.toJSONString(obj);
diff --git a/record-operation/src/main/java/com/wgx/logics/DataWriter.java b/record-operation/src/main/java/com/wgx/logics/DataWriter.java
@@ -0,0 +1,30 @@
+package com.wgx.logics;
+
+import com.netease.lowcode.core.annotation.NaslLogic;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+
+public class DataWriter {
+
+    /**
+     * 用户覆写，不要修改方法名和参数列表
+     *
+     * @param log
+     * @return
+     */
+    @NaslLogic(override = true,enhance = false)
+    public static Boolean saveLog(String log) {
+
+        return true;
+    }
+
+    public static void invoke(Object service,Method saveLog,String log) throws InvocationTargetException, IllegalAccessException {
+        if(saveLog == null){
+            saveLog(log);
+            return;
+        }
+        saveLog.invoke(service,log);
+    }
+
+}
diff --git a/record-operation/覆写saveLog逻辑.png b/record-operation/覆写saveLog逻辑.png
