SpringBoot 配置 AOP 列印日志

在項目開發中，日志系統是必不可少的，用`AOP`在Web的請求做入參和出參的參數列印，同時對異常進行日志列印，避免重複的手寫日志，完整案例見文末源碼。

在項目開發中，日志系統是必不可少的，用 AOP 在Web的請求做入參和出參的參數列印，同時對異常進行日志列印，避免重複的手寫日志，完整案例見文末源碼。

一、 `Spring AOP`

AOP (Aspect-Oriented Programming，面向切面程式設計)，它利用一種"橫切"的技術，将那些多個類的共同行為封裝到一個可重用的子產品。便于減少系統的重複代碼，降低子產品之間的耦合度，并有利于未來的可操作性和可維護性。

AOP

中有以下概念：

Aspect （切面）：聲明類似于 Java 中的類聲明，在 Aspect 中會包含一些Pointcut及相應的Advice。
Joint point （連接配接點）：表示在程式中明确定義的點。包括方法的調用、對類成員的通路等。
Pointcut （切入點）：表示一個組 Joint point ，如方法名、參數類型、傳回類型等等。
Advice （通知）： Advice 定義了在 Pointcut 裡面定義的程式點具體要做的操作，它通過( before 、 around after ( return throw )、 finally 來差別實在每個 Joint point 之前、之後還是執行前後要調用的代碼。
Before ：在執行方法前調用 Advice ，比如請求接口之前的登入驗證。
Around ：在執行方法前後調用 Advice ，這是最常用的方法。
After ：在執行方法後調用 Advice ， after return 是方法正常傳回後調用， after\throw 是方法抛出異常後調用。
Finally ：方法調用後執行 Advice ，無論是否抛出異常還是正常傳回。
AOP proxy ： AOP proxy 也是 Java 對象，是由 AOP 架構建立，用來完成上述動作， AOP 對象通常可以通過 JDK dynamic proxy 完成，或者使用 CGLIb 完成。
Weaving ：實作上述切面程式設計的代碼織入，可以在編譯時刻，也可以在運作時刻， Spring 和其它大多數Java架構都是在運作時刻生成代理。

二、項目示例

當然，在使用該案例之前，如果需要了解日志配置相關，可參考 SpringBoot 異步輸出 Logback 日志，本文就不再概述了。

2.1 在pom引入依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    <!-- 分析用戶端資訊的工具類-->
    <dependency>
        <groupId>eu.bitwalker</groupId>
        <artifactId>UserAgentUtils</artifactId>
        <version>1.20</version>
    </dependency>
    <!-- lombok -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>1.8.4</scope>
    </dependency>
</dependencies>

2.2 `Controller` 切面： `WebLogAspect`

@Aspect
@Component
@Slf4j
public class WebLogAspect {

    /**
     * 進入方法時間戳
     */
    private Long startTime;
    /**
     * 方法結束時間戳(計時)
     */
    private Long endTime;

    public WebLogAspect() {
    }


    /**
     * 定義請求日志切入點，其切入點表達式有多種比對方式,這裡是指定路徑
     */
    @Pointcut("execution(public * cn.van.log.aop.controller.*.*(..))")
    public void webLogPointcut() {
    }

    /**
     * 前置通知：
     * 1. 在執行目标方法之前執行，比如請求接口之前的登入驗證;
     * 2. 在前置通知中設定請求日志資訊，如開始時間，請求參數，注解内容等
     *
     * @param joinPoint
     * @throws Throwable
     */
    @Before("webLogPointcut()")
    public void doBefore(JoinPoint joinPoint) {

        // 接收到請求，記錄請求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //擷取請求頭中的User-Agent
        UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
        //列印請求的内容
        startTime = System.currentTimeMillis();
        log.info("請求開始時間：{}" + LocalDateTime.now());
        log.info("請求Url : {}" + request.getRequestURL().toString());
        log.info("請求方式 : {}" + request.getMethod());
        log.info("請求ip : {}" + request.getRemoteAddr());
        log.info("請求方法 : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        log.info("請求參數 : {}" + Arrays.toString(joinPoint.getArgs()));
        // 系統資訊
        log.info("浏覽器：{}", userAgent.getBrowser().toString());
        log.info("浏覽器版本：{}", userAgent.getBrowserVersion());
        log.info("作業系統: {}", userAgent.getOperatingSystem().toString());
    }

    /**
     * 傳回通知：
     * 1. 在目标方法正常結束之後執行
     * 1. 在傳回通知中補充請求日志資訊，如傳回時間，方法耗時，傳回值，并且儲存日志資訊
     *
     * @param ret
     * @throws Throwable
     */
    @AfterReturning(returning = "ret", pointcut = "webLogPointcut()")
    public void doAfterReturning(Object ret) throws Throwable {
        endTime = System.currentTimeMillis();
        log.info("請求結束時間：{}" + LocalDateTime.now());
        log.info("請求耗時：{}" + (endTime - startTime));
        // 處理完請求，傳回内容
        log.info("請求傳回 : {}" + ret);
    }

    /**
     * 異常通知：
     * 1. 在目标方法非正常結束，發生異常或者抛出異常時執行
     * 1. 在異常通知中設定異常資訊，并将其儲存
     *
     * @param throwable
     */
    @AfterThrowing(value = "webLogPointcut()", throwing = "throwable")
    public void doAfterThrowing(Throwable throwable) {
        // 儲存異常日志記錄
        log.error("發生異常時間：{}" + LocalDateTime.now());
        log.error("抛出異常：{}" + throwable.getMessage());
    }
}

2.3 編寫測試

@RestController
@RequestMapping("/log")
public class LogbackController {

    /**
     * 測試正常請求
     * @param msg
     * @return
     */
    @GetMapping("/{msg}")
    public String getMsg(@PathVariable String msg) {
        return "request msg : " + msg;
    }

    /**
     * 測試抛異常
     * @return
     */
    @GetMapping("/test")
    public String getException(){
        // 故意造出一個異常
        Integer.parseInt("abc123");
        return "success";
    }
}

2.4 `@Before` 和 `@AfterReturning` 部分也可使用以下代碼替代

/**
     * 在執行方法前後調用Advice，這是最常用的方法，相當于@Before和@AfterReturning全部做的事兒
     * @param pjp
     * @return
     * @throws Throwable
     */
    @Around("webLogPointcut()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        // 接收到請求，記錄請求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //擷取請求頭中的User-Agent
        UserAgent userAgent = UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
        //列印請求的内容
        startTime = System.currentTimeMillis();
        log.info("請求Url : {}" , request.getRequestURL().toString());
        log.info("請求方式 : {}" , request.getMethod());
        log.info("請求ip : {}" , request.getRemoteAddr());
        log.info("請求方法 : " , pjp.getSignature().getDeclaringTypeName() , "." , pjp.getSignature().getName());
        log.info("請求參數 : {}" , Arrays.toString(pjp.getArgs()));
    // 系統資訊
        log.info("浏覽器：{}", userAgent.getBrowser().toString());
        log.info("浏覽器版本：{}",userAgent.getBrowserVersion());
        log.info("作業系統: {}", userAgent.getOperatingSystem().toString());
        // pjp.proceed()：當我們執行完切面代碼之後，還有繼續處理業務相關的代碼。proceed()方法會繼續執行業務代碼，并且其傳回值，就是業務處理完成之後的傳回值。
        Object ret = pjp.proceed();
        log.info("請求結束時間："+ LocalDateTime.now());
        log.info("請求耗時：{}" , (System.currentTimeMillis() - startTime));
        // 處理完請求，傳回内容
        log.info("請求傳回 : " , ret);
        return ret;
    }

三、測試

3.1 請求入口 `LogbackController.java`

@RestController
@RequestMapping("/log")
public class LogbackController {

    /**
     * 測試正常請求
     * @param msg
     * @return
     */
    @GetMapping("/normal/{msg}")
    public String getMsg(@PathVariable String msg) {
        return msg;
    }

    /**
     * 測試抛異常
     * @return
     */
    @GetMapping("/exception/{msg}")
    public String getException(@PathVariable String msg){
        // 故意造出一個異常
        Integer.parseInt("abc123");
        return msg;
    }
}

3.2 測試正常請求

打開浏覽器，通路http://localhost:8082/log/normal/hello

日志列印如下：

[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [65] [INFO ] 請求開始時間：2019-02-24T22:37:50.892
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [66] [INFO ] 請求Url : http://localhost:8082/log/normal/hello
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [67] [INFO ] 請求方式 : GET
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [68] [INFO ] 請求ip : 0:0:0:0:0:0:0:1
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [69] [INFO ] 請求方法 : 
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [70] [INFO ] 請求參數 : [hello]
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [72] [INFO ] 浏覽器：CHROME
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [73] [INFO ] 浏覽器版本：76.0.3809.100
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [74] [INFO ] 作業系統: MAC_OS_X
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [88] [INFO ] 請求結束時間：2019-02-24T22:37:50.901
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [89] [INFO ] 請求耗時：14
[2019-02-24 22:37:50.050] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-1] [91] [INFO ] 請求傳回 : hello

3.3 測試異常情況

通路：http://localhost:8082/log/exception/hello

[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [65] [INFO ] 請求開始時間：2019-02-24T22:39:57.728
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [66] [INFO ] 請求Url : http://localhost:8082/log/exception/hello
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [67] [INFO ] 請求方式 : GET
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [68] [INFO ] 請求ip : 0:0:0:0:0:0:0:1
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [69] [INFO ] 請求方法 : 
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [70] [INFO ] 請求參數 : [hello]
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [72] [INFO ] 浏覽器：CHROME
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [73] [INFO ] 浏覽器版本：76.0.3809.100
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [74] [INFO ] 作業系統: MAC_OS_X
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [104] [ERROR] 發生異常時間：2019-02-24T22:39:57.731
[2019-02-24 22:39:57.057] [cn.van.log.aop.aspect.WebLogAspect] [http-nio-8082-exec-9] [105] [ERROR] 抛出異常：For input string: "abc123"
[2019-02-24 22:39:57.057] [org.apache.juli.logging.DirectJDKLog] [http-nio-8082-exec-9] [175] [ERROR] Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.NumberFormatException: For input string: "abc123"] with root cause
java.lang.NumberFormatException: For input string: "abc123"

四、源碼

4.1 示例代碼

Github 示例代碼

技術交流，歡迎掃一掃！

風塵部落格

SpringBoot 配置 AOP 列印日志

一、 `Spring AOP`

二、項目示例

2.1 在pom引入依賴

2.2 `Controller` 切面： `WebLogAspect`

2.3 編寫測試

2.4 `@Before` 和 `@AfterReturning` 部分也可使用以下代碼替代

三、測試

3.1 請求入口 `LogbackController.java`

3.2 測試正常請求

3.3 測試異常情況

四、源碼

4.1 示例代碼

技術交流，歡迎掃一掃！

風塵部落格

繼續閱讀

SpringBoot 應用打包為 Docker 鏡像，并設定時區同步

@Value的幾種常用用法

Android的前後端互動架構搭建（okhhtp+springboot+mysql完整版）

start to use skywalkingInstall JDK8Install ESInstall skywalkingRun Springboot JAR

關于Springboot中JSCH使用說明1. JSCH簡介2. JSCH依賴3. 使用方法4. 使用連接配接池

路徑錯誤Maven：Non-resolvable parent POM: Failure to find錯誤

jsch連接配接伺服器執行指令傳回的資料中文亂碼問題問題分析解決

springboot項目時間不一緻解決方案一、springboot項目時間不一緻解決方案

spring mvc 頁面傳遞數組背景接收方式spring mvc 頁面傳遞數組背景接收方式

Swagger-UI的使用一、添加依賴二、建立配置類三、注解

将swagger-ui中的接口導入postman

聊一聊Swagger-UI的那些事情軟體簡介Swagger 原生Bootstrap-ui Bootstrap的UIKnife4j Bootstrap的更新版的UI

springboot使用 swagger-ui 2.10.5 有關版本更新帶來的問題

微服務-性能壓測\緩存redis和分布式鎖redisson和SpringCache

java 8 Lamda 求 List 中 Bigdecimal類型的各種值求最大值求最小值求和求平均值

(SpringBoot)日志種類：log、monitor、access、out、gc、backup

SpringBoot 配置 AOP 列印日志

一、 Spring AOP

二、項目示例

2.1 在pom引入依賴

2.2 Controller 切面： WebLogAspect

2.3 編寫測試

2.4 @Before 和 @AfterReturning 部分也可使用以下代碼替代

三、 測試

3.1 請求入口 LogbackController.java

3.2 測試正常請求

3.3 測試異常情況

四、源碼

4.1 示例代碼

技術交流，歡迎掃一掃！

風塵部落格

繼續閱讀

一、 `Spring AOP`

2.2 `Controller` 切面： `WebLogAspect`

2.4 `@Before` 和 `@AfterReturning` 部分也可使用以下代碼替代

三、測試

3.1 請求入口 `LogbackController.java`