Spring Boot 2.x 教程系列 | AOP 切面統一列印請求日誌

犬小哈發表於2019-02-20

Spring Boot

文章首發於個人網站 [www.exception.site/springboot/…)

本節中，您將學習如何在 Spring Boot 中使用 AOP 切面統一處理請求日誌，列印進出參相關引數。

一、先看看日誌輸出效果

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

URL: 請求介面地址；
HTTP Method: 請求的方法，是 POST, GET, 還是 DELETE 等；
Class Method: 對應 Controller 的全路徑以及呼叫的哪個方法;
IP: 請求 IP 地址；
Request Args: 請求入參，以 JSON 格式輸出；
Response Args: 響應出參，以 JSON 格式輸出；
Time-Consuming: 請求耗時；

效果應該還不錯吧！接下來就讓我們一步一步去實現該功能, 首先，新建一個 Spring Boot Web 專案。

二、新增 Maven 依賴

在專案 pom.xml 檔案中新增依賴：

<!-- aop 依賴 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

<!-- 用於日誌切面中，以 json 格式列印出入參（本來使用阿里的 FASTJSON, 但是對於檔案上傳的介面，列印引數會報錯，換為 Gson） -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.5</version>
</dependency>
複製程式碼

三、配置 AOP 切面

在配置 AOP 切面之前，我們需要了解下 aspectj 相關注解的作用：

@Aspect：宣告該類為一個註解類；
@Pointcut：定義一個切點，後面跟隨一個表示式，表示式可以定義為某個 package 下的方法，也可以是自定義註解等；
切點定義好後，就是圍繞這個切點做文章了：
- @Before: 在切點之前，織入相關程式碼；
- @After: 在切點之後，織入相關程式碼;
- @AfterReturning: 在切點返回內容後，織入相關程式碼，一般用於對返回值做些加工處理的場景；
- @AfterThrowing: 用來處理當織入的程式碼丟擲異常後的邏輯處理;
- @Around: 在切入點前後織入程式碼，並且可以自由的控制何時執行切點；

接下來，定義一個 WebLogAspect.java 切面類，程式碼如下：

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.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

/**
 * @author www.exception.site (exception 教程網)
 * @date 2019/2/12
 * @time 14:03
 * @discription
 **/
@Aspect
@Component
public class WebLogAspect {

    private final static Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

    /** 以 controller 包下定義的所有請求為切入點 */
    @Pointcut("execution(public * site.exception.springbootaopwebrequest.controller..*.*(..))")
    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();

        // 列印請求相關引數
        logger.info("========================================== Start ==========================================");
        // 列印請求 url
        logger.info("URL            : {}", request.getRequestURL().toString());
        // 列印 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 ===========================================");
        // 每個請求之間空一行
        logger.info("");
    }

    /**
     * 環繞
     * @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;
    }

}

複製程式碼

我們通過 @Aspect 宣告瞭 WebLogAspect.java 為切面類，之後，通過 @Pointcut 定義了列印請求日誌的切點，切點為 site.exception.springbootaopwebrequest.controller 包下所有的請求介面。

切點定義好後，我們通過 @Before 在切點之前列印請求的相關引數，通過 @Around 列印了請求介面的耗時時間，最後通過 @After 做了請求的收尾工作。

到這裡，切面相關的程式碼就完成了！

三、測試

我們針對 GET, POST, 檔案提交，以及多檔案提交四種介面分別測試其效果, 介面定義如下：

package site.exception.springbootaopwebrequest.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import site.exception.springbootaopwebrequest.entity.User;

/**
 * @author www.exception.site (exception 教程網)
 * @date 2019/2/16
 * @time 21:03
 * @discription
 **/
@RestController
public class TestController {

    private final static Logger logger = LoggerFactory.getLogger(TestController.class);

    /**
     * POST 方式介面測試
     * @param user
     * @return
     */
    @PostMapping("/user")
    public User testPost(@RequestBody User user) {
        logger.info("testPost ...");
        return user;
    }

    /**
     * GET 方式介面測試
     * @return
     */
    @GetMapping("/user")
    public String testGet(@RequestParam("username") String username,
                          @RequestParam("password") String password) {
        logger.info("testGet ...");
        return "success";
    }

    /**
     * 單檔案上傳介面測試
     * @return
     */
    @PostMapping("/file/upload")
    public String testFileUpload(@RequestParam("file") MultipartFile file) {
        logger.info("testFileUpload ...");
        return "success";
    }

    /**
     * 多檔案上傳介面測試
     * @return
     */
    @PostMapping("/multiFile/upload")
    public String testMultiFileUpload(@RequestParam("file") MultipartFile[] file) {
        logger.info("testMultiFileUpload ...");
        return "success";
    }
}

複製程式碼

User.java:

package site.exception.springbootaopwebrequest.entity;

import java.io.Serializable;
import java.util.Date;

/**
 * @author www.exception.site (exception 教程網)
 * @date 2019/2/16
 * @time 21:00
 * @discription
 **/
public class User implements Serializable {
    /**
     * 使用者名稱
     */
    private String username;
    /**
     * 密碼
     */
    private String password;
    /**
     * 建立時間
     */
    private Date createTime;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
}
複製程式碼