简介

本文接着上文(Golang GinWeb框架2-文件上传/程序panic崩溃后自定义处理方式)继续探索GinWeb框架


记录日志到文件

利用io.MultiWriter多写出器可以实现日志记录到文件的同时也输出到控制台

  1. package main 
  2.  
  3. import ( 
  4.   "github.com/gin-gonic/gin" 
  5.   "io" 
  6.   "os" 
  7. ) 
  8.  
  9. func main() { 
  10.   // Disable Console Color, you don't need console color when writing the logs to file. 
  11.   // 禁用控制台日志颜色,日志写到文件的时候,不需要打开控制台日志颜色 
  12.   gin.DisableConsoleColor() 
  13.   // Logging to a file.  新建日志文件,得到文件结构,文件结构实现了写出器Writer接口 
  14.   f, _ := os.Create("gin.log") 
  15.   //io.MultiWriter(多写出器方法)创建一个写出器, 将传入的多个写出器追加为一个写出器数组, 得到的写出器实现了Writer接口, 它会将需要写出的数据写出到每个写出器, 就像Unix命令tee,会将数据写入文件的同时打印到标准输出 
  16.   //配置Gin默认日志写出器为得到的多写出器 
  17.   gin.DefaultWriter = io.MultiWriter(f) 
  18.   // Use the following code if you need to write the logs to file and console at the same time. 
  19.   // 使用下面的代码,将日志写入文件的同时,也输出到控制台 
  20.   // gin.DefaultWriter = io.MultiWriter(f, os.Stdout) 
  21.  
  22.   router := gin.Default() 
  23.   router.GET("/ping", func(c *gin.Context) { 
  24.     c.String(200, "pong") 
  25.   }) 
  26.  
  27.   router.Run(":8080") 
  28. } 

自定义日志格式

利用Gin的LoggerWithFormatter方法实例化一个日志器Logger中间件,并带有指定的日志格式

  1. package main 
  2.  
  3. import ( 
  4.   "fmt" 
  5.   "github.com/gin-gonic/gin" 
  6.   "time" 
  7. ) 
  8.  
  9. func main() { 
  10.   router := gin.New() 
  11.  
  12.   // LoggerWithFormatter middleware will write the logs to gin.DefaultWriter 
  13.   // By default gin.DefaultWriter = os.Stdout 
  14.   // type LogFormatter func(params LogFormatterParams) string 这里的LogFormatterParams是一个格式化日志参数的结构体 
  15.   router.Use(gin.LoggerWithFormatter(func(param gin.LogFormatterParams) string { 
  16.     // your custom format 
  17.     // 127.0.0.1 - [Sun, 22 Nov 2020 17:09:53 CST] "GET /ping HTTP/1.1 200 56.113µs "curl/7.64.1" " 
  18.     return fmt.Sprintf("%s - [%s] \"%s %s %s %d %s \"%s\" %s\"\n", 
  19.       param.ClientIP,                       //请求客户端的IP地址 
  20.       param.TimeStamp.Format(time.RFC1123), //请求时间 
  21.       param.Method,                         //请求方法 
  22.       param.Path,                           //路由路径 
  23.       param.Request.Proto,                  //请求协议 
  24.       param.StatusCode,                     //http响应码 
  25.       param.Latency,                        //请求到响应的延时 
  26.       param.Request.UserAgent(),            //客户端代理程序 
  27.       param.ErrorMessage,                   //如果有错误,也打印错误信息 
  28.     ) 
  29.   })) 
  30.   router.Use(gin.Recovery()) 
  31.  
  32.   router.GET("/ping", func(c *gin.Context) { 
  33.     c.String(200, "pong") 
  34.   }) 
  35.  
  36.   router.Run(":8080") 
  37. } 
  38. //模拟请求测试: curl http://localhost:8080/ping 

打开/禁用日志颜色

  • gin.DisableConsoleColor() 禁用日志颜色
  • gin.ForceConsoleColor() 强制开启日志颜色, 采用虚拟终端TTY颜色方案
  1. package main 
  2.  
  3. import ( 
  4.   "github.com/gin-gonic/gin" 
  5. ) 
  6.  
  7. func main() { 
  8.   // 默认输出到控制台的日志颜色是根据您使用的虚拟终端TTY来着色的 
  9.   // Disable log's color 禁用日志颜色 
  10.   gin.DisableConsoleColor() 
  11.  
  12.   // Force log's color 强制开启日志颜色 
  13.   //gin.ForceConsoleColor() 
  14.  
  15.   // Creates a gin router with default middleware: 
  16.   // logger and recovery (crash-free) middleware 
  17.   router := gin.Default() 
  18.  
  19.   router.GET("/ping", func(c *gin.Context) { 
  20.     c.String(200, "pong") 
  21.   }) 
  22.  
  23.   router.Run(":8080") 
  24. } 
  25.  
  26. //模拟请求测试: curl http://localhost:8080/ping 

参考文档

Gin官方仓库:https://github.com/gin-gonic/gin