網(wǎng)站首頁(yè) 編程語(yǔ)言 正文
前言
錯(cuò)誤日志和訪問(wèn)日志是一個(gè)服務(wù)器必須支持的功能,我們教程里使用的服務(wù)器到目前為止還沒(méi)有這兩個(gè)功能。正好前兩天也寫(xiě)了篇介紹logrus
日志庫(kù)的文章,那么今天的文章里就給我們自己寫(xiě)的服務(wù)器加上錯(cuò)誤日志和訪問(wèn)日志的功能。在介紹添加訪問(wèn)日志的時(shí)候會(huì)介紹一種通過(guò)編寫(xiě)中間件獲取HTTP
響應(yīng)的StausCode
和Body
的方法。
Go Web 編程系列的每篇文章的源代碼都打了對(duì)應(yīng)版本的軟件包,供大家參考。公眾號(hào)中回復(fù)gohttp11
獲取本文源代碼
初始化日志記錄器
我們先來(lái)做一下初始化工作,在項(xiàng)目里初始化記錄錯(cuò)誤日志和訪問(wèn)日志的記錄器Logger
。
//?./utils/vlog package?vlog import?( ????"github.com/sirupsen/logrus" ????"os" ) var?ErrorLog?*logrus.Logger var?AccessLog?*logrus.Logger var?errorLogFile?=?"./tmp/log/error.log" var?accessLogFile?=?"./tmp/log/access.log" func?init?()?{ ????initErrorLog() ????initAccessLog() } func?initErrorLog()?{ ????ErrorLog?=?logrus.New() ????ErrorLog.SetFormatter(&logrus.JSONFormatter{}) ????file?,?err?:=?os.OpenFile(errorLogFile,?os.O_RDWR?|?os.O_CREATE?|?os.O_APPEND,?0755) ????if?err?!=?nil?{ ????????panic(err) ????} ????ErrorLog.SetOutput(file) } func?initAccessLog()?{ ????AccessLog?=?logrus.New() ????AccessLog.SetFormatter(&logrus.JSONFormatter{}) ????file?,?err?:=?os.OpenFile(accessLogFile,?os.O_RDWR?|?os.O_CREATE?|?os.O_APPEND,?0755) ????if?err?!=?nil?{ ????????panic(err) ????} ????AccessLog.SetOutput(file) }
- 我們新定義一個(gè)
package
在init
函數(shù)中來(lái)初始化記錄器,這樣服務(wù)器成功啟動(dòng)前就會(huì)初始化好記錄器。 -
/tmp/log
這個(gè)目錄要提前創(chuàng)建好,執(zhí)行init
函數(shù)時(shí)會(huì)自動(dòng)創(chuàng)建好access.log
和error.log
。
添加錯(cuò)誤日志
我們創(chuàng)建服務(wù)器使用的net/http
包的Server
類(lèi)型中,有一個(gè)ErrorLog
字段供開(kāi)發(fā)者設(shè)置記錄錯(cuò)誤日志用的記錄器Logger
,默認(rèn)使用的是log
包默認(rèn)的記錄器(應(yīng)該是系統(tǒng)的標(biāo)準(zhǔn)錯(cuò)誤):
type?Server?struct?{ ???Addr????string??//?TCP?address?to?listen?on,?":http"?if?empty ???Handler?Handler?//?handler?to?invoke,?http.DefaultServeMux?if?nil ???... ???//?ErrorLog?specifies?an?optional?logger?for?errors?accepting ???//?connections,?unexpected?behavior?from?handlers,?and ???//?underlying?FileSystem?errors. ???//?If?nil,?logging?is?done?via?the?log?package's?standard?logger. ???ErrorLog?*log.Logger ?????... }
我們之前在創(chuàng)建服務(wù)器的時(shí)候自己實(shí)現(xiàn)了Server
類(lèi)型的對(duì)象,那么現(xiàn)在要做的就是將上面初始化好的錯(cuò)誤日志的記錄器指定給Server
的ErrorLog
字段。
func?main()?{ ??... ? ??//?將logrus的Logger轉(zhuǎn)換為io.Writer ????errorWriter?:=?vlog.ErrorLog.Writer() ? ??//?記得關(guān)閉io.Writer ????defer?errorWriter.Close() ????server?:=?&http.Server{ ????????Addr:????":8080", ????????Handler:?muxRouter, ? ? ? ??//?用記錄器轉(zhuǎn)換成的io.Writer創(chuàng)建log.Logger ????????ErrorLog:?log.New(vlog.ErrorLog.Writer(),?"",?0), ????} ????... }
添加好錯(cuò)誤日志的記錄器后,我們找個(gè)路由處理函數(shù),在里面故意制造運(yùn)行時(shí)錯(cuò)誤驗(yàn)證一下是否能記錄到錯(cuò)誤。
func?(*HelloHandler)?ServeHTTP(w?http.ResponseWriter,?r?*http.Request)?{ ???ints?:=?[]int{0,?1,?2} ???fmt.Fprintf(w,?"%v",?ints[0:5]) }
在上面處理函數(shù)中,通過(guò)切片表達(dá)式越界故意制造了一個(gè)運(yùn)行時(shí)錯(cuò)誤,打開(kāi)error.log
后能看到文件里已經(jīng)記錄到這個(gè)運(yùn)行時(shí)錯(cuò)誤及其Stack trace
添加訪問(wèn)日志
和Server
對(duì)象可以設(shè)置錯(cuò)誤日志的記錄器不一樣,訪問(wèn)日志只能是我們通過(guò)自己編寫(xiě)中間件的方式來(lái)實(shí)現(xiàn)了。在記錄訪問(wèn)日志的中間件里我們會(huì)記錄ip
,method
,path
,query
,request_body
,status
和response_body
這些個(gè)字段的內(nèi)容。
status
和response_body
兩個(gè)字段來(lái)自請(qǐng)求對(duì)應(yīng)的響應(yīng)。響應(yīng)在net/http
包里是用http.ResponseWriter
接口表示的
type?ResponseWriter?interface?{ ????Header()?Header ????Write([]byte)?(int,?error) ????WriteHeader(statusCode?int) }
接口本身以及net/http
提供的實(shí)現(xiàn)都沒(méi)有讓我們進(jìn)行讀取的方法,所以在編寫(xiě)的用于記錄訪問(wèn)日志的中間件里需要對(duì)net/http
庫(kù)本身實(shí)現(xiàn)的ResponseWriter
做一層包裝。
利用Go
語(yǔ)言結(jié)構(gòu)體類(lèi)型嵌套匿名類(lèi)型后,結(jié)構(gòu)體擁有了被嵌套類(lèi)型的所有導(dǎo)出字段和方法的特性,我們可以很方便地對(duì)原來(lái)的ResponseWriter
做一層包裝,然后只重新實(shí)現(xiàn)需要更改的方法即可:
type?ResponseWithRecorder?struct?{ ???http.ResponseWriter ???statusCode?int ???body?bytes.Buffer } func?(rec?*ResponseWithRecorder)?WriteHeader(statusCode?int)?{ ???rec.ResponseWriter.WriteHeader(statusCode) ???rec.statusCode?=?statusCode } func?(rec?*ResponseWithRecorder)?Write(d?[]byte)?(n?int,?err?error)?{ ???n,?err?=?rec.ResponseWriter.Write(d) ???if?err?!=?nil?{ ??????return ???} ???rec.body.Write(d) ???return }
定義好新的類(lèi)型后我們重新實(shí)現(xiàn)了WriteHeader
和Write
方法,在向原來(lái)的ReponseWriter
中寫(xiě)入后也會(huì)向ResponseWriteRecoder.statusCode和ResponseWriteRecoder.body寫(xiě)入對(duì)應(yīng)的數(shù)據(jù)。這樣我們就可以在中間件里通過(guò)這兩個(gè)字段訪問(wèn)響應(yīng)碼和響應(yīng)數(shù)據(jù)了。
記錄訪問(wèn)日志的中間件定義如下:
func?AccessLogging?(f?http.Handler)?http.Handler?{ ????//?創(chuàng)建一個(gè)新的handler包裝http.HandlerFunc ????return?http.HandlerFunc(func(w?http.ResponseWriter,?r?*http.Request)?{ ????????buf?:=?new(bytes.Buffer) ????????buf.ReadFrom(r.Body) ????????logEntry?:=?vlog.AccessLog.WithFields(logrus.Fields{ ????????????"ip":?r.RemoteAddr, ????????????"method":?r.Method, ????????????"path":?r.RequestURI, ????????????"query":?r.URL.RawQuery, ????????????"request_body":?buf.String(), ????????}) ????????wc?:=?&ResponseWithRecorder{ ????????????ResponseWriter:?w, ????????????statusCode:?http.StatusOK, ????????????body:?bytes.Buffer{}, ????????} ????????//?調(diào)用下一個(gè)中間件或者最終的handler處理程序 ????????f.ServeHTTP(wc,?r) ????????defer?logEntry.WithFields(logrus.Fields{ ????????????"status":?wc.statusCode, ????????????"response_body":?wc.body.String(), ????????}).Info() ????}) }
在Router
上應(yīng)用創(chuàng)建好的AccessLogging
中間件后,就可以正常的記錄服務(wù)器的訪問(wèn)日志了。
//?router/router.go func?RegisterRoutes(r?*mux.Router)?{ ????... ????//?apply?Logging?middleware ????r.Use(middleware.Logging(),?middleware.AccessLogging) ????... }
不過(guò)有兩點(diǎn)需要注意一下
- 這里為了演示獲取響應(yīng)數(shù)據(jù)記錄了
response_body
字段,如果是接口響應(yīng)內(nèi)容記錄下還可以,但是如果是HTML
還是不記錄的為好。 - 初始化
ResponseWithRecorder
時(shí)默認(rèn)設(shè)置了statusCode
是因?yàn)椋?wù)器正確返回響應(yīng)時(shí)不會(huì)顯式調(diào)用WriteHeader
方法,只有在返回NOT_FOUND
之類(lèi)的錯(cuò)誤的時(shí)候才會(huì)調(diào)用WriteHeader
方法,針對(duì)這種情況需要在初始化的時(shí)候把statusCode
的默認(rèn)值設(shè)置為200
。
現(xiàn)在再訪問(wèn)服務(wù)器后打開(kāi)access.log
會(huì)看到剛剛的訪問(wèn)日志,就能看到剛剛請(qǐng)求的url
,method
,客戶端IP等信息了。
{"ip":"......","level":"info","method":"GET","msg":"","path":"/index/","query":"","request_body":"","response_body":"Hello?World1","status":200,"time":"2020-03-26T04:21:46Z"}
注意:文章只為說(shuō)明演示方便,獲取IP的方法無(wú)法獲取代理后的真實(shí)IP,請(qǐng)悉知。
原文鏈接:http://170e.cn/864o
相關(guān)推薦
- 2022-02-02 css 旋轉(zhuǎn) animation動(dòng)畫(huà)
- 2023-01-28 Flutter?Widget移動(dòng)UI框架使用Material和密匙Key實(shí)戰(zhàn)_Android
- 2022-04-03 關(guān)于Rust?使用?dotenv?來(lái)設(shè)置環(huán)境變量的問(wèn)題_相關(guān)技巧
- 2023-11-19 urllib2.HTTPError: HTTP Error 403: Forbidden; in h
- 2022-02-13 group?by用法詳解_oracle
- 2022-04-23 排序會(huì)了遞歸,不學(xué)非遞歸太可惜了
- 2022-07-26 Nginx本地配置SSL訪問(wèn)的實(shí)例教程_nginx
- 2022-06-08 報(bào)錯(cuò):No fallback instance of type class**解決辦法
- 最近更新
-
- window11 系統(tǒng)安裝 yarn
- 超詳細(xì)win安裝深度學(xué)習(xí)環(huán)境2025年最新版(
- Linux 中運(yùn)行的top命令 怎么退出?
- MySQL 中decimal 的用法? 存儲(chǔ)小
- get 、set 、toString 方法的使
- @Resource和 @Autowired注解
- Java基礎(chǔ)操作-- 運(yùn)算符,流程控制 Flo
- 1. Int 和Integer 的區(qū)別,Jav
- spring @retryable不生效的一種
- Spring Security之認(rèn)證信息的處理
- Spring Security之認(rèn)證過(guò)濾器
- Spring Security概述快速入門(mén)
- Spring Security之配置體系
- 【SpringBoot】SpringCache
- Spring Security之基于方法配置權(quán)
- redisson分布式鎖中waittime的設(shè)
- maven:解決release錯(cuò)誤:Artif
- restTemplate使用總結(jié)
- Spring Security之安全異常處理
- MybatisPlus優(yōu)雅實(shí)現(xiàn)加密?
- Spring ioc容器與Bean的生命周期。
- 【探索SpringCloud】服務(wù)發(fā)現(xiàn)-Nac
- Spring Security之基于HttpR
- Redis 底層數(shù)據(jù)結(jié)構(gòu)-簡(jiǎn)單動(dòng)態(tài)字符串(SD
- arthas操作spring被代理目標(biāo)對(duì)象命令
- Spring中的單例模式應(yīng)用詳解
- 聊聊消息隊(duì)列,發(fā)送消息的4種方式
- bootspring第三方資源配置管理
- GIT同步修改后的遠(yuǎn)程分支