Go之Zap日志庫集成Gin

簡介

在許多Go語言項目中，我們需要一個好的日志記錄器能夠提供下面這些功能:
1 . 能夠將事件記錄到文件中，而不是應用程序控制台;
2 . 日志切割-能夠根據文件大小、時間或間隔等來切割日志文件;
3 . 支持不同的日志級別。例如INFO，DEBUG，ERROR等;
4 . 能夠打印基本信息，如調用文件/函數名和行號，日志時間等;

默認的是Logger

在介紹Uber-go的zap包之前，讓我們先看看Go語言提供的基本日志功能。Go語言提供的默認日志包是https://golang.org/pkg/log/;

默認Go Logger

實現一個Go語言中的日志記錄器非常簡單——創建一個新的日志文件，然后設置它為日志的輸出位置;
**

設置Logger

我們可以像下面的代碼一樣設置日志記錄器

func SetupLogger() {
	logFileLocation, _ := os.OpenFile("/Users/q1mi/test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744)
	log.SetOutput(logFileLocation)
}

使用Logger

讓我們來寫一些虛擬的代碼來使用這個日志記錄器。
在當前的示例中，我們將建立一個到URL的HTTP連接，並將狀態代碼/錯誤記錄到日志文件中。

func simpleHttpGet(url string) {
	resp, err := http.Get(url)
	if err != nil {
		log.Printf("Error fetching url %s : %s", url, err.Error())
	} else {
		log.Printf("Status Code for %s : %s", url, resp.Status)
		resp.Body.Close()
	}
}

Logger的運行

現在讓我們執行上面的代碼並查看日志記錄器的運行情況。

func main() {
	SetupLogger()
	simpleHttpGet("www.google.com")
	simpleHttpGet("http://www.google.com")
}

當我們執行上面的代碼，我們能看到一個test.log文件被創建，下面的內容會被添加到這個日志文件中;

2019/05/24 01:14:13 Error fetching url www.google.com : Get www.google.com: unsupported protocol scheme ""
2019/05/24 01:14:14 Status Code for http://www.google.com : 200 OK

Go Logger的優勢和劣勢

優勢
它最大的優點是使用非常簡單。我們可以設置任何io.Writer作為日志記錄輸出並向其發送要寫入的日志;

劣勢

• 僅限基本的日志級別
  • 只有一個Print選項。不支持INFO/DEBUG等多個級別;
• 對於錯誤日志，它有Fatal和Panic
  • Fatal日志通過調用os.Exit(1)來結束程序;
  • Panic日志在寫入日志消息之后拋出一個panic;
  • 但是它缺少一個ERROR日志級別，這個級別可以在不拋出panic或退出程序的情況下記錄錯誤
• 缺乏日志格式化的能力——例如記錄調用者的函數名和行號，格式化日期和時間格式。等等;
• 不提供日志切割的能力;

Uber-go Zap

Zap是非常快的、結構化的，分日志級別的Go日志庫;
**

為什么選擇Uber-go zap

• 它同時提供了結構化日志記錄和printf風格的日志記錄
• 它非常的快

根據Uber-go Zap的文檔，它的性能比類似的結構化日志包更好——也比標准庫更快。 以下是Zap發布的基准測試信息

記錄一條消息和10個字段:

Package	Time	Time % to zap	Objects Allocated
⚡️ zap	862 ns/op	+0%	5 allocs/op
⚡️ zap (sugared)	1250 ns/op	+45%	11 allocs/op
zerolog	4021 ns/op	+366%	76 allocs/op
go-kit	4542 ns/op	+427%	105 allocs/op
apex/log	26785 ns/op	+3007%	115 allocs/op
logrus	29501 ns/op	+3322%	125 allocs/op
log15	29906 ns/op	+3369%	122 allocs/op

記錄一個靜態字符串，沒有任何上下文或printf風格的模板:
**

Package	Time	Time % to zap	Objects Allocated
⚡️ zap	118 ns/op	+0%	0 allocs/op
⚡️ zap (sugared)	191 ns/op	+62%	2 allocs/op
zerolog	93 ns/op	-21%	0 allocs/op
go-kit	280 ns/op	+137%	11 allocs/op
standard library	499 ns/op	+323%	2 allocs/op
apex/log	1990 ns/op	+1586%	10 allocs/op
logrus	3129 ns/op	+2552%	24 allocs/op
log15	3887 ns/op	+3194%	23 allocs/op

安裝

運行下面的命令安裝zap
**

go get -u go.uber.org/zap

配置Zap Logger

Zap提供了兩種類型的日志記錄器—Sugared Logger和Logger。
在性能很好但不是很關鍵的上下文中，使用SugaredLogger。它比其他結構化日志記錄包快4-10倍，並且支持結構化和printf風格的日志記錄;
在每一微秒和每一次內存分配都很重要的上下文中，使用Logger。它甚至比SugaredLogger更快，內存分配次數也更少，但它只支持強類型的結構化日志記錄;

Logger

• 通過調用zap.NewProduction()/zap.NewDevelopment()或者zap.Example()創建一個Logger;
• 上面的每一個函數都將創建一個logger。唯一的區別在於它將記錄的信息不同。例如production logger默認記錄調用函數信息、日期和時間等;
• 通過Logger調用Info/Error等;
• 默認情況下日志都會打印到應用程序的console界面;

var logger *zap.Logger
func main() {
	InitLogger()
  defer logger.Sync()
	simpleHttpGet("www.google.com")
	simpleHttpGet("http://www.google.com")
}
func InitLogger() {
	logger, _ = zap.NewProduction()
}
func simpleHttpGet(url string) {
	resp, err := http.Get(url)
	if err != nil {
		logger.Error(
			"Error fetching url..",
			zap.String("url", url),
			zap.Error(err))
	} else {
		logger.Info("Success..",
			zap.String("statusCode", resp.Status),
			zap.String("url", url))
		resp.Body.Close()
	}
}

在上面的代碼中，我們首先創建了一個Logger，然后使用Info/ Error等Logger方法記錄消息;
日志記錄器方法的語法是這樣的:
**

func (log *Logger) MethodXXX(msg string, fields ...Field)

其中MethodXXX是一個可變參數函數，可以是Info / Error/ Debug / Panic等。每個方法都接受一個消息字符串和任意數量的zapcore.Field場參數;

每個zapcore.Field其實就是一組鍵值對參數;
我們執行上面的代碼會得到如下輸出結果:

{"level":"error","ts":1572159218.912792,"caller":"zap_demo/temp.go:25","msg":"Error fetching url..","url":"www.sogo.com","error":"Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/temp.go:25\nmain.main\n\t/Users/q1mi/zap_demo/temp.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"}
{"level":"info","ts":1572159219.1227388,"caller":"zap_demo/temp.go:30","msg":"Success..","statusCode":"200 OK","url":"http://www.sogo.com"}

Sugared Logger

現在讓我們使用Sugared Logger來實現相同的功能;

• 大部分的實現基本都相同;
• 惟一的區別是，我們通過調用主logger的. Sugar()方法來獲取一個SugaredLogger;
• 然后使用SugaredLogger以printf格式記錄語句

下面是修改過后使用SugaredLogger代替Logger的代碼:
**

var sugarLogger *zap.SugaredLogger
func main() {
	InitLogger()
	defer sugarLogger.Sync()
	simpleHttpGet("www.google.com")
	simpleHttpGet("http://www.google.com")
}
func InitLogger() {
  logger, _ := zap.NewProduction()
	sugarLogger = logger.Sugar()
}
func simpleHttpGet(url string) {
	sugarLogger.Debugf("Trying to hit GET request for %s", url)
	resp, err := http.Get(url)
	if err != nil {
		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
	} else {
		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
		resp.Body.Close()
	}
}

當你執行上面的代碼會得到如下輸出:

{"level":"error","ts":1572159149.923002,"caller":"logic/temp2.go:27","msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\"","stacktrace":"main.simpleHttpGet\n\t/Users/q1mi/zap_demo/logic/temp2.go:27\nmain.main\n\t/Users/q1mi/zap_demo/logic/temp2.go:14\nruntime.main\n\t/usr/local/go/src/runtime/proc.go:203"}
{"level":"info","ts":1572159150.192585,"caller":"logic/temp2.go:29","msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}

你應該注意到的了，到目前為止這兩個logger都打印輸出JSON結構格式;

定制logger

將日志寫入文件而不是終端

我們要做的第一個更改是把日志寫入文件，而不是打印到應用程序控制台。

我們將使用zap.New(…)方法來手動傳遞所有配置，而不是使用像zap.NewProduction()這樣的預置方法來創建logger;
**

func New(core zapcore.Core, options ...Option) *Logger

zapcore.Core需要三個配置——Encoder，WriteSyncer，LogLevel;

1 . Encoder:編碼器(如何寫入日志)。我們將使用開箱即用的NewJSONEncoder()，並使用預先設置的ProductionEncoderConfig();

zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())

2 . WriterSyncer ：指定日志將寫到哪里去。我們使用zapcore.AddSync()函數並且將打開的文件句柄傳進去;

file, _ := os.Create("./test.log")
   writeSyncer := zapcore.AddSync(file)

3 . Log Level：哪種級別的日志將被寫入

我們將修改上述部分中的Logger代碼，並重寫InitLogger()方法。其余方法—main() /SimpleHttpGet()保持不變;

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
	logger := zap.New(core)
	sugarLogger = logger.Sugar()
}
func getEncoder() zapcore.Encoder {
	return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
}
func getLogWriter() zapcore.WriteSyncer {
	file, _ := os.Create("./test.log")
	return zapcore.AddSync(file)
}

