refactor(log): 优化日志模块

Author: Charles7c

continew-starter-log/continew-starter-log-aop/src/main/java/top/continew/starter/log/aspect/AccessLogAspect.java

@@ -26,7 +26,7 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
-import top.continew.starter.log.autoconfigure.LogProperties;
+import top.continew.starter.log.model.LogProperties;
 
 import java.time.Duration;
 import java.time.Instant;
@@ -51,42 +51,42 @@ public AccessLogAspect(LogProperties logProperties) {
     /**
      * 切点 - 匹配所有控制器层的 GET 请求方法
      */
-    @Pointcut("within(@org.springframework.web.bind.annotation.RequestMapping *)")
+    @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
     public void pointcut() {
     }
 
     /**
      * 切点 - 匹配所有控制器层的 GET 请求方法
      */
-    @Pointcut("within(@org.springframework.web.bind.annotation.GetMapping *)")
+    @Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping)")
     public void pointcutGet() {
     }
 
     /**
      * 切点 - 匹配所有控制器层的 POST 请求方法
      */
-    @Pointcut("within(@org.springframework.web.bind.annotation.PostMapping *)")
+    @Pointcut("@annotation(org.springframework.web.bind.annotation.PostMapping)")
     public void pointcutPost() {
     }
 
     /**
      * 切点 - 匹配所有控制器层的 PUT 请求方法
      */
-    @Pointcut("within(@org.springframework.web.bind.annotation.PutMapping *)")
+    @Pointcut("@annotation(org.springframework.web.bind.annotation.PutMapping)")
     public void pointcutPut() {
     }
 
     /**
      * 切点 - 匹配所有控制器层的 DELETE 请求方法
      */
-    @Pointcut("within(@org.springframework.web.bind.annotation.DeleteMapping *)")
+    @Pointcut("@annotation(org.springframework.web.bind.annotation.DeleteMapping)")
     public void pointcutDelete() {
     }
 
     /**
      * 切点 - 匹配所有控制器层的 PATCH 请求方法
      */
-    @Pointcut("within(@org.springframework.web.bind.annotation.PatchMapping *)")
+    @Pointcut("@annotation(org.springframework.web.bind.annotation.PatchMapping)")
     public void pointcutPatch() {
     }
 

continew-starter-log/continew-starter-log-aop/src/main/java/top/continew/starter/log/aspect/LogAspect.java

@@ -16,6 +16,7 @@
 
 package top.continew.starter.log.aspect;
 
+import cn.hutool.core.annotation.AnnotationUtil;
 import cn.hutool.core.text.CharSequenceUtil;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.servlet.http.HttpServletResponse;
@@ -30,10 +31,11 @@
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
 import top.continew.starter.log.annotation.Log;
-import top.continew.starter.log.autoconfigure.LogProperties;
 import top.continew.starter.log.dao.LogDao;
 import top.continew.starter.log.handler.LogHandler;
+import top.continew.starter.log.model.LogProperties;
 import top.continew.starter.log.model.LogRecord;
+import top.continew.starter.web.util.SpringWebUtils;
 
 import java.lang.reflect.Method;
 import java.time.Instant;
