詳解Go中g(shù)in框架如何實(shí)現(xiàn)帶顏色日志
當(dāng)我們?cè)诮K端上(比如Goland)運(yùn)行g(shù)in框架搭建的服務(wù)時(shí),會(huì)發(fā)現(xiàn)輸出的日志是可以帶顏色的。比如下圖中的最后一行,就是請(qǐng)求一個(gè)方法時(shí)的輸出日志:
我們看到狀態(tài)碼200和請(qǐng)求的方法GET都帶有不同顏色的背景。那么,這種帶顏色的日志是如何實(shí)現(xiàn)的呢?
一、gin中控制日志顏色
首先,在gin框架中提供了控制日志文字是否帶顏色輸出的方法:DisableConsoleColor
和ForceConsoleColor
。調(diào)用方法如下:
package main import ( "github.com/gin-gonic/gin" "log" "net/http" ) func main() { r := gin.Default() r.GET("/", func(c *gin.Context) { names := []string{"Hello", "World", ""} c.SecureJSON(http.StatusOK, names) }) // 調(diào)用該函數(shù),則禁用日志帶顏色輸出 gin.DisableConsoleColor() //使用該函數(shù),則強(qiáng)制日志帶顏色輸出,無論是在終端還是其他輸出設(shè)備 gin.ForceConsoleColor() r.Run("127.0.0.1:8080") }
這里要注意的就是,如果這兩個(gè)函數(shù)都不調(diào)用,那么默認(rèn)是在終端中輸出日志是帶顏色的,輸出到其他地方是不帶顏色的。
如下,我們將gin的日志輸出到文件中,并分別查看使用gin.ForceConsoleColor函數(shù)和不使用gin.ForceConsoleColor的日志區(qū)別。
那么,當(dāng)我們使用tail -n 10 log2.out
,在終端上顯示該文件的內(nèi)容時(shí),第一行就會(huì)按顏色顯示,第二行就沒有顏色。如下:
二、終端輸出文字顏色是如何實(shí)現(xiàn)的
其實(shí)現(xiàn)原理實(shí)際上是應(yīng)用了ANSI的換碼符。所謂換碼符就是一套編碼規(guī)則,用于控制終端上的光標(biāo)位置、顏色和其他選項(xiàng)。
**在ascii碼表中,換碼符的字符標(biāo)識(shí)是:**ESC (escape),其對(duì)應(yīng)的8進(jìn)制、10進(jìn)制和16進(jìn)制以及unicode碼分別如下:
Octal: \033 Decimal: 27 Hexadecimal: \x1B Unicode: \u001b
在linux終端中,顏色的控制使用“\033[”開頭,以"m"結(jié)尾的方式設(shè)置特定的顏色。比如在gin框架中對(duì)顏色常量的定義如下:
const ( green = "\033[97;42m" white = "\033[90;47m" yellow = "\033[90;43m" red = "\033[97;41m" blue = "\033[97;44m" magenta = "\033[97;45m" cyan = "\033[97;46m" reset = "\033[0m" )
其中 ";"
字符前后的數(shù)字分別表示字體的背景色和前景色(字體顏色)。
在gin的框架中,顏色的輸出是在函數(shù)defaultLogFormatter
的fmt.Sprintf函數(shù)將顏色控制碼輸出到終端上的。如下:
// defaultLogFormatter is the default log format function Logger middleware uses. var defaultLogFormatter = func(param LogFormatterParams) string { var statusColor, methodColor, resetColor string if param.IsOutputColor() { statusColor = param.StatusCodeColor() methodColor = param.MethodColor() resetColor = param.ResetColor() } if param.Latency > time.Minute { param.Latency = param.Latency.Truncate(time.Second) } return fmt.Sprintf("[GIN] %v |%s %3d %s| %13v | %15s |%s %-7s %s %#v\n%s", param.TimeStamp.Format("2006/01/02 - 15:04:05"), statusColor, param.StatusCode, resetColor, param.Latency, param.ClientIP, methodColor, param.Method, resetColor, param.Path, param.ErrorMessage, ) }
而該函數(shù)的應(yīng)用是在日志中間件中使用的。比如在使用gin.Default函數(shù)構(gòu)建Engine對(duì)象時(shí),就默認(rèn)給Engine帝鄉(xiāng)使用了Logger中間件。如下:
func Default() *Engine { debugPrintWARNINGDefault() engine := New() engine.Use(Logger(), Recovery()) return engine }
以上就是我們介紹的在gin中如何控制日志輸出的顏色功能。如果大家在自己的項(xiàng)目中想讓終端的輸出內(nèi)容具有更好的顏色控制,推薦一個(gè)開源項(xiàng)目,其地址地址:github.com/fatih/color
以上就是詳解Go中g(shù)in框架如何實(shí)現(xiàn)帶顏色日志的詳細(xì)內(nèi)容,更多關(guān)于Go gin框架帶顏色日志的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Golang 基礎(chǔ)之函數(shù)使用(匿名遞歸閉包)實(shí)例詳解
這篇文章主要為大家介紹了Golang 基礎(chǔ)之函數(shù)使用(匿名遞歸閉包)實(shí)例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-10-10Golang實(shí)現(xiàn)HTTP編程請(qǐng)求和響應(yīng)
本文主要介紹了Golang實(shí)現(xiàn)HTTP編程請(qǐng)求和響應(yīng),文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-08-08Go語言實(shí)現(xiàn)一個(gè)簡(jiǎn)單的并發(fā)聊天室的項(xiàng)目實(shí)戰(zhàn)
本文主要介紹了Go語言實(shí)現(xiàn)一個(gè)簡(jiǎn)單的并發(fā)聊天室的項(xiàng)目實(shí)戰(zhàn),文中根據(jù)實(shí)例編碼詳細(xì)介紹的十分詳盡,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-03-03詳解如何在golang項(xiàng)目開發(fā)中創(chuàng)建自己的Module
既然我們使用了很多開源的 module為我們的日常開發(fā)提供了很多的便捷性,那我們?cè)撊绾螌?shí)現(xiàn)自己的 module 來提供給團(tuán)隊(duì)中使用,接下小編就給大家介紹一下在golang項(xiàng)目開發(fā)如何創(chuàng)建自己的Module,需要的朋友可以參考下2023-09-09