在專案開發中，日誌系統是必不可少的，用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 示例程式碼
相關推薦

SpringBoot 配置 AOP 列印日誌

在專案開發中，日誌系統是必不可少的，用AOP在Web的請求做入參和出參的引數列印，同時對異常進行日誌列印，避免重複的手寫日誌，完整案例見文末原始碼。 一、Spring AOP AOP(Aspect-Oriented Programming，面向切面程式設計)，它利用一種"橫切"的技術，將那些多個類的共同

springboot使用AOP列印日誌資訊

上一篇介紹了springboot整合Mybatis例子，這一篇在上一篇的基礎上，簡單修改部分實現日誌資訊的列印。隨著專案功能的一點點增加，列印日誌資訊就非常必要了，可以幫助我們很快確定哪裡出現了問題，這

SpringBoot自定義註解、AOP列印日誌

前言        在SpringBoot中使用自定義註解、aop切面列印web請求日誌。主要是想把controller的每個request請求日誌收集起來，呼叫介面、執行時間、返回值這幾個重要的資訊儲存到資料庫裡，然後可以使用火焰圖統計介面呼叫時長，平均響應時長

springMVC配置log4j2列印日誌

1.匯入jar包： <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <!-- log4j日誌檔案管

(三)SpringBoot配置log4j2輸出日誌

SpringBoot預設是用logback日誌系統進行日誌輸出的，本教程主要說明SpringBoot如何配置使用log4j2進行日誌輸出。關於logback、log4j、log4j2 哪個好，哪個效率高這種問題，這裡不做討論。 第一步： SpringBoot預

SpringBoot 配置控制檯彩色日誌輸出

Spring預設使用Logback來進行日誌輸出，同時，控制檯不同引數輸出為不同的顏色，看起來逼格很高。 但是，當我們使用自己預設的配置的時候，彩色消失了。我想，在原始碼中，肯定有預設的配置，所以就去原始碼中招了一圈，很快就找到了，這裡和大家分享下。 預設的配置位置：(S

SpringBoot配置log4j輸出日誌

1、SpringBoot日誌輸出 springboot也可以用logback日誌輸出，但之前用了段時間，感覺還是沒有log4j的方便，可以設定每天輸出一個日誌。 2、SpringBoot配置log4j Springboot配置log4j主要包括兩個步驟：第一

springboot配置aop，啟動報錯java.lang.IllegalStateException:Expected raw type form 這類問題

springboot配置aop，啟動報錯java.lang.IllegalStateException: Expected raw type form of org.springframework.web.servlet.handler.AbstractHandlerMethodMapp

springboot 配置切片記錄日誌

1、pom中配置依賴的aop包 <dependency> <groupId>org.springframework.boot</groupId> <art

springboot配置aop切面詳解

1 引入依賴<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</art

在maven web專案中配置log4j列印日誌及Mybatis sql語句

1 新增依賴jar在pom.xml檔案的<dependencies>下新增以下log4j依賴：<dependency> <groupId>org.slf4j</groupId> <artifactI

springboot搭建專案之日誌AOP，支援日誌內容可配置控制（黑名單欄位不會列印或其他處理方式）

一、問題描述及試用場景 在專案除錯或生產環境追查問題時，日誌檔案是我們最常用的方式。為了滿足日誌規範和方便日誌追查，一般會寫個日誌攔截AOP切面注入相關方法，列印入參，出參。但有個頭疼問題，某些引數裡包含一些敏感欄位，給予資料安全一般不允許列印，比如：使用者密碼，銀行卡卡號

SpringBoot專案的logback日誌配置（包括列印mybatis的sql語句）

我在這就開門見山直接介紹我們專案日誌的配置使用吧！~ 1、基本介紹 預設情況下，Spring Boot專案就會用Logback來記錄日誌，並用INFO級別輸出到控制檯。如下圖： 實際開發中我們不需要直接新增logback日誌依賴。 你會

SpringBoot基於AOP攔截請求列印日誌

一：需求背景.       1.1 現在需要在特定的方法執行前後,做一些日誌處理,儘可能不要寫重複程式碼,優雅的完成處理方法日誌列印.       1.2 簡單實現分析：如果在一些方法裡面

SpringBoot 中的aop配置，完成日誌記錄功能

第一步：在pom.xml下新增依賴 因為springboot已經新增過日誌記錄功能的依賴 <!-- 核心模組，包括自動配置支援、日誌支援 --> <dependency> <groupId>org.s

springBoot logback日誌配置管理 aop切面日誌模組管理，單獨輸出日誌檔案

1.springBoot 日誌配置（將controller包下的日誌單獨輸出到一個檔案下）  1   我們遵守約定>配置>編碼的原則，如果使用logback進行日誌管理，先新增pom 檔案但是spring-boot-starter其中包含了 spring-bo

Springboot中AOP統一處理請求日誌

alt image pri sys -1 boot 技術分享 ring com 完善上面的代碼： 現在把輸出信息由先前的system.out.println()方式改為由日誌輸出（日誌輸出的信息更全面） Springboot中AOP統一處理請求日誌

springboot集成AOP管理日誌

類名 pid slf4 通過 意思 factor ntc oaf 需要 如何將所有的通過url的請求參數以及返回結果都輸出到日誌中？ 如果在controller的類中每個方法名都寫一個log輸出肯定是不明智的選擇。 使用spring的AOP功能即可完成。 1. 在po

springboot添加log4j日誌配置log4j.xml生成日誌文件

ota urn version xmlns private 1.0 owa ram .json 第一步：添加pom文件依賴 <!-- log4j --> <dependency> <

springboot—spring aop 實現系統操作日誌記錄存儲到數據庫

work prop 請求 pack spa 成功 方法 代碼 shu 原文：https://www.jianshu.com/p/d0bbdf1974bd 采用方案： 使用spring 的 aop 技術切到自定義註解上，針對不同註解標誌進行參數解析，記錄日誌