Spring Boot 自定義註解，AOP 切麵統一列印出入參請求日誌

今天主要說說如何通過自定義註解的方式，在 Spring Boot 中來實現 AOP 切麵統一列印出入參日誌。小伙伴們可以收藏一波。廢話不多說，進入正題！一、先看看切麵日誌輸出效果在看看實現方法之前，我們先看下切麵日誌輸出效果咋樣：從上圖中可以看到，每個對於每個請求，開始與結束一目瞭然，並且打 ...

今天主要說說如何通過自定義註解的方式，在 Spring Boot 中來實現 AOP 切麵統一列印出入參日誌。小伙伴們可以收藏一波。

廢話不多說，進入正題！

一、先看看切麵日誌輸出效果

在看看實現方法之前，我們先看下切麵日誌輸出效果咋樣：

從上圖中可以看到，每個對於每個請求，開始與結束一目瞭然，並且列印了以下參數：

URL: 請求介面地址；
Description: 介面的中文說明信息；
HTTP Method: 請求的方法，是 POST, GET, 還是 DELETE 等；
Class Method: 被請求的方法路徑 : 包名 + 方法名;
IP: 請求方的 IP 地址；
Request Args: 請求入參，以 JSON 格式輸出；
Response Args: 響應出參，以 JSON 格式輸出；
Time-Consuming: 請求耗時，以此估算每個介面的性能指數；

怎麼樣？看上去效果還不錯呢？接下來看看，我們要如何一步一步實現它呢？

二、添加 AOP Maven 依賴

在項目 pom.xml 文件中添加依賴：

<!-- aop 依賴 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 用於日誌切麵中，以 json 格式列印出入參 -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.5</version>
</dependency>

三、自定義日誌註解

讓我們來自定義一個日誌註解，如下所示：

①：什麼時候使用該註解，我們定義為運行時；
②：註解用於什麼地方，我們定義為作用於方法上；
③：註解是否將包含在 JavaDoc 中；
④：註解名為 WebLog;
⑤：定義一個屬性，預設為空字元串；

源代碼如下：

package site.exception.springbootaopwebrequest.aspect;
import java.lang.annotation.*;
/** 
* @date 2023/10/6 
* @time 下午9:19 
* @discription 
**/ 
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface WebLog {
    /**
    * 日誌描述信息
    * @return
    **/ 
    String description() default "";
}

到這裡，一個完整的自定義註解就定義完成了。

四、配置 AOP 切麵

在配置 AOP 切麵之前，我們需要瞭解下 aspectj 相關註解的作用：

@Aspect：聲明該類為一個註解類；
@Pointcut：定義一個切點，後面跟隨一個表達式，表達式可以定義為切某個註解，也可以切某個 package 下的方法；

切點定義好後，就是圍繞這個切點做文章了：

@Before: 在切點之前，織入相關代碼；
@After: 在切點之後，織入相關代碼;
@AfterReturning: 在切點返回內容後，織入相關代碼，一般用於對返回值做些加工處理的場景；
@AfterThrowing: 用來處理當織入的代碼拋出異常後的邏輯處理;
@Around: 環繞，可以在切入點前後織入代碼，並且可以自由的控制何時執行切點；

接下來，定義一個 WebLogAspect.java 切麵類，聲明一個切點：

然後，定義 @Around 環繞，用於何時執行切點：

①：記錄一下調用介面的開始時間；
②：執行切點，執行切點後，會去依次調用 @Before -> 介面邏輯代碼 -> @After -> @AfterReturning；
③：列印出參；
④：列印介面處理耗時；
⑤：返回介面返參結果；

再來看看 @Before 方法：

看註釋功能說明，因為註釋說得還是比較清楚的！

最後，用 @After 來做個收尾：

我們在每個介面的最後，列印日誌結束標誌。最後再看下項目包結構：

到這裡，切麵相關的代碼就完成了！

上完整代碼：

package site.exception.springbootaopwebrequest.aspect;

import com.google.gson.Gson;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;

/**
 * @date 2023/10/6
 * @time 下午9:19
 * @discription
**/
@Aspect
@Component
@Profile({"dev", "test"})
public class WebLogAspect {

    private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);
    /** 換行符 */
    private static final String LINE_SEPARATOR = System.lineSeparator();

    /** 以自定義 @WebLog 註解為切點 */
    @Pointcut("@annotation(site.exception.springbootaopwebrequest.aspect.WebLog)")
    public void webLog() {}

    /**
     * 在切點之前織入
     * @param joinPoint
     * @throws Throwable
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 開始列印請求日誌
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 獲取 @WebLog 註解的描述信息
        String methodDescription = getAspectLogDescription(joinPoint);

        // 列印請求相關參數
        logger.info("========================================== Start ==========================================");
        // 列印請求 url
        logger.info("URL            : {}", request.getRequestURL().toString());
        // 列印描述信息
        logger.info("Description    : {}", methodDescription);
        // 列印 Http method
        logger.info("HTTP Method    : {}", request.getMethod());
        // 列印調用 controller 的全路徑以及執行方法
        logger.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(), joinPoint.getSignature().getName());
        // 列印請求的 IP
        logger.info("IP             : {}", request.getRemoteAddr());
        // 列印請求入參
        logger.info("Request Args   : {}", new Gson().toJson(joinPoint.getArgs()));
    }

    /**
     * 在切點之後織入
     * @throws Throwable
     */
    @After("webLog()")
    public void doAfter() throws Throwable {
        // 介面結束後換行，方便分割查看
        logger.info("=========================================== End ===========================================" + LINE_SEPARATOR);
    }

    /**
     * 環繞
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        // 列印出參
        logger.info("Response Args  : {}", new Gson().toJson(result));
        // 執行耗時
        logger.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
        return result;
    }


    /**
     * 獲取切麵註解的描述
     *
     * @param joinPoint 切點
     * @return 描述信息
     * @throws Exception
     */
    public String getAspectLogDescription(JoinPoint joinPoint)
            throws Exception {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] arguments = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] methods = targetClass.getMethods();
        StringBuilder description = new StringBuilder("");
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
                Class[] clazzs = method.getParameterTypes();
                if (clazzs.length == arguments.length) {
                    description.append(method.getAnnotation(WebLog.class).description());
                    break;
                }
            }
        }
        return description.toString();
    }

}