當使用這些修改過的logger配置調用上述部分的main()函數時，以下輸出將打印在文件——test.log中;

{"level":"debug","ts":1572160754.994731,"msg":"Trying to hit GET request for www.sogo.com"}
{"level":"error","ts":1572160754.994982,"msg":"Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme \"\""}
{"level":"debug","ts":1572160754.994996,"msg":"Trying to hit GET request for http://www.sogo.com"}
{"level":"info","ts":1572160757.3755069,"msg":"Success! statusCode = 200 OK for URL http://www.sogo.com"}

將JSON Encoder更改為普通的Log Encoder

現在，我們希望將編碼器從JSON Encoder更改為普通Encoder。為此，我們需要將NewJSONEncoder()更改為NewConsoleEncoder();

return zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig())

當使用這些修改過的logger配置調用上述部分的main()函數時，以下輸出將打印在文件——test.log中;

1.572161051846623e+09	debug	Trying to hit GET request for www.sogo.com
1.572161051846828e+09	error	Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
1.5721610518468401e+09	debug	Trying to hit GET request for http://www.sogo.com
1.572161052068744e+09	info	Success! statusCode = 200 OK for URL http://www.sogo.com

更改時間編碼並添加調用者詳細信息

鑒於我們對配置所做的更改，有下面兩個問題：

