Go中gin框架怎么實現帶顏色日志

本篇內容主要講解“Go中gin框架怎么實現帶顏色日志”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“Go中gin框架怎么實現帶顏色日志”吧!

當我們在終端上（比如Goland）運行gin框架搭建的服務時，會發現輸出的日志是可以帶顏色的。比如下圖中的最后一行，就是請求一個方法時的輸出日志：

我們看到狀態碼200和請求的方法GET都帶有不同顏色的背景。那么，這種帶顏色的日志是如何實現的呢？

一、gin中控制日志顏色

首先，在gin框架中提供了控制日志文字是否帶顏色輸出的方法：DisableConsoleColor和ForceConsoleColor。調用方法如下：

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)

	})

  // 調用該函數，則禁用日志帶顏色輸出
	gin.DisableConsoleColor()
  
  //使用該函數，則強制日志帶顏色輸出，無論是在終端還是其他輸出設備 
	gin.ForceConsoleColor()

	r.Run("127.0.0.1:8080")
}

這里要注意的就是，如果這兩個函數都不調用，那么默認是在終端中輸出日志是帶顏色的，輸出到其他地方是不帶顏色的。

如下，我們將gin的日志輸出到文件中，并分別查看使用gin.ForceConsoleColor函數和不使用gin.ForceConsoleColor的日志區別。

那么，當我們使用tail -n 10 log2.out，在終端上顯示該文件的內容時，第一行就會按顏色顯示，第二行就沒有顏色。如下：

二、終端輸出文字顏色是如何實現的

其實現原理實際上是應用了ANSI的換碼符。所謂換碼符就是一套編碼規則，用于控制終端上的光標位置、顏色和其他選項。

**在ascii碼表中，換碼符的字符標識是：**ESC (escape)，其對應的8進制、10進制和16進制以及unicode碼分別如下：

Octal: \033
Decimal: 27
Hexadecimal: \x1B
Unicode: \u001b

在linux終端中，顏色的控制使用“\033[”開頭，以"m"結尾的方式設置特定的顏色。比如在gin框架中對顏色常量的定義如下：

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"
)

其中 ";"字符前后的數字分別表示字體的背景色和前景色（字體顏色）。

在gin的框架中，顏色的輸出是在函數defaultLogFormatter的fmt.Sprintf函數將顏色控制碼輸出到終端上的。如下：

// 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,
	)
}

而該函數的應用是在日志中間件中使用的。比如在使用gin.Default函數構建Engine對象時，就默認給Engine帝鄉使用了Logger中間件。如下：

func Default() *Engine {
    debugPrintWARNINGDefault()
    engine := New()
    engine.Use(Logger(), Recovery())
    return engine
}

到此，相信大家對“Go中gin框架怎么實現帶顏色日志”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！