详解Go中gin框架如何实现带颜色日志

 更新时间:2023年04月20日 09:41:24   作者:Go学堂  
当我们在终端上(比如Goland)运行gin框架搭建的服务时,会发现输出的日志是可以带颜色的,那这是如何实现的呢?本文就来和大家简单讲讲

当我们在终端上(比如Goland)运行gin框架搭建的服务时,会发现输出的日志是可以带颜色的。比如下图中的最后一行,就是请求一个方法时的输出日志:

我们看到状态码200和请求的方法GET都带有不同颜色的背景。那么,这种带颜色的日志是如何实现的呢?

一、gin中控制日志颜色

首先,在gin框架中提供了控制日志文字是否带颜色输出的方法:DisableConsoleColorForceConsoleColor。调用方法如下:

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中如何控制日志输出的颜色功能。如果大家在自己的项目中想让终端的输出内容具有更好的颜色控制,推荐一个开源项目,其地址地址:github.com/fatih/color

以上就是详解Go中gin框架如何实现带颜色日志的详细内容,更多关于Go gin框架带颜色日志的资料请关注脚本之家其它相关文章!

相关文章

  • 基于go-cqhttp与Flask搭建定制机器人项目实战示例

    基于go-cqhttp与Flask搭建定制机器人项目实战示例

    这篇文章主要为大家介绍了基于go-cqhttp与Flask搭建定制机器人项目实战示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • gin 获取post请求的json body操作

    gin 获取post请求的json body操作

    这篇文章主要介绍了gin 获取post请求的json body操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-03-03
  • Go通过不变性优化程序详解

    Go通过不变性优化程序详解

    这篇文章主要为大家介绍了Go通过不变性优化程序实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • golang基于Mutex实现可重入锁

    golang基于Mutex实现可重入锁

    锁可重入也就是当前已经获取到锁的goroutine继续调用Lock方法获取锁,Go标准库中提供了sync.Mutex实现了排他锁,但并不是可重入的,所以本文给大家介绍了golang基于Mutex实现可重入锁,文中有详细的代码示例,需要的朋友可以参考下
    2024-03-03
  • golang 将[]byte转成16进制的实现

    golang 将[]byte转成16进制的实现

    这篇文章主要介绍了golang 将[]byte转成16进制的实现,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Golang测试框架goconvey进行单元测试流程介绍

    Golang测试框架goconvey进行单元测试流程介绍

    goconvey是一款针对Golang的测试框架,可以管理和运行测试用例,同时提供了丰富的断言函数,并支持很多Web界面特性,这篇文章主要介绍了使用goconvey进行单元测试流程,感兴趣的同学可以参考下文
    2023-05-05
  • Go语言中的各类运算操作符详解

    Go语言中的各类运算操作符详解

    本文全面探讨了Go语言中的各类运算操作符,从基础的数学和位运算到逻辑和特殊运算符,文章旨在深入解析每一种运算操作符的工作原理、应用场景和注意事项,以帮助开发者编写更高效、健壮和可读的Go代码,</P><P>
    2023-09-09
  • 浅析Go语言中闭包的使用

    浅析Go语言中闭包的使用

    闭包是一个函数和其相关的引用环境组合的一个整体。本文主要为大家介绍一下Go语言中闭包的使用,文中的示例代码讲解详细,对我们学习Go语言有一定帮助,需要的可以参考一下
    2022-12-12
  • golang flag包的使用教程

    golang flag包的使用教程

    golang 的 flag 包是用于处理命令行参数的工具包,我们可以基于这个包来开发自定义的命令行工具,下面小编就来为大家介绍一下flag包的具体使用吧
    2023-09-09
  • 一文教你如何快速学会Go的切片和数组数据类型

    一文教你如何快速学会Go的切片和数组数据类型

    数组是属于同一类型的元素的集合。切片是数组顶部的方便、灵活且功能强大的包装器。本文就来和大家聊聊Go中切片和数组的使用,需要的可以参考一下
    2023-03-03

最新评论