• 時間是以非人類可讀的方式展示，例如1.572161051846623e+09
• 調用方函數的詳細信息沒有顯示在日志中

我們要做的第一件事是覆蓋默認的ProductionConfig()，並進行以下更改:

• 修改時間編碼器
• 在日志文件中使用大寫字母記錄日志級別

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	return zapcore.NewConsoleEncoder(encoderConfig)
}

接下來，我們將修改zap logger代碼，添加將調用函數信息記錄到日志中的功能。為此，我們將在zap.New(..)函數中添加一個Option;

logger := zap.New(core, zap.AddCaller())

當使用這些修改過的logger配置調用上述部分的main()函數時，以下輸出將打印在文件——test.log中;

2021-04-14T18:50:35.252+0800	DEBUG	Trying to hit GET request for www.google.com
2021-04-14T18:50:35.252+0800	ERROR	Error fetching URL www.google.com : Error = Get "www.google.com": unsupported protocol scheme ""
2021-04-14T18:50:35.252+0800	DEBUG	Trying to hit GET request for http://www.google.com
2021-04-14T18:51:05.253+0800	ERROR	Error fetching URL http://www.google.com : Error = Get "http://www.google.com": dial tcp 209.95.56.60:80: i/o timeout

使用Lumberjack進行日志切割歸檔

這個日志程序中唯一缺少的就是日志切割歸檔功能;
_
Zap本身不支持切割歸檔日志文件
_
為了添加日志切割歸檔功能，我們將使用第三方庫Lumberjack來實現;

