1. 程式人生 > >使用攔截器記錄你的SpringBoot的請求日誌

使用攔截器記錄你的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請求日誌

請求日誌幾乎是所有大型企業級專案的必要的模組,請求日誌對於我們來說後期在專案執行上線一段時間用於排除異常、請求分流處理、限制流量等。請求日誌一般都會記錄請求引數、請求地址、請求狀態(Status Code)、SessionId、請求方法方式(Method)、請求時間、客戶端IP地址、

第八章:使用攔截記錄SpringBoot請求日誌

請求日誌幾乎是所有大型企業級專案的必要的模組,請求日誌對於我們來說後期在專案執行上線一段時間用於排除異常、請求分流處理、限制流量等。請求日誌一般都會記錄請求引數、請求地址、請求狀態(Status Code)、SessionId、請求方法方式(Method)、請求時間、客戶端I

自定義註解+springMVC配置攔截記錄使用者操作的日誌.(寫入資料庫)

springMVC掃包下的分支配置檔案, 注入攔截器 攔截器的內容: (監聽儲存日誌資訊) @SuppressWarnings({"unchecked","rawtypes"}) public class CommContextInterceptor implemen

springboot 攔截記錄每次請求的引數到資料庫或者指定檔案(檔案每天生成一次)

package com.publichealth.common.interceptor;import java.util.Arrays;import java.util.Date;import java.util.Map;import java.util.Map.Entry;

spring mvc 能過攔截記錄請求數據和響應數據

style gpo exec point ret nature request 響應 處理 spring mvc 能過攔截器記錄請求數據記錄有很多種方式,主要有以下三種: 1:過濾器 2:HandlerInterceptor攔截器 3:Aspect接口控制器 但是就我個人所

android,retrofit,okhttp,日誌攔截,使用攔截Interceptor統一列印請求與響應的json

   可以打印出傳遞的引數以及返回的結果 :  最下面有完整的 retrofit 案例 ------------------retrofit的使用----START-------------------------- 首先 : 依賴 : compile 'com.squ

Spring Boot 使用攔截記錄使用者操作日誌

前言 上篇檔案主要是講了如何使用aop記錄使用者操作日誌,這篇檔案將介紹如何使用攔截器記錄操作日誌 匯入依賴 在處理請求引數時需要用到Json,其他依賴請檢視原始碼 <!-- Json解析 --> <dependency> <

axios 全域性攔截 (相應和請求

axios.interceptors.request.use(function (config) { // 在傳送請求之前做些什麼 return config; }, function (error) { // 對請求錯誤做些什麼 return Promise.reject(error); }); // 新增

okhttp新增自定義攔截,封裝公共請求引數

okhttp 進行網路請求 /** * date:2018/11/22 * author:QMY(QMY) * function: */ public class OkhttpUtils { Handler handler; OkHttpClient o

axios攔截(重新整理token) 發起請求

 參考網站:https://www.jianshu.com/p/6bc353e5f7a3;https://segmentfault.com/n/1330000013562989   /*是否正在重新整理的標誌*/ window.isRefreshing = false /

OkHttp中Interceptor攔截之公共引數請求封裝

前言 之前在面試的時候遇到這樣的一個問題,那就是如果app中所有的請求都要加入一些引數(例如 版本號、手機號、登入使用者名稱、token等。。。)那麼怎麼做才能實現,而不至於在每次請求的時候都去進行新增這些請求頭。其實這個問題,剛開始我是拒絕的(之前沒有遇到過

mybatis攔截的使用(輸出日誌或sql語句)

2016-08-28 14:48:02  [ http-apr-8888-exec-8:70630 ] - [ INFO ]  ---------------------------------------------- 2016-08-28 14:48:02  [ http-apr-8888-exec-8

retrofit2.0使用攔截Interceptor統一列印請求與響應的json

先新增依賴: compile ‘com.squareup.retrofit2:retrofit:2.1.0’ compile ‘com.squareup.retrofit2:converter-gson:2.1.0’ compile

Rx系列學習筆記_使用okhttp攔截統一處理返回請求

之前我們進行了一個簡單的請求。但是我們發現api的所以的Observable的型別都是要進行一個ResponseData包裹。ResponseData的程式碼如下: public class R

springAOP攔截並列印controller層請求日誌---註解方式實現

/** * Aop implementation of request log printing * * Created by wenqiangxia on 9:07 2017/10/27 */ @Component @Aspect public class Req

[轉]spring boot 攔截 或 Spring AOP 方式記錄請求日誌

選擇使用攔截器實現,在實現中遇到兩個個問題: a. POST請求 @RequestBody 傳的引數不知怎麼獲取? b. 返回結果如何獲取? c.攔截器中service 無法注入;(已解決) 不知道有沒有人遇到這種情況,攔截器沒有解決上述問題,後來使用 spring

SpringBoot 攔截 response 記錄日誌

() com org instance response tin AS obj control 廢話不多說直接上代碼 package com.gs.techpub.filter; import com.gridsum.techpub.utils.JsonUtil; im

記錄在ssm框架專案中使用攔截攔截非登入請求遇見的問題

1.使用spring中的filter時,會出現bean注入失敗。這個問題一直沒解決。 報錯原因:web應用啟動的順序是:listener->filter->servlet,而因為專案應用了spring mvc,所以我們會有兩個配置檔案(applixationContext.xml和sp

SpringBoot專案攔截中通過流獲取Request請求物件中的引數後,控制器中@RequestBody註解引數獲取不到

一、場景     第一次搭建專案開發環境,需要在專案中實現日誌攔截器,用來獲取使用者請求引數日誌,以便在後期維護中出現BUG時能夠快速定位錯誤發生的場景。請求引數一般通過GET和POST方式進行傳遞,GET請求引數獲取通過request.getParameterMap()獲

研究基於spring通過對http請求資料的預處理(資料加解密、校驗、日誌)(2)過攔截

上文已經詳細講解了如何對request進行處理,本文主要是案例演示 spring MVC 的寫法 新增攔截器 定義一個攔截器 public class AppRequestIntercept