SpringBoot 配置 AOP 列印日誌

来源:https://www.cnblogs.com/vandusty/archive/2019/08/24/11406536.html
-Advertisement-
Play Games

在項目開發中，日誌系統是必不可少的，用`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 示例代碼

  1. Github 示例代碼

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • React Native實踐總結一
    一、React的世界觀1、通過改變state來改變視圖視圖不用考慮如何改變自己，把state畫出來即可。2、變數不可變通過創建一個新的state來更改state，使得變更可追蹤，不容易因為其他部分修改state導致不可預測的錯誤3、結構與樣式分離參考了CSS的做法，RN的style機制使得代碼更清晰 ...
  • 數組和字元串的方法整合
    js中的數組和字元串有點類似，不是說本質上，而是在遍歷，獲取時的類似。從標識來說，可以一眼看出那個是數組，那個是字元串；但在使用遍歷時，會不經意的將兩者混淆，導致方法用錯。同時兩者的方法又有好幾個相同的，但需註意語義，以及有些方法是不會對原數組產生影響的。以下是我整理的一些關於數組和字元串的一些方法 ...
  • CSS3中的彈性盒子模型
    介紹 在css2當中，存在標準模式下的盒子模型和IE下的怪異盒子模型。這兩種方案表示的是一種盒子模型的渲染模式。而在css3當中，新增加了彈性盒子模型，彈性盒子模型是一種新增加的強大的、靈活的佈局方案。彈性盒子模型是css3中新提出的一種佈局方案。是一種為了應對針對不同屏幕寬度不同設備的一整套新的布 ...
  • 深入理解iframe
    一、什麼是 iframe iframe 用於在頁面內顯示頁面，使用 <iframe> 會創建包含另外一個文檔的內聯框架（即行內框架） 二、iframe 的常用屬性 1、width 定義 iframe 的寬度 2、height 定義 iframe 的高度 3、name 規定 iframe 的名稱 4、 ...
  • Web前端基礎學習-1
    HTML5/CSS簡介 首先來說一說什麼是HTML5，HTML5可以認為是字面上的意義，也就是HTML的第五代產品，當然從另一個角度來說它是一種新的富客戶端解決方案。 HTML5 將成為 HTML、XHTML 以及 HTML DOM 的新標準。 HTML 的上一個版本誕生於 1999 年。自從那以後 ...
  • js 設計模式——狀態模式
    狀態模式 允許一個對象在其內部狀態改變時改變它的行為，對象看起來似乎修改了它的類。 簡單的解釋一下： 第一部分的意思是將狀態封裝成獨立的類，並將請求委托給當前的狀態對象，當對象的內部狀態改變時，會帶來不同的行為變化。 第二部分是從客戶的角度來看，我們使用的對象，在不同的狀態下具有截然不同的行為，這個 ...
  • 5個 JS 解構有趣的用途
    摘要： 玩轉ES6解構賦值。 原文： "5個 JS 解構有趣的用途" 譯者：前端小智 1. 交換變數 通常交換兩個變數的方法需要一個額外的臨時變數,來看看例子： 是一個臨時變數，它先保存 的值。然後把 的值賦值給 ，接著將 值賦給 。 如果使用解構的方式會更簡單，不需要什麼鬼的 變數。 是解構賦值， ...
  • python字元串有多少位元組
    是否有一些函數可以告訴我字元串在記憶體中占用多少位元組？ 我需要設置套接字緩衝區的大小，以便一次傳輸整個字元串。 解決方案 但實際上你需要知道它代表的長度，所以類似的東西len(s)應該足夠了。 本文首發於Python黑洞網，博客園同步更新 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類