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
}

以上就是我們介紹的在 gin 中如何控制日誌輸出的顏色功能。如果大家在自己的項目中想讓終端的輸出內容具有更好的顏色控制，推薦一個開源項目，其地址地址：https://github.com/fatih/color

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/eHtIC5egDoqx4LdAvcE5Qw

一、gin 中控制日誌顏色

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

猜你喜歡