详解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
}

来源：https://juejin.cn/post/7223779544368922685