安裝

執行下面的命令安裝Lumberjack
**

go get -u github.com/natefinch/lumberjack

zap logger中加入Lumberjack

要在zap中加入Lumberjack支持，我們需要修改WriteSyncer代碼。我們將按照下面的代碼修改getLogWriter()函數:

func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log",
		MaxSize:    10,
		MaxBackups: 5,
		MaxAge:     30,
		Compress:   false,
	}
	return zapcore.AddSync(lumberJackLogger)
}

Lumberjack Logger采用以下屬性作為輸入:

• Filename: 日志文件的位置
• MaxSize：在進行切割之前，日志文件的最大大小（以MB為單位）
• MaxBackups：保留舊文件的最大個數
• MaxAges：保留舊文件的最大天數
• Compress：是否壓縮/歸檔舊文件

測試所有功能

最終，使用Zap/Lumberjack logger的完整示例代碼如下:

package main
import (
	"net/http"
	"github.com/natefinch/lumberjack"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)
var sugarLogger *zap.SugaredLogger
func main() {
	InitLogger()
	defer sugarLogger.Sync()
	simpleHttpGet("www.sogo.com")
	simpleHttpGet("http://www.sogo.com")
}

func InitLogger() {
	writeSyncer := getLogWriter()
	encoder := getEncoder()
	core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
	logger := zap.New(core, zap.AddCaller())
	sugarLogger = logger.Sugar()
}

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	return zapcore.NewConsoleEncoder(encoderConfig)
}

func getLogWriter() zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   "./test.log",		// 日志文件位置
		MaxSize:    1,							// 進行切割之前,日志文件的最大大小(MB為單位)
		MaxBackups: 5,							// 保留舊文件的最大個數
		MaxAge:     30,							// 保留舊文件的最大天數
		Compress:   false, 					// 是否壓縮/歸檔舊文件
	}
	return zapcore.AddSync(lumberJackLogger)
}

func simpleHttpGet(url string) {
	sugarLogger.Debugf("Trying to hit GET request for %s", url)
	resp, err := http.Get(url)
	if err != nil {
		sugarLogger.Errorf("Error fetching URL %s : Error = %s", url, err)
	} else {
		sugarLogger.Infof("Success! statusCode = %s for URL %s", resp.Status, url)
		resp.Body.Close()
	}
}

執行上述代碼，下面的內容會輸出到文件——test.log中;

2019-10-27T15:50:32.944+0800	DEBUG	logic/temp2.go:48	Trying to hit GET request for www.sogo.com
2019-10-27T15:50:32.944+0800	ERROR	logic/temp2.go:51	Error fetching URL www.sogo.com : Error = Get www.sogo.com: unsupported protocol scheme ""
2019-10-27T15:50:32.944+0800	DEBUG	logic/temp2.go:48	Trying to hit GET request for http://www.sogo.com
2019-10-27T15:50:33.165+0800	INFO	logic/temp2.go:53	Success! statusCode = 200 OK for URL http://www.sogo.com

同時，可以在main函數中循環記錄日志，測試日志文件是否會自動切割和歸檔（日志文件每1MB會切割並且在當前目錄下最多保存5個備份）。
至此，我們總結了如何將Zap日志程序集成到Go應用程序項目中;
**

Gin集成Zap

Gin默認中間件

package main

import "github.com/gin-gonic/gin"

func main() {
	r := gin.Default()
	r.GET("/hello", func(c *gin.Context) {
		c.JSON(200, gin.H{"message": "hello"})
	})
	r.Run()
}
   
// gin.Default()源碼
// Default returns an Engine instance with the Logger and Recovery middleware already attached.
func Default() *Engine {
	debugPrintWARNINGDefault()
	engine := New()
	engine.Use(Logger(), Recovery())
	return engine
}

// 也就是我們在使用gin.Default()的同時是用到了gin框架內的兩個默認中間件Logger()和Recovery()。
// 其中Logger()是把gin框架本身的日志輸出到標准輸出（我們本地開發調試時在終端輸出的那些日志就是它的功勞），而Recovery()是在程序出現panic的時候恢復現場並寫入500響應的。

