详解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框架带颜色日志的资料请关注脚本之家其它相关文章!

相关文章

  • golang中protobuf的使用详解

    golang中protobuf的使用详解

    protobuf是Google公司提出的一种轻便高效的结构化数据存储格式,常用于结构化数据的序列化,具有语言无关、平台无关、可扩展性特性,常用于通讯协议、服务端数据交换场景,下面我们就来看看golang中protobuf的具体使用吧
    2023-10-10
  • Golang 基础之函数使用(匿名递归闭包)实例详解

    Golang 基础之函数使用(匿名递归闭包)实例详解

    这篇文章主要为大家介绍了Golang 基础之函数使用(匿名递归闭包)实例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-10-10
  • 深入解析Sync.Pool如何提升Go程序性能

    深入解析Sync.Pool如何提升Go程序性能

    在并发编程中,资源的分配和回收是一个很重要的问题。Go 语言的 Sync.Pool 是一个可以帮助我们优化这个问题的工具。本篇文章将会介绍 Sync.Pool 的用法、原理以及如何在项目中正确使用它,希望对大家有所帮助
    2023-05-05
  • Golang实现HTTP编程请求和响应

    Golang实现HTTP编程请求和响应

    本文主要介绍了Golang实现HTTP编程请求和响应,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • 完美解决golang go get私有仓库的问题

    完美解决golang go get私有仓库的问题

    这篇文章主要介绍了完美解决golang go get私有仓库的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • 深入理解 Go 中的字符串

    深入理解 Go 中的字符串

    这篇文章主要介绍了深入理解 Go 中的字符串,在编程语言中,字符串发挥着重要的角色。字符串背后的数据结构一般有两种类型,一种在编译时指定长度不能修改,一种具有动态的长度可以修改,下文更多相关资料需要的小伙伴可以参考一下
    2022-05-05
  • 一文搞懂Golang 值传递还是引用传递

    一文搞懂Golang 值传递还是引用传递

    最多人犯迷糊的就是 slice、map、chan 等类型,都会认为是 “引用传递”,从而认为 Go 语言的 xxx 就是引用传递。正因为它们还引用类型(指针、map、slice、chan等这些),这样就可以修改原内容数据,这篇文章主要介绍了Golang 值传递还是引用传递,需要的朋友可以参考下
    2023-01-01
  • Go语言里切片slice的用法介绍

    Go语言里切片slice的用法介绍

    这篇文章介绍了Go语言里切片slice的用法,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • Go语言实现一个简单的并发聊天室的项目实战

    Go语言实现一个简单的并发聊天室的项目实战

    本文主要介绍了Go语言实现一个简单的并发聊天室的项目实战,文中根据实例编码详细介绍的十分详尽,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • 详解如何在golang项目开发中创建自己的Module

    详解如何在golang项目开发中创建自己的Module

    既然我们使用了很多开源的 module为我们的日常开发提供了很多的便捷性,那我们该如何实现自己的 module 来提供给团队中使用,接下小编就给大家介绍一下在golang项目开发如何创建自己的Module,需要的朋友可以参考下
    2023-09-09

最新评论