使用攔截器記錄你的SpringBoot的請求日誌

請求日誌幾乎是所有大型企業級項目的必要的模塊,請求日誌對於我們來說後期在項目運行上線一段時間用於排除異常、請求分流處理、限制流量等。請求日誌一般都會記錄請求參數、請求地址、請求狀態(Status Code)、SessionId、請求方法方式(Method)、請求時間、客戶端IP地址、請求返回內容、耗時等等。如果你得系統還有其他個性化的配置,也可以完成記錄。

本章目標

通過SpringBoot整合與攔截器整合完成請求日誌的記錄,本章節日誌記錄使用SpringDataJPA與MySQL數據庫記錄。

構建項目

我們使用InteiiJ IDEA創建一個SpringBoot項目,預先依賴模塊有Web、JPA、MySQL、Druid等。項目結構如下圖1所示:

圖1

配置數據源

我們直接從之前的項目中複製一個application.yml文件到/resource下,application.yml內容如下圖2所示:

圖2

創建數據表結構

我們把請求日誌直接保存到本地的MySQL數據庫內,下面我們先來創建一個請求日誌表,結構如下圖3所示:

圖3

我們表結構內的字段比較多,數據結構創建完成後,接下來根據表結構創建實體並配置實體JPA,如下圖4所示:

圖4

可以看到上圖4,我們對應數據庫內的表名以及字段名創建實體映射、字段映射,根據實體我們創建一個實現SpringDataJPA接口JpaRepository的子接口,LoggerJPA,如下圖5所示:

圖5

JpaRepository接口包含了SpringDataJPA內的常用到的CRUD方法,後面章節我們會拿出來分支來專門講解SpringDataJPA使用。

創建日誌攔截器

我們上面的步驟有關請求日誌的存儲已經編寫完成,那麼我們接下來需要編寫一個請求日誌的攔截器,自定義SpringMVC攔截器需要實現HandlerIntercptor接口,並且實現內部的三個方法,如下圖6所示攔截器代碼詳情:

圖6

上面的三個方法在前面章節:第六章:如何在SpringBoot項目中使用攔截器已經講過了,這裏就不多做解釋了,有需要的請去看下我的第六章講解。
這裏需要注意一點,我們在攔截器內無法通過SpringBean的方式注入LoggerJPA,我只能通過另外一種形式。

WebApplicationContextUtils

這個工具類可以通過HttpServletRequest請求對象的上下文(ServetCotext)獲取Spring管理的Bean,具體代碼如下圖7所示:

圖7

可以看到上圖7創建了一個getDAO的方法,方法需要傳入一個實體的類型,以及一個HttpServetRequest請求對象,通過WebApplicationContextUtils內部的getRequiredWebApplicationContext方法獲取到BeanFactory(實體工廠類),從而通過工廠實體的getBean方法就可以拿到SpringDataJPA爲我們管理的LoggerJPA持久化數據接口實例。

記錄請求日誌

我們處理日誌請求時需要用到FastJson、HttpServet依賴,所以我們修改pom.xml配置文件加入FastJson開源組件以及HttpServlet的maven依賴,如下圖8所示:

圖8

接下來我們開始編寫請求日誌的創建,首先我們在preHandle方法內創建LoggerEntity實體,並記錄一些必要參數後將實體寫入到當前請求對象HttpServletRequest內,如下圖9、圖10所示:

圖9
圖10

可以看到我們上面記錄了我們日誌實體內的大部分參數,當用戶發送請求時在進入SpringMVC的控制器之前會進入preHandle方法,然後記錄下我們的請求日誌內容,並將請求日誌的實體寫入到請求對象內,下面就會進入對應springMVC控制器方法的方法,在最後渲染視圖即將返回前臺的時候開始執行我們下面需要邊寫的afterCompletion方法,代碼如下圖11所示:

圖11

我們在afterCompletion方法內記錄了請求相應碼、請求時間戳、請求返回值等。其中請求返回值我們是在哪裏設置的呢?那麼我們接下來開始編寫測試請求控制器IndexController。你就會明白了。

編寫測試控制器

我們在controller包下創建一個IndexController並且添加@RestController註解來標明IndexController是一個restful風格的控制器。如下圖12所示:

圖12

我們在IndexControll控制器內簡單添加了一個測試方法login,可以看到我們在攔截器內的疑問得到的解釋,LOGGER_RETURN是從我們的請求方法傳入到LoggerInterceptor攔截器內afterCompletion方法中的。

配置攔截器

上述我們的代碼基本已經編寫完成,不要忘記最重要的一步,我們需要將LoggerInterceptor攔截器添加到我們的SpringBoot項目內,讓SpringBoot項目可以識別攔截。我們需要創建一個LoggerConfguration配置類,如下圖13所示:

圖13

我們的項目編碼已經完成,下面我們來嘗試運行項目看看效果。

初嘗試運行項目

運行日誌如下圖14所示,如果沒有出現異常證明項目運行成功了,如果出現異常請根據對應異常檢查錯誤。

圖14

我們項目已經運行成功,那麼我們接下來測試我們的請求日誌是否可以記錄成功,我們先來訪問地址:http://127.0.0.1:8080/index/login?name=yuqiyu(簡書插入鏈接無法帶參數,請複製到地址欄訪問),效果如下圖15所示:

圖15

可以看到我們成功的返回了在IndexControll的login方法配置的json信息,那麼我的請求日誌是否已經記錄到數據庫呢?我們先來看下InteiiJ IDEA工具的控制器是否已經打印了SQL,如下圖16所示:

圖16

可以看到已經正常打印了,我們打開表查看下數據,如下圖17所示:

圖17

我們已經將請求日誌成功的寫入到數據庫。

總結

上述內容就是本章的全部講解,本章主要講解了SpringBoot項目如何配置日誌攔截器,將用戶的請求參數寫入到數據庫內,使用SpringDataJPA以及Druid連接池完成數據的持久化操作。當前如果要在企業級大型項目使用,還請定期清理請求日誌。如果你有記錄錯誤日誌發送郵件的需求,可以通過判斷HttpServertReponse對象的statusCode來完成,具體的錯誤堆棧信息記錄,需要我們後續章節講解。

本章內容已經更新到碼雲

SpringBoot配套源碼地址:https://gitee.com/hengboy/spring-boot-chapter

SpringCloud配套源碼地址:https://gitee.com/hengboy/spring-cloud-chapter

SpringBoot相關係列文章請訪問:目錄:SpringBoot學習目錄

QueryDSL相關係列文章請訪問:QueryDSL通用查詢框架學習目錄

SpringDataJPA相關係列文章請訪問:目錄:SpringDataJPA學習目錄

SpringBoot相關文章請訪問:目錄:SpringBoot學習目錄,感謝閱讀!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章