feat(log/aop): 新增 log-aop 组件模块,基于 aop 记录日志记录

Author: Time-w

continew-starter-dependencies/pom.xml

@@ -490,6 +490,13 @@
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 日志模块 - 基于 AOP 实现日志记录 -->
+            <dependency>
+                <groupId>top.continew</groupId>
+                <artifactId>continew-starter-log-aop</artifactId>
+                <version>${revision}</version>
+            </dependency>
+
             <!-- 日志模块 - 核心模块 -->
             <dependency>
                 <groupId>top.continew</groupId>
@@ -680,7 +687,8 @@
                         <configuration>
                             <artifacts>
                                 <artifact>
-                                    <file>${project.build.directory}/effective-pom/continew-starter-dependencies.xml</file>
+                                    <file>${project.build.directory}/effective-pom/continew-starter-dependencies.xml
+                                    </file>
                                     <type>effective-pom</type>
                                 </artifact>
                             </artifacts>

continew-starter-log/continew-starter-log-aop/pom.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>top.continew</groupId>
+        <artifactId>continew-starter-log</artifactId>
+        <version>${revision}</version>
+    </parent>
+    <artifactId>continew-starter-log-aop</artifactId>
+    <description>ContiNew Starter 日志模块 - 基于 AOP 实现日志记录</description>
+
+
+    <dependencies>
+        <!-- 日志模块 - 核心模块 -->
+        <dependency>
+            <groupId>top.continew</groupId>
+            <artifactId>continew-starter-log-core</artifactId>
+        </dependency>
+    </dependencies>
+</project>

continew-starter-log/continew-starter-log-interceptor/src/main/java/top/continew/starter/log/interceptor/autoconfigure/ConditionalOnEnabledLog.java renamed to continew-starter-log/continew-starter-log-aop/src/main/java/top/continew/starter/log/aop/annotation/ConditionalOnEnabledLog.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package top.continew.starter.log.interceptor.autoconfigure;
+package top.continew.starter.log.aop.annotation;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import top.continew.starter.core.constant.PropertiesConstants;

continew-starter-log/continew-starter-log-aop/src/main/java/top/continew/starter/log/aop/annotation/Log.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ * <p>
+ * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.gnu.org/licenses/lgpl.html
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package top.continew.starter.log.aop.annotation;
+
+import top.continew.starter.log.core.enums.Include;
+
+import java.lang.annotation.*;
+
+/**
+ * 日志注解
+ * <p>用于接口方法或类上</p>
+ *
+ * @author Charles7c
+ * @since 1.1.0
+ */
+@Documented
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Log {
+
+    /**
+     * 所属模块（用于接口方法或类上）
+     */
+    String module() default "";
+
+    /**
+     * 日志描述 - 接口操作内容（仅用于接口方法上）
+     */
+    String value() default "";
+
+    /**
+     * 包含信息（在全局配置基础上扩展包含信息）
+     */
+    Include[] includes() default {};
+
+    /**
+     * 排除信息（在全局配置基础上减少包含信息）
+     */
+    Include[] excludes() default {};
+}

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

@@ -0,0 +1,83 @@
+package top.continew.starter.log.aop.aspect;
+
+import com.alibaba.ttl.TransmittableThreadLocal;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+import org.aspectj.lang.JoinPoint;
+import org.aspectj.lang.annotation.AfterReturning;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.annotation.Before;
+import org.aspectj.lang.annotation.Pointcut;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+import top.continew.starter.log.aop.autoconfigure.LogProperties;
+
+import java.time.Duration;
+import java.time.Instant;
+
+/**
+ * 控制台 输出日志切面
+ *
+ * @author echo
+ * @date 2024/12/06 10:33
+ **/
+@Aspect
+public class ConsoleLogAspect {
+
+    private static final Logger log = LoggerFactory.getLogger(ConsoleLogAspect.class);
+    private final LogProperties logProperties;
+    private final TransmittableThreadLocal<Instant> timeTtl = new TransmittableThreadLocal<>();
+
+    public ConsoleLogAspect(LogProperties logProperties) {
+        this.logProperties = logProperties;
+    }
+
+    /**
+     * 切点 - 匹配所有控制器层的方法
+     */
+    @Pointcut("execution(* *..controller.*.*(..)) || execution(* *..*Controller.*(..))")
+    public void controllerLayer() {
+    }
+
+    /**
+     * 处理请求前执行
+     */
+    @Before(value = "controllerLayer()")
+    public void doBefore() {
+        // 打印请求日志
+        if (Boolean.TRUE.equals(logProperties.getIsPrint())) {
+            Instant startTime = Instant.now();
+            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
+            if (attributes != null) {
+                HttpServletRequest request = attributes.getRequest();
+                log.info("[{}] {}", request.getMethod(), request.getRequestURI());
+            }
+            timeTtl.set(startTime);
+        }
+    }
+
+    /**
+     * 处理请求后执行 - 正常返回
+     *
+     * @param joinPoint 切点
+     */
+    @AfterReturning(pointcut = "controllerLayer()", returning = "joinPoint")
+    public void afterReturning(JoinPoint joinPoint) {
+        // 打印请求耗时
+        if (Boolean.TRUE.equals(logProperties.getIsPrint())) {
+            Instant endTime = Instant.now();
+            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
+            if (attributes == null) {
+                return;
+            }
+            HttpServletRequest request = attributes.getRequest();
+            HttpServletResponse response = attributes.getResponse();
+            Duration timeTaken = Duration.between(timeTtl.get(), endTime);
+            log.info("[{}] {} {} {}ms", request.getMethod(), request.getRequestURI(),
+                    response != null ? response.getStatus() : "N/A",
+                    timeTaken.toMillis());
+        }
+    }
+}