請求日志幾乎是所有大型企業(yè)級項目的必要的模塊背捌，請求日志對于我們來說后期在項目運行上線一段時間用于排除異常、請求分流處理洞斯、限制流量等毡庆。請求日志一般都會記錄請求參數(shù)、請求地址巡扇、請求狀態(tài)（Status Code）扭仁、SessionId、請求方法方式（Method）厅翔、請求時間乖坠、客戶端IP地址、請求返回內(nèi)容刀闷、耗時等等熊泵。如果你得系統(tǒng)還有其他個性化的配置，也可以完成記錄甸昏。
免費專題文章匯總
恒宇少年在博客整理出來了SpringBoot顽分、ApiBoot、SpringCloud的文章匯總【SpringBoot基礎(chǔ)教程專題】施蜜，【SpringCloud基礎(chǔ)教程專題】卒蘸，【ApiBoot組件使用專題】
本章目標
通過SpringBoot整合與攔截器整合完成請求日志的記錄，本章節(jié)日志記錄使用SpringDataJPA與MySQL數(shù)據(jù)庫記錄翻默。
構(gòu)建項目
我們使用InteiiJ IDEA創(chuàng)建一個SpringBoot項目缸沃，預(yù)先依賴模塊有Web、JPA修械、MySQL趾牧、Druid等。項目結(jié)構(gòu)如下圖1所示：
配置數(shù)據(jù)源
我們直接從之前的項目中復(fù)制一個application.yml文件到/resource下肯污，application.yml內(nèi)容如下圖2所示：
創(chuàng)建數(shù)據(jù)表結(jié)構(gòu)
我們把請求日志直接保存到本地的MySQL數(shù)據(jù)庫內(nèi)翘单，下面我們先來創(chuàng)建一個請求日志表吨枉，結(jié)構(gòu)如下圖3所示：
我們表結(jié)構(gòu)內(nèi)的字段比較多，數(shù)據(jù)結(jié)構(gòu)創(chuàng)建完成后哄芜，接下來根據(jù)表結(jié)構(gòu)創(chuàng)建實體并配置實體JPA貌亭，如下圖4所示：
可以看到上圖4，我們對應(yīng)數(shù)據(jù)庫內(nèi)的表名以及字段名創(chuàng)建實體映射忠烛、字段映射属提，根據(jù)實體我們創(chuàng)建一個實現(xiàn)SpringDataJPA接口JpaRepository的子接口，LoggerJPA美尸，如下圖5所示：
JpaRepository接口包含了SpringDataJPA內(nèi)的常用到的CRUD方法，后面章節(jié)我們會拿出來分支來專門講解SpringDataJPA使用斟薇。
創(chuàng)建日志攔截器
我們上面的步驟有關(guān)請求日志的存儲已經(jīng)編寫完成师坎，那么我們接下來需要編寫一個請求日志的攔截器，自定義SpringMVC攔截器需要實現(xiàn)HandlerIntercptor接口堪滨，并且實現(xiàn)內(nèi)部的三個方法胯陋，如下圖6所示攔截器代碼詳情：
上面的三個方法在前面章節(jié)：第六章：如何在SpringBoot項目中使用攔截器已經(jīng)講過了，這里就不多做解釋了袱箱，有需要的請去看下我的第六章講解遏乔。
這里需要注意一點，我們在攔截器內(nèi)無法通過SpringBean的方式注入LoggerJPA发笔，我只能通過另外一種形式盟萨。
WebApplicationContextUtils
這個工具類可以通過HttpServletRequest請求對象的上下文（ServetCotext）獲取Spring管理的Bean，具體代碼如下圖7所示：
可以看到上圖7創(chuàng)建了一個getDAO的方法了讨，方法需要傳入一個實體的類型捻激，以及一個HttpServetRequest請求對象，通過WebApplicationContextUtils內(nèi)部的getRequiredWebApplicationContext方法獲取到BeanFactory（實體工廠類）前计，從而通過工廠實體的getBean方法就可以拿到SpringDataJPA為我們管理的LoggerJPA持久化數(shù)據(jù)接口實例胞谭。
記錄請求日志
我們處理日志請求時需要用到FastJson、HttpServet依賴男杈，所以我們修改pom.xml配置文件加入FastJson開源組件以及HttpServlet的maven依賴丈屹，如下圖8所示：
接下來我們開始編寫請求日志的創(chuàng)建，首先我們在preHandle方法內(nèi)創(chuàng)建LoggerEntity實體伶棒，并記錄一些必要參數(shù)后將實體寫入到當(dāng)前請求對象HttpServletRequest內(nèi)旺垒，如下圖9、圖10所示：
可以看到我們上面記錄了我們?nèi)罩緦嶓w內(nèi)的大部分參數(shù)苞冯，當(dāng)用戶發(fā)送請求時在進入SpringMVC的控制器之前會進入preHandle方法袖牙，然后記錄下我們的請求日志內(nèi)容，并將請求日志的實體寫入到請求對象內(nèi)舅锄，下面就會進入對應(yīng)springMVC控制器方法的方法鞭达，在最后渲染視圖即將返回前臺的時候開始執(zhí)行我們下面需要邊寫的afterCompletion方法司忱，代碼如下圖11所示：
我們在afterCompletion方法內(nèi)記錄了請求相應(yīng)碼、請求時間戳畴蹭、請求返回值等坦仍。其中請求返回值我們是在哪里設(shè)置的呢？那么我們接下來開始編寫測試請求控制器IndexController叨襟。你就會明白了繁扎。
編寫測試控制器
我們在controller包下創(chuàng)建一個IndexController并且添加@RestController注解來標明IndexController是一個restful風(fēng)格的控制器。如下圖12所示：
我們在IndexControll控制器內(nèi)簡單添加了一個測試方法login糊闽，可以看到我們在攔截器內(nèi)的疑問得到的解釋梳玫，LOGGER_RETURN是從我們的請求方法傳入到LoggerInterceptor攔截器內(nèi)afterCompletion方法中的。
配置攔截器
上述我們的代碼基本已經(jīng)編寫完成右犹，不要忘記最重要的一步提澎，我們需要將LoggerInterceptor攔截器添加到我們的SpringBoot項目內(nèi)，讓SpringBoot項目可以識別攔截念链。我們需要創(chuàng)建一個LoggerConfguration配置類盼忌，如下圖13所示：
我們的項目編碼已經(jīng)完成，下面我們來嘗試運行項目看看效果掂墓。
初嘗試運行項目
運行日志如下圖14所示谦纱，如果沒有出現(xiàn)異常證明項目運行成功了，如果出現(xiàn)異常請根據(jù)對應(yīng)異常檢查錯誤君编。
我們項目已經(jīng)運行成功跨嘉，那么我們接下來測試我們的請求日志是否可以記錄成功，我們先來訪問地址：http://127.0.0.1:8080/index/login?name=yuqiyu（簡書插入鏈接無法帶參數(shù)啦粹，請復(fù)制到地址欄訪問）偿荷，效果如下圖15所示：
可以看到我們成功的返回了在IndexControll的login方法配置的json信息，那么我的請求日志是否已經(jīng)記錄到數(shù)據(jù)庫呢唠椭？我們先來看下InteiiJ IDEA工具的控制器是否已經(jīng)打印了SQL倍谜，如下圖16所示：
可以看到已經(jīng)正常打印了羔味，我們打開表查看下數(shù)據(jù)蜜葱，如下圖17所示：
我們已經(jīng)將請求日志成功的寫入到數(shù)據(jù)庫祠够。
總結(jié)
上述內(nèi)容就是本章的全部講解，本章主要講解了SpringBoot項目如何配置日志攔截器力崇，將用戶的請求參數(shù)寫入到數(shù)據(jù)庫內(nèi)斗塘，使用SpringDataJPA以及Druid連接池完成數(shù)據(jù)的持久化操作。當(dāng)前如果要在企業(yè)級大型項目使用亮靴，還請定期清理請求日志馍盟。如果你有記錄錯誤日志發(fā)送郵件的需求，可以通過判斷HttpServertReponse對象的statusCode來完成茧吊，具體的錯誤堆棧信息記錄贞岭，需要我們后續(xù)章節(jié)講解八毯。
本章內(nèi)容已經(jīng)更新到碼云
SpringBoot配套源碼地址：https://gitee.com/hengboy/spring-boot-chapter
SpringCloud配套源碼地址：https://gitee.com/hengboy/spring-cloud-chapter
SpringBoot相關(guān)系列文章請訪問：目錄：SpringBoot學(xué)習(xí)目錄
QueryDSL相關(guān)系列文章請訪問：QueryDSL通用查詢框架學(xué)習(xí)目錄
SpringDataJPA相關(guān)系列文章請訪問：目錄：SpringDataJPA學(xué)習(xí)目錄
SpringBoot相關(guān)文章請訪問：目錄：SpringBoot學(xué)習(xí)目錄，感謝閱讀瞄桨！
歡迎微信掃碼加入知識星球话速，恒宇少年帶你走以后的技術(shù)道路！Ｐ窘摹泊交！
知識星球 - 恒宇少年