基於zap的中間件

我們可以模仿Logger()和Recovery()的實現，使用我們的日志庫來接收gin框架默認輸出的日志。
這里以zap為例，我們實現兩個中間件如下:

// GinLogger 接收gin框架默認的日志
func GinLogger(logger *zap.Logger) gin.HandlerFunc {
	return func(c *gin.Context) {
		start := time.Now()
		path := c.Request.URL.Path
		query := c.Request.URL.RawQuery
		c.Next()

		cost := time.Since(start)
		logger.Info(path,
			zap.Int("status", c.Writer.Status()),
			zap.String("method", c.Request.Method),
			zap.String("path", path),
			zap.String("query", query),
			zap.String("ip", c.ClientIP()),
			zap.String("user-agent", c.Request.UserAgent()),
			zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
			zap.Duration("cost", cost),
		)
	}
}

// GinRecovery recover掉項目可能出現的panic
func GinRecovery(logger *zap.Logger, stack bool) gin.HandlerFunc {
	return func(c *gin.Context) {
		defer func() {
			if err := recover(); err != nil {
				// Check for a broken connection, as it is not really a
				// condition that warrants a panic stack trace.
				var brokenPipe bool
				if ne, ok := err.(*net.OpError); ok {
					if se, ok := ne.Err.(*os.SyscallError); ok {
						if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
							brokenPipe = true
						}
					}
				}

				httpRequest, _ := httputil.DumpRequest(c.Request, false)
				if brokenPipe {
					logger.Error(c.Request.URL.Path,
						zap.Any("error", err),
						zap.String("request", string(httpRequest)),
					)
					// If the connection is dead, we can't write a status to it.
					c.Error(err.(error)) // nolint: errcheck
					c.Abort()
					return
				}
				if stack {
					logger.Error("[Recovery from panic]",
						zap.Any("error", err),
						zap.String("request", string(httpRequest)),
						zap.String("stack", string(debug.Stack())),
					)
				} else {
					logger.Error("[Recovery from panic]",
						zap.Any("error", err),
						zap.String("request", string(httpRequest)),
					)
				}
				c.AbortWithStatus(http.StatusInternalServerError)
			}
		}()
		c.Next()
	}
}

如果不想自己實現，可以使用github上有別人封裝好的https://github.com/gin-contrib/zap
**

r := gin.New()
r.Use(GinLogger(), GinRecovery())

Gin項目中使用zap

最后我們再加入我們項目中常用的日志切割，完整版的logger.go代碼如下:
**

package logger

import (
	"gin_zap_demo/config"
	"net"
	"net/http"
	"net/http/httputil"
	"os"
	"runtime/debug"
	"strings"
	"time"

	"github.com/gin-gonic/gin"
	"github.com/natefinch/lumberjack"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
)

var lg *zap.Logger

// InitLogger 初始化Logger
func InitLogger(cfg *config.LogConfig) (err error) {
	writeSyncer := getLogWriter(cfg.Filename, cfg.MaxSize, cfg.MaxBackups, cfg.MaxAge)
	encoder := getEncoder()
	var l = new(zapcore.Level)
	err = l.UnmarshalText([]byte(cfg.Level))
	if err != nil {
		return
	}
	core := zapcore.NewCore(encoder, writeSyncer, l)

	lg = zap.New(core, zap.AddCaller())
	zap.ReplaceGlobals(lg) // 替換zap包中全局的logger實例，后續在其他包中只需使用zap.L()調用即可
	return
}

func getEncoder() zapcore.Encoder {
	encoderConfig := zap.NewProductionEncoderConfig()
	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
	encoderConfig.TimeKey = "time"
	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
	encoderConfig.EncodeDuration = zapcore.SecondsDurationEncoder
	encoderConfig.EncodeCaller = zapcore.ShortCallerEncoder
	return zapcore.NewJSONEncoder(encoderConfig)
}

func getLogWriter(filename string, maxSize, maxBackup, maxAge int) zapcore.WriteSyncer {
	lumberJackLogger := &lumberjack.Logger{
		Filename:   filename,
		MaxSize:    maxSize,
		MaxBackups: maxBackup,
		MaxAge:     maxAge,
	}
	return zapcore.AddSync(lumberJackLogger)
}

