对于zap框架的封装使用，我们结合了lumberjack来实现日志分割，你可以更轻便的使用zap库来开发自己的系统
你可以通过初始化的配置来自定义自己的日志模式，我们提供了默认值DefaultLevel=zapcore.InfoLevel和DefaultTimeLayout=time.RFC3339，我们建议您可以在开发模式下使用debug等级同时配合控制台打印日志，在生产环境下使用info同时关闭日志打印
package logger
import (
"errors"
"go.uber.org/zap" "testing")
// json日志配置
func TestNewJSONLogger(t *testing.T) {
logger, err := NewJSONLogger(
// 日志等级
WithDebugLevel(),
// 写出的文件
WithFileRotationP("/log/test.log"),
// 不在控制台打印
WithDisableConsole(),
)
if err != nil {
t.Fatal(err)
}
defer logger.Sync()
err = errors.New("pkg error")
logger.Error("err occurs", WrapMeta(nil, NewMeta("para1", "value1"), NewMeta("para2", "value2"))...)
logger.Error("err occurs", WrapMeta(err, NewMeta("para1", "value1"), NewMeta("para2", "value2"))...)
logger.Info("err occurs", zap.String("key", "value"))
logger.Warn("err occurs", zap.Any("key", "value"))
logger.Error("err occurs", zap.Int("key", 1))
logger.Debug("err occurs", zap.Int("key", 1))
}打印出来的日志
{"level":"error","time":"2022-12-14T08:50:24+08:00","caller":"logger/logger_test.go:25","msg":"err occurs","meta":{"para1":"value1","para2":"value2"}}
{"level":"error","time":"2022-12-14T08:50:24+08:00","caller":"logger/logger_test.go:26","msg":"err occurs","error":"pkg error","meta":{"para1":"value1","para2":"value2"}}
{"level":"info","time":"2022-12-14T08:50:24+08:00","caller":"logger/logger_test.go:28","msg":"err occurs","key":"value"}
{"level":"warn","time":"2022-12-14T08:50:24+08:00","caller":"logger/logger_test.go:29","msg":"err occurs","key":"value"}
{"level":"error","time":"2022-12-14T08:50:24+08:00","caller":"logger/logger_test.go:30","msg":"err occurs","key":1}
{"level":"debug","time":"2022-12-14T08:50:24+08:00","caller":"logger/logger_test.go:31","msg":"err occurs","key":1}我们还提供了对外使用的API，您可以直接使用API来打印日志。我们提供了四个对外开发的APIInfo Debug Warn Error，即使没有进行NewJSONLogger的初始化操作，你也可以默认进行控制台的打印操作
Debug("err occurs", zap.String("key", "err.Error()"))
Info("err occurs", zap.String("key", "err.Error()"))
Warn("err occurs", zap.String("key", "err.Error()"))
Error("err occurs", zap.String("key", "err.Error()"))上面这段代码将打印出以下数据，默认不打印debug级别的日志
{"level":"info","time":"2022-12-14T13:25:50+08:00","caller":"logger/logger.go:262","msg":"err occurs","key":"err.Error()"}
{"level":"warn","time":"2022-12-14T13:25:50+08:00","caller":"logger/logger.go:272","msg":"err occurs","key":"err.Error()"}
{"level":"error","time":"2022-12-14T13:25:50+08:00","caller":"logger/logger.go:277","msg":"err occurs","key":"err.Error()"}如何您进行了NewJSONLogger的初始化，我们将使用您提供的logger对象替换掉内部的全局logger对象，实现对外API的改变，使日志操作变得更简单，下面为您提供使用示例
func TestNewJSONLogger(t *testing.T) {
logger, err := NewJSONLogger(
// 日志等级
WithDebugLevel(),
// 写出的文件
WithFileRotationP("/log/test.log"),
// 不在控制台打印
WithDisableConsole(),
// 时间格式化
WithTimeLayout("2006-01-02 15:04:05"),
)
if err != nil {
t.Fatal(err)
}
defer logger.Sync()
Debug("err occurs", zap.String("key", "err.Error()"))
Info("err occurs", zap.String("key", "err.Error()"))
Warn("err occurs", zap.String("key", "err.Error()"))
Error("err occurs", zap.String("key", "err.Error()"))
}我们提供了与gin框架结合的实例供您参考，这里我们使用go-logger来接收gin的日志
func main() {
// 初始化引擎
r := gin.New()
r.Use(GinLogger(), GinRecovery(true))
// 启动
r.Run(":8080")
}// GinLogger 接收gin框架默认的日志
func GinLogger() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
path := c.Request.URL.Path
query := c.Request.URL.RawQuery
// 解析表单数据里面的数据
if err := c.Request.ParseForm(); err != nil {
logger.Error("c.Request.ParseForm()", zap.Error(err))
}
// 读取表单数据
form := c.Request.PostForm.Encode()
bodyStr := ""
// 判断请求类型是否是json
if strings.ContainsAny(c.ContentType(), "application/json") {
defer c.Request.Body.Close()
body, _ := ioutil.ReadAll(c.Request.Body)
//注意：重新赋值必须这样否则无法从context重在获取数据
c.Request.Body = ioutil.NopCloser(bytes.NewBuffer(body))
bodyStr += string(body)
}
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.Any("form", form),
zap.Any("json-body", bodyStr),
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(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()
}
}