@@ -76,13 +78,13 @@ public void pointcut() {
     @Around("pointcut()")
     public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
         Instant startTime = Instant.now();
-        // 非 Web 环境不记录
-        ServletRequestAttributes attributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
-        if (attributes == null || attributes.getResponse() == null) {
+        // 指定规则不记录
+        HttpServletRequest request = SpringWebUtils.getRequest();
+        Method targetMethod = this.getMethod(joinPoint);
+        Class<?> targetClass = joinPoint.getTarget().getClass();
+        if (!isRequestRecord(targetMethod, targetClass)) {
             return joinPoint.proceed();
         }
-        HttpServletRequest request = attributes.getRequest();
-        HttpServletResponse response = attributes.getResponse();
         String errorMsg = null;
         // 开始记录
         LogRecord.Started startedLogRecord = logHandler.start(startTime, request);
@@ -95,8 +97,7 @@ public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
         } finally {
             try {
                 Instant endTime = Instant.now();
-                Method targetMethod = this.getMethod(joinPoint);
-                Class<?> targetClass = joinPoint.getTarget().getClass();
+                HttpServletResponse response = SpringWebUtils.getResponse();
                 LogRecord logRecord = logHandler.finish(startedLogRecord, endTime, response, logProperties
                     .getIncludes(), targetMethod, targetClass);
                 // 记录异常信息
@@ -111,6 +112,32 @@ public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
         }
     }
 
+    /**
+     * 是否要记录日志
+     *
+     * @param targetMethod 目标方法
+     * @param targetClass  目标类
+     * @return true：需要记录；false：不需要记录
+     */
+    private boolean isRequestRecord(Method targetMethod, Class<?> targetClass) {
+        // 非 Web 环境不记录
+        ServletRequestAttributes attributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
+        if (attributes == null || attributes.getResponse() == null) {
+            return false;
+        }
+        // 如果接口匹配排除列表，不记录日志
+        if (logProperties.isMatch(attributes.getRequest().getRequestURI())) {
+            return false;
+        }
+        // 如果接口方法或类上有 @Log 注解，且要求忽略该接口，则不记录日志
+        Log methodLog = AnnotationUtil.getAnnotation(targetMethod, Log.class);
+        if (null != methodLog && methodLog.ignore()) {
+            return false;
+        }
+        Log classLog = AnnotationUtil.getAnnotation(targetClass, Log.class);
+        return null == classLog || !classLog.ignore();
+    }
+
     /**
      * 获取方法
      *

continew-starter-log/continew-starter-log-aop/src/main/java/top/continew/starter/log/autoconfigure/LogAutoConfiguration.java

@@ -30,7 +30,9 @@
 import top.continew.starter.log.dao.LogDao;
 import top.continew.starter.log.dao.impl.DefaultLogDaoImpl;
 import top.continew.starter.log.handler.AopLogHandler;
+import top.continew.starter.log.handler.LogFilter;
 import top.continew.starter.log.handler.LogHandler;
+import top.continew.starter.log.model.LogProperties;
 
 /**
  * 日志自动配置
@@ -52,6 +54,15 @@ public LogAutoConfiguration(LogProperties logProperties) {
         this.logProperties = logProperties;
     }
 
+    /**
+     * 日志过滤器
+     */
+    @Bean
+    @ConditionalOnMissingBean
+    public LogFilter logFilter() {
+        return new LogFilter(logProperties);
+    }
+
     /**
      * 日志切面
      *

continew-starter-log/continew-starter-log-aop/src/main/java/top/continew/starter/log/autoconfigure/LogProperties.java

@@ -28,7 +28,7 @@
 import org.springframework.web.util.ContentCachingRequestWrapper;
 import org.springframework.web.util.ContentCachingResponseWrapper;
 import org.springframework.web.util.WebUtils;
-import top.continew.starter.log.autoconfigure.LogProperties;
+import top.continew.starter.log.model.LogProperties;
 
 import java.io.IOException;
 import java.net.URI;

continew-starter-log/continew-starter-log-interceptor/src/main/java/top/continew/starter/log/handler/LogFilter.java renamed to continew-starter-log/continew-starter-log-core/src/main/java/top/continew/starter/log/handler/LogFilter.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.continew.starter.log.autoconfigure;
+package top.continew.starter.log.model;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import top.continew.starter.core.constant.PropertiesConstants;

continew-starter-log/continew-starter-log-interceptor/src/main/java/top/continew/starter/log/autoconfigure/LogProperties.java renamed to continew-starter-log/continew-starter-log-core/src/main/java/top/continew/starter/log/model/LogProperties.java

@@ -33,6 +33,7 @@
 import top.continew.starter.log.handler.LogFilter;
 import top.continew.starter.log.handler.LogHandler;
 import top.continew.starter.log.interceptor.LogInterceptor;
+import top.continew.starter.log.model.LogProperties;
 
 /**
  * 日志自动配置

continew-starter-log/continew-starter-log-interceptor/src/main/java/top/continew/starter/log/autoconfigure/LogAutoConfiguration.java

@@ -27,7 +27,7 @@
 import org.springframework.web.method.HandlerMethod;
 import org.springframework.web.servlet.HandlerInterceptor;
 import top.continew.starter.log.annotation.Log;
-import top.continew.starter.log.autoconfigure.LogProperties;
+import top.continew.starter.log.model.LogProperties;
 import top.continew.starter.log.dao.LogDao;
 import top.continew.starter.log.handler.LogHandler;
 import top.continew.starter.log.model.LogRecord;