// GinLogger 接收gin框架默認的日志
func GinLogger() gin.HandlerFunc {
	return func(c *gin.Context) {
		start := time.Now()
		path := c.Request.URL.Path
		query := c.Request.URL.RawQuery
		c.Next()

		cost := time.Since(start)
		lg.Info(path,
			zap.Int("status", c.Writer.Status()),
			zap.String("method", c.Request.Method),
			zap.String("path", path),
			zap.String("query", query),
			zap.String("ip", c.ClientIP()),
			zap.String("user-agent", c.Request.UserAgent()),
			zap.String("errors", c.Errors.ByType(gin.ErrorTypePrivate).String()),
			zap.Duration("cost", cost),
		)
	}
}

// GinRecovery recover掉項目可能出現的panic，並使用zap記錄相關日志
func GinRecovery(stack bool) gin.HandlerFunc {
	return func(c *gin.Context) {
		defer func() {
			if err := recover(); err != nil {
				// Check for a broken connection, as it is not really a
				// condition that warrants a panic stack trace.
				var brokenPipe bool
				if ne, ok := err.(*net.OpError); ok {
					if se, ok := ne.Err.(*os.SyscallError); ok {
						if strings.Contains(strings.ToLower(se.Error()), "broken pipe") || strings.Contains(strings.ToLower(se.Error()), "connection reset by peer") {
							brokenPipe = true
						}
					}
				}

				httpRequest, _ := httputil.DumpRequest(c.Request, false)
				if brokenPipe {
					lg.Error(c.Request.URL.Path,
						zap.Any("error", err),
						zap.String("request", string(httpRequest)),
					)
					// If the connection is dead, we can't write a status to it.
					c.Error(err.(error)) // nolint: errcheck
					c.Abort()
					return
				}

				if stack {
					lg.Error("[Recovery from panic]",
						zap.Any("error", err),
						zap.String("request", string(httpRequest)),
						zap.String("stack", string(debug.Stack())),
					)
				} else {
					lg.Error("[Recovery from panic]",
						zap.Any("error", err),
						zap.String("request", string(httpRequest)),
					)
				}
				c.AbortWithStatus(http.StatusInternalServerError)
			}
		}()
		c.Next()
	}
}

定義日志相關配置

type LogConfig struct {
	Level string `json:"level"`
	Filename string `json:"filename"`
	MaxSize int `json:"maxsize"`
	MaxAge int `json:"max_age"`
	MaxBackups int `json:"max_backups"`
}

在項目中先從配置文件加載配置信息，再調用logger.InitLogger(config.Conf.LogConfig)即可完成logger實例的初識化。其中，通過r.Use(logger.GinLogger(), logger.GinRecovery(true))注冊我們的中間件來使用zap接收gin框架自身的日志，在項目中需要的地方通過使用zap.L().Xxx()方法來記錄自定義日志信息;

package main

import (
	"fmt"
	"gin_zap_demo/config"
	"gin_zap_demo/logger"
	"net/http"
	"os"

	"go.uber.org/zap"

	"github.com/gin-gonic/gin"
)

func main() {
	// load config from config.json
	if len(os.Args) < 1 {
		return
	}

	if err := config.Init(os.Args[1]); err != nil {
		panic(err)
	}
	// init logger
	if err := logger.InitLogger(config.Conf.LogConfig); err != nil {
		fmt.Printf("init logger failed, err:%v\n", err)
		return
	}

	gin.SetMode(config.Conf.Mode)

	r := gin.Default()
	// 注冊zap相關中間件
	r.Use(logger.GinLogger(), logger.GinRecovery(true))

	r.GET("/hello", func(c *gin.Context) {
		// 假設你有一些數據需要記錄到日志中
		var (
			name = "q1mi"
			age  = 18
		)
		// 記錄日志並使用zap.Xxx(key, val)記錄相關字段
		zap.L().Debug("this is hello func", zap.String("user", name), zap.Int("age", age))

		c.String(http.StatusOK, "hello liwenzhou.com!")
	})

	addr := fmt.Sprintf(":%v", config.Conf.Port)
	r.Run(addr)
}