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

時間 2019-11-17

標籤 spring boot 2.x 教程系列 aop 切面統一打印請求日誌欄目 Spring 简体版

原文原文鏈接

文章首發於我的網站 [www.exception.site/springboot/…)java

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

1、先看看日誌輸出效果

能夠看到，每一個對於每一個請求，開始與結束一目瞭然，而且打印瞭如下參數：github

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

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

2、添加 Maven 依賴

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

<!-- 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>
複製代碼

3、配置 AOP 切面

在配置 AOP 切面以前，咱們須要瞭解下 aspectj 相關注解的做用：json

@Aspect：聲明該類爲一個註解類；
@Pointcut：定義一個切點，後面跟隨一個表達式，表達式能夠定義爲某個 package 下的方法，也能夠是自定義註解等；
切點定義好後，就是圍繞這個切點作文章了：
- @Before: 在切點以前，織入相關代碼；
- @After: 在切點以後，織入相關代碼;
- @AfterReturning: 在切點返回內容後，織入相關代碼，通常用於對返回值作些加工處理的場景；
- @AfterThrowing: 用來處理當織入的代碼拋出異常後的邏輯處理;
- @Around: 在切入點先後織入代碼，而且能夠自由的控制什麼時候執行切點；

接下來，定義一個 WebLogAspect.java 切面類，代碼以下：springboot

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 包下全部的請求接口。app

切點定義好後，咱們經過 @Before 在切點以前打印請求的相關參數，經過 @Around 打印了請求接口的耗時時間，最後經過 @After 作了請求的收尾工做。spring-boot

到這裏，切面相關的代碼就完成了！學習

3、測試

咱們針對 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;
    }
}
複製代碼