第八章:使用攔截器記錄你的SpringBoot的請求日志

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

免費專題文章匯總

恒宇少年在博客整理出來了SpringBoot、ApiBoot、SpringCloud的文章匯總【SpringBoot基礎教程專題】,【SpringCloud基礎教程專題】,【ApiBoot組件使用專題

本章目標

通過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學習目錄,感謝閱讀!

歡迎微信掃碼加入知識星球,恒宇少年帶你走以后的技術道路!!!

知識星球 - 恒宇少年

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容