請(qǐng)求日志幾乎是所有大型企業(yè)級(jí)項(xiàng)目的必要的模塊，請(qǐng)求日志對(duì)于我們來(lái)說(shuō)后期在項(xiàng)目運(yùn)行上線一段時(shí)間用于排除異常、請(qǐng)求分流處理、限制流量等。請(qǐng)求日志一般都會(huì)記錄請(qǐng)求參數(shù)、請(qǐng)求地址、請(qǐng)求狀態(tài)（Status Code）、SessionId、請(qǐng)求方法方式（Method）、請(qǐng)求時(shí)間、客戶端IP地址、請(qǐng)求返回內(nèi)容、耗時(shí)等等。如果你得系統(tǒng)還有其他個(gè)性化的配置，也可以完成記錄。
免費(fèi)專題文章匯總
恒宇少年在博客整理出來(lái)了SpringBoot、ApiBoot、SpringCloud的文章匯總【SpringBoot基礎(chǔ)教程專題】，【SpringCloud基礎(chǔ)教程專題】，【ApiBoot組件使用專題】
本章目標(biāo)
通過(guò)SpringBoot整合與攔截器整合完成請(qǐng)求日志的記錄，本章節(jié)日志記錄使用SpringDataJPA與MySQL數(shù)據(jù)庫(kù)記錄。
構(gòu)建項(xiàng)目
我們使用InteiiJ IDEA創(chuàng)建一個(gè)SpringBoot項(xiàng)目，預(yù)先依賴模塊有Web、JPA、MySQL、Druid等。項(xiàng)目結(jié)構(gòu)如下圖1所示：
配置數(shù)據(jù)源
我們直接從之前的項(xiàng)目中復(fù)制一個(gè)application.yml文件到/resource下，application.yml內(nèi)容如下圖2所示：
創(chuàng)建數(shù)據(jù)表結(jié)構(gòu)
我們把請(qǐng)求日志直接保存到本地的MySQL數(shù)據(jù)庫(kù)內(nèi)，下面我們先來(lái)創(chuàng)建一個(gè)請(qǐng)求日志表，結(jié)構(gòu)如下圖3所示：
我們表結(jié)構(gòu)內(nèi)的字段比較多，數(shù)據(jù)結(jié)構(gòu)創(chuàng)建完成后，接下來(lái)根據(jù)表結(jié)構(gòu)創(chuàng)建實(shí)體并配置實(shí)體JPA，如下圖4所示：
可以看到上圖4，我們對(duì)應(yīng)數(shù)據(jù)庫(kù)內(nèi)的表名以及字段名創(chuàng)建實(shí)體映射、字段映射，根據(jù)實(shí)體我們創(chuàng)建一個(gè)實(shí)現(xiàn)SpringDataJPA接口JpaRepository的子接口，LoggerJPA，如下圖5所示：
JpaRepository接口包含了SpringDataJPA內(nèi)的常用到的CRUD方法，后面章節(jié)我們會(huì)拿出來(lái)分支來(lái)專門(mén)講解SpringDataJPA使用。
創(chuàng)建日志攔截器
我們上面的步驟有關(guān)請(qǐng)求日志的存儲(chǔ)已經(jīng)編寫(xiě)完成，那么我們接下來(lái)需要編寫(xiě)一個(gè)請(qǐng)求日志的攔截器，自定義SpringMVC攔截器需要實(shí)現(xiàn)HandlerIntercptor接口，并且實(shí)現(xiàn)內(nèi)部的三個(gè)方法，如下圖6所示攔截器代碼詳情：
上面的三個(gè)方法在前面章節(jié)：第六章：如何在SpringBoot項(xiàng)目中使用攔截器已經(jīng)講過(guò)了，這里就不多做解釋了，有需要的請(qǐng)去看下我的第六章講解。
這里需要注意一點(diǎn)，我們?cè)跀r截器內(nèi)無(wú)法通過(guò)SpringBean的方式注入LoggerJPA，我只能通過(guò)另外一種形式。
WebApplicationContextUtils
這個(gè)工具類可以通過(guò)HttpServletRequest請(qǐng)求對(duì)象的上下文（ServetCotext）獲取Spring管理的Bean，具體代碼如下圖7所示：
可以看到上圖7創(chuàng)建了一個(gè)getDAO的方法，方法需要傳入一個(gè)實(shí)體的類型，以及一個(gè)HttpServetRequest請(qǐng)求對(duì)象，通過(guò)WebApplicationContextUtils內(nèi)部的getRequiredWebApplicationContext方法獲取到BeanFactory（實(shí)體工廠類），從而通過(guò)工廠實(shí)體的getBean方法就可以拿到SpringDataJPA為我們管理的LoggerJPA持久化數(shù)據(jù)接口實(shí)例。
記錄請(qǐng)求日志
我們處理日志請(qǐng)求時(shí)需要用到FastJson、HttpServet依賴，所以我們修改pom.xml配置文件加入FastJson開(kāi)源組件以及HttpServlet的maven依賴，如下圖8所示：
接下來(lái)我們開(kāi)始編寫(xiě)請(qǐng)求日志的創(chuàng)建，首先我們?cè)?b>preHandle方法內(nèi)創(chuàng)建LoggerEntity實(shí)體，并記錄一些必要參數(shù)后將實(shí)體寫(xiě)入到當(dāng)前請(qǐng)求對(duì)象HttpServletRequest內(nèi)，如下圖9、圖10所示：
可以看到我們上面記錄了我們?nèi)罩緦?shí)體內(nèi)的大部分參數(shù)，當(dāng)用戶發(fā)送請(qǐng)求時(shí)在進(jìn)入SpringMVC的控制器之前會(huì)進(jìn)入preHandle方法，然后記錄下我們的請(qǐng)求日志內(nèi)容，并將請(qǐng)求日志的實(shí)體寫(xiě)入到請(qǐng)求對(duì)象內(nèi)，下面就會(huì)進(jìn)入對(duì)應(yīng)springMVC控制器方法的方法，在最后渲染視圖即將返回前臺(tái)的時(shí)候開(kāi)始執(zhí)行我們下面需要邊寫(xiě)的afterCompletion方法，代碼如下圖11所示：
我們?cè)?b>afterCompletion方法內(nèi)記錄了請(qǐng)求相應(yīng)碼、請(qǐng)求時(shí)間戳、請(qǐng)求返回值等。其中請(qǐng)求返回值我們是在哪里設(shè)置的呢？那么我們接下來(lái)開(kāi)始編寫(xiě)測(cè)試請(qǐng)求控制器IndexController。你就會(huì)明白了。
編寫(xiě)測(cè)試控制器
我們?cè)赾ontroller包下創(chuàng)建一個(gè)IndexController并且添加@RestController注解來(lái)標(biāo)明IndexController是一個(gè)restful風(fēng)格的控制器。如下圖12所示：
我們?cè)贗ndexControll控制器內(nèi)簡(jiǎn)單添加了一個(gè)測(cè)試方法login，可以看到我們?cè)跀r截器內(nèi)的疑問(wèn)得到的解釋，LOGGER_RETURN是從我們的請(qǐng)求方法傳入到LoggerInterceptor攔截器內(nèi)afterCompletion方法中的。
配置攔截器
上述我們的代碼基本已經(jīng)編寫(xiě)完成，不要忘記最重要的一步，我們需要將LoggerInterceptor攔截器添加到我們的SpringBoot項(xiàng)目?jī)?nèi)，讓SpringBoot項(xiàng)目可以識(shí)別攔截。我們需要?jiǎng)?chuàng)建一個(gè)LoggerConfguration配置類，如下圖13所示：
我們的項(xiàng)目編碼已經(jīng)完成，下面我們來(lái)嘗試運(yùn)行項(xiàng)目看看效果。
初嘗試運(yùn)行項(xiàng)目
運(yùn)行日志如下圖14所示，如果沒(méi)有出現(xiàn)異常證明項(xiàng)目運(yùn)行成功了，如果出現(xiàn)異常請(qǐng)根據(jù)對(duì)應(yīng)異常檢查錯(cuò)誤。
我們項(xiàng)目已經(jīng)運(yùn)行成功，那么我們接下來(lái)測(cè)試我們的請(qǐng)求日志是否可以記錄成功，我們先來(lái)訪問(wèn)地址：http://127.0.0.1:8080/index/login?name=yuqiyu（簡(jiǎn)書(shū)插入鏈接無(wú)法帶參數(shù)，請(qǐng)復(fù)制到地址欄訪問(wèn)），效果如下圖15所示：
可以看到我們成功的返回了在IndexControll的login方法配置的json信息，那么我的請(qǐng)求日志是否已經(jīng)記錄到數(shù)據(jù)庫(kù)呢？我們先來(lái)看下InteiiJ IDEA工具的控制器是否已經(jīng)打印了SQL，如下圖16所示：
可以看到已經(jīng)正常打印了，我們打開(kāi)表查看下數(shù)據(jù)，如下圖17所示：
我們已經(jīng)將請(qǐng)求日志成功的寫(xiě)入到數(shù)據(jù)庫(kù)。
總結(jié)
上述內(nèi)容就是本章的全部講解，本章主要講解了SpringBoot項(xiàng)目如何配置日志攔截器，將用戶的請(qǐng)求參數(shù)寫(xiě)入到數(shù)據(jù)庫(kù)內(nèi)，使用SpringDataJPA以及Druid連接池完成數(shù)據(jù)的持久化操作。當(dāng)前如果要在企業(yè)級(jí)大型項(xiàng)目使用，還請(qǐng)定期清理請(qǐng)求日志。如果你有記錄錯(cuò)誤日志發(fā)送郵件的需求，可以通過(guò)判斷HttpServertReponse對(duì)象的statusCode來(lái)完成，具體的錯(cuò)誤堆棧信息記錄，需要我們后續(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)系列文章請(qǐng)?jiān)L問(wèn)：目錄：SpringBoot學(xué)習(xí)目錄
QueryDSL相關(guān)系列文章請(qǐng)?jiān)L問(wèn)：QueryDSL通用查詢框架學(xué)習(xí)目錄
SpringDataJPA相關(guān)系列文章請(qǐng)?jiān)L問(wèn)：目錄：SpringDataJPA學(xué)習(xí)目錄
SpringBoot相關(guān)文章請(qǐng)?jiān)L問(wèn)：目錄：SpringBoot學(xué)習(xí)目錄，感謝閱讀！
歡迎微信掃碼加入知識(shí)星球，恒宇少年帶你走以后的技術(shù)道路！！！
知識(shí)星球 - 恒宇少年
