众所周知，Zap 是个很 nb 的日志框架，作为入门篇，本文主要用几个例子来直观地感受下 Zap 写出来的日志长什么样，符不符合我们的需求（主要是审美需求），性能什么的我们攒钱不 care。
以下栗子由浅入深，循序渐进，大部分栗子可以直接 copy 运行。
Casescase 1: Hello World
Zap 的 Hello World 代码大概长下面这样：
package mainimport ("fmt""go.uber.org/zap"
)func main() {var logger *zap.Loggerlogger, _ = zap.NewProduction()logger.Debug("i am debug") // 这行不会打印，因为默认日志级别是 INFOlogger.Info("i am info") // INFO 级别日志，这个会正常打印logger.Warn("i am warn") // WARN 级别日志，这个会正常打印logger.Error("i am error") // ERROR 级别日志，这个会打印，并附带堆栈信息logger.Fatal("i am fatal") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}
编译运行该程序，输出大概如下：
{"level":"info","ts":1608362501.672074,"caller":"zap2/main.go:11","msg":"i am info"}
{"level":"warn","ts":1608362501.672139,"caller":"zap2/main.go:12","msg":"i am warn"}
{"level":"error","ts":1608362501.672147,"caller":"zap2/main.go:13","msg":"i am error","stacktrace":"main.main\n\t/Users/jack/go/src/helloworld/zap2/main.go:13\nruntime.main\n\t/usr/local/Cellar/go/1.15.2/libexec/src/runtime/proc.go:204"}
{"level":"fatal","ts":1608362501.6721768,"caller":"zap2/main.go:14","msg":"i am fatal","stacktrace":"main.main\n\t/Users/jack/go/src/helloworld/zap2/main.go:14\nruntime.main\n\t/usr/local/Cellar/go/1.15.2/libexec/src/runtime/proc.go:204"}
以上代码应该是相当简洁易懂了，在这里需要再唠嗑一下的是关于输出的日志的几个字段的说明：
- level: 顾名思义，就是日志的级别了，默认的日志级别是 INFO，所以我们的第一行日志没有被打印出来
- ts: timestamp，时间戳的意思
- caller: 调用者，就是打印日志的那行代码的位置
- stacktrace: 调用堆栈，及打印日志的那行代码所在的堆栈信息，默认 ERROR 级别及以上的日志会附带堆栈信息，可以修改
case 2: SugaredLogger
zap.SugaredLoggerzap.Loggerfmt.Printfzap.SugaredLoggerpackage mainimport ("fmt""go.uber.org/zap"
)func main() {var sugaredLogger *zap.SugaredLoggerlogger, _ := zap.NewProduction()sugaredLogger = logger.Sugar()sugaredLogger.Debugf("i am debug, using %s", "sugar") // 这行不会打印，因为默认日志级别是 INFOsugaredLogger.Infof("i am info, using %s", "sugar") // INFO 级别日志，这个会正常打印sugaredLogger.Warnf("i am warn, using %s", "sugar") // WARN 级别日志，这个会正常打印sugaredLogger.Errorf("i am error, using %s", "sugar") // ERROR 级别日志，这个会打印，并附带堆栈信息sugaredLogger.Fatalf("i am fatal, using %s", "sugar") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}编译运行该程序，输出类似如下：
{"level":"info","ts":1608365481.615607,"caller":"zap3/main.go:13","msg":"i am info, using sugar"}
{"level":"warn","ts":1608365481.615681,"caller":"zap3/main.go:14","msg":"i am warn, using sugar"}
{"level":"error","ts":1608365481.6156878,"caller":"zap3/main.go:15","msg":"i am error, using sugar","stacktrace":"main.main\n\t/Users/jack/go/src/helloworld/zap3/main.go:15\nruntime.main\n\t/usr/local/Cellar/go/1.15.2/libexec/src/runtime/proc.go:204"}
{"level":"fatal","ts":1608365481.6157131,"caller":"zap3/main.go:16","msg":"i am fatal, using sugar","stacktrace":"main.main\n\t/Users/jack/go/src/helloworld/zap3/main.go:16\nruntime.main\n\t/usr/local/Cellar/go/1.15.2/libexec/src/runtime/proc.go:204"}
case 3: 定制化 SugaredLogger
zap.NewProduction()zap.Loggerzap.New(core zapcore.Core, options ...Option)zapcore.CorezapzapjsonEncoderconsoleEncoderzapos.Fileos.stdoutzap.Logger我们用定制化的方式来改写上述栗子：
package mainimport ("fmt""go.uber.org/zap""go.uber.org/zap/zapcore""os"
)func main() {// 配置 sugaredLoggervar sugaredLogger *zap.SugaredLoggerwriter := zapcore.AddSync(os.Stdout) // 设置日志输出的设备，这里还是使用标准输出，也可以传一个 File 类型让它写入到文件encoder := zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()) // 设置编码器，即日志输出的格式，默认提供了 json 和 console 两种编码器，这里我们还是使用 json 的编码器core := zapcore.NewCore(encoder, writer, zapcore.InfoLevel) // 设置日志的默认级别logger := zap.New(core)sugaredLogger = logger.Sugar()// 打印日志sugaredLogger.Debugf("i am debug, using %s", "sugar") // 这行不会打印，因为日志级别是 INFOsugaredLogger.Infof("i am info, using %s", "sugar") // INFO 级别日志，这个会正常打印sugaredLogger.Warnf("i am warn, using %s", "sugar") // WARN 级别日志，这个会正常打印sugaredLogger.Errorf("i am error, using %s", "sugar") // ERROR 级别日志，这个会打印，并附带堆栈信息sugaredLogger.Fatalf("i am fatal, using %s", "sugar") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}
编译运行该程序，输出类似如下：
{"level":"info","ts":1608367820.9526541,"msg":"i am info, using sugar"}
{"level":"warn","ts":1608367820.952697,"msg":"i am warn, using sugar"}
{"level":"error","ts":1608367820.9527,"msg":"i am error, using sugar"}
{"level":"fatal","ts":1608367820.952702,"msg":"i am fatal, using sugar"}
callerstackstace使用 Console 格式
jsonconsolejsonconsolepackage mainimport ("fmt""go.uber.org/zap""go.uber.org/zap/zapcore""os"
)func main() {// 配置 sugaredLoggervar sugaredLogger *zap.SugaredLoggerwriter := zapcore.AddSync(os.Stdout)encoder := zapcore.NewConsoleEncoder(zap.NewProductionEncoderConfig()) // 设置 console 编码器core := zapcore.NewCore(encoder, writer, zapcore.InfoLevel)logger := zap.New(core)sugaredLogger = logger.Sugar()// 打印日志sugaredLogger.Debugf("i am debug, using %s", "sugar") // 这行不会打印，因为日志级别是 INFOsugaredLogger.Infof("i am info, using %s", "sugar") // INFO 级别日志，这个会正常打印sugaredLogger.Warnf("i am warn, using %s", "sugar") // WARN 级别日志，这个会正常打印sugaredLogger.Errorf("i am error, using %s", "sugar") // ERROR 级别日志，这个会打印，并附带堆栈信息sugaredLogger.Fatalf("i am fatal, using %s", "sugar") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}
编译运行该程序，输出类似如下：
1.60837067575392e+09 info i am info, using sugar
1.6083706757539682e+09 warn i am warn, using sugar
1.608370675753972e+09 error i am error, using sugar
1.6083706757539752e+09 fatal i am fatal, using sugar
修改日期显示格式
human readablepackage mainimport ("fmt""go.uber.org/zap""go.uber.org/zap/zapcore""os"
)func main() {// 配置 sugaredLoggervar sugaredLogger *zap.SugaredLoggerwriter := zapcore.AddSync(os.Stdout)// 格式相关的配置encoderConfig := zap.NewProductionEncoderConfig()encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder // 修改时间戳的格式encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder // 日志级别使用大写显示encoder := zapcore.NewConsoleEncoder(encoderConfig)core := zapcore.NewCore(encoder, writer, zapcore.InfoLevel)logger := zap.New(core)sugaredLogger = logger.Sugar()// 打印日志sugaredLogger.Debugf("i am debug, using %s", "sugar") // 这行不会打印，因为日志级别是 INFOsugaredLogger.Infof("i am info, using %s", "sugar") // INFO 级别日志，这个会正常打印sugaredLogger.Warnf("i am warn, using %s", "sugar") // WARN 级别日志，这个会正常打印sugaredLogger.Errorf("i am error, using %s", "sugar") // ERROR 级别日志，这个会打印，并附带堆栈信息sugaredLogger.Fatalf("i am fatal, using %s", "sugar") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}
编译运行该程序，输出类似如下：
2020-12-19T17:44:19.031+0800 INFO i am info, using sugar
2020-12-19T17:44:19.031+0800 WARN i am warn, using sugar
2020-12-19T17:44:19.031+0800 ERROR i am error, using sugar
2020-12-19T17:44:19.031+0800 FATAL i am fatal, using sugar
呃…看起来正常点了，上述栗子顺便把日志级别显示改成大写了，看起来更习惯一点~
增加 caller 信息
callerpackage mainimport ("fmt""go.uber.org/zap""go.uber.org/zap/zapcore""os"
)func main() {// 配置 sugaredLoggervar sugaredLogger *zap.SugaredLoggerwriter := zapcore.AddSync(os.Stdout)// 格式相关的配置encoderConfig := zap.NewProductionEncoderConfig()encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder // 修改时间戳的格式encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder // 日志级别使用大写显示encoder := zapcore.NewConsoleEncoder(encoderConfig)core := zapcore.NewCore(encoder, writer, zapcore.InfoLevel)logger := zap.New(core, zap.AddCaller()) // 增加 caller 信息sugaredLogger = logger.Sugar()// 打印日志sugaredLogger.Debugf("i am debug, using %s", "sugar") // 这行不会打印，因为日志级别是 INFOsugaredLogger.Infof("i am info, using %s", "sugar") // INFO 级别日志，这个会正常打印sugaredLogger.Warnf("i am warn, using %s", "sugar") // WARN 级别日志，这个会正常打印sugaredLogger.Errorf("i am error, using %s", "sugar") // ERROR 级别日志，这个会打印，并附带堆栈信息sugaredLogger.Fatalf("i am fatal, using %s", "sugar") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}
编译运行该程序，输出类似如下：
2020-12-19T17:50:24.257+0800 INFO zap3/main.go:29 i am info, using sugar
2020-12-19T17:50:24.257+0800 WARN zap3/main.go:30 i am warn, using sugar
2020-12-19T17:50:24.257+0800 ERROR zap3/main.go:31 i am error, using sugar
2020-12-19T17:50:24.257+0800 FATAL zap3/main.go:32 i am fatal, using sugar
修改日志级别
INFODEBUGpackage mainimport ("fmt""go.uber.org/zap""go.uber.org/zap/zapcore""os"
)func main() {// 配置 sugaredLoggervar sugaredLogger *zap.SugaredLoggerwriter := zapcore.AddSync(os.Stdout)// 格式相关的配置encoderConfig := zap.NewProductionEncoderConfig()encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder // 修改时间戳的格式encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder // 日志级别使用大写显示encoder := zapcore.NewConsoleEncoder(encoderConfig)core := zapcore.NewCore(encoder, writer, zapcore.DebugLevel) // 将日志级别设置为 DEBUGlogger := zap.New(core, zap.AddCaller()) // 增加 caller 信息sugaredLogger = logger.Sugar()// 打印日志sugaredLogger.Debugf("i am debug, using %s", "sugar") // 这行现在可以打印出来了！sugaredLogger.Infof("i am info, using %s", "sugar") // INFO 级别日志，这个会正常打印sugaredLogger.Warnf("i am warn, using %s", "sugar") // WARN 级别日志，这个会正常打印sugaredLogger.Errorf("i am error, using %s", "sugar") // ERROR 级别日志，这个会打印，并附带堆栈信息sugaredLogger.Fatalf("i am fatal, using %s", "sugar") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}
编译运行该程序，输出类似如下：
2020-12-19T17:52:29.438+0800 DEBUG zap3/main.go:28 i am debug, using sugar
2020-12-19T17:52:29.439+0800 INFO zap3/main.go:29 i am info, using sugar
2020-12-19T17:52:29.439+0800 WARN zap3/main.go:30 i am warn, using sugar
2020-12-19T17:52:29.439+0800 ERROR zap3/main.go:31 i am error, using sugar
2020-12-19T17:52:29.439+0800 FATAL zap3/main.go:32 i am fatal, using sugar
DEBUG添加自定义字段
zap.New()loggerpackage mainimport ("fmt""github.com/google/uuid""go.uber.org/zap""go.uber.org/zap/zapcore""os"
)func main() {// 配置 sugaredLoggervar sugaredLogger *zap.SugaredLoggerwriter := zapcore.AddSync(os.Stdout)// 格式相关的配置encoderConfig := zap.NewProductionEncoderConfig()encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder // 修改时间戳的格式encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder // 日志级别使用大写显示encoder := zapcore.NewConsoleEncoder(encoderConfig)core := zapcore.NewCore(encoder, writer, zapcore.DebugLevel) // 将日志级别设置为 DEBUGlogger := zap.New(core, zap.AddCaller(), zap.Fields(zapcore.Field{ // 添加 uuid 字段Key: "uuid",Type: zapcore.StringType,String: uuid.New().String(),}))sugaredLogger = logger.Sugar()// 打印日志sugaredLogger.Debugf("i am debug, using %s", "sugar") // 这行现在可以打印出来了！sugaredLogger.Infof("i am info, using %s", "sugar") // INFO 级别日志，这个会正常打印sugaredLogger.Warnf("i am warn, using %s", "sugar") // WARN 级别日志，这个会正常打印sugaredLogger.Errorf("i am error, using %s", "sugar") // ERROR 级别日志，这个会打印，并附带堆栈信息sugaredLogger.Fatalf("i am fatal, using %s", "sugar") // FATAL 级别日志，这个会打印，附带堆栈信息，并调用 os.Exit 退出fmt.Println("can i be printed?") // 这行不会打印，呃...上面已经退出了
}
编译运行该程序，输出类似如下：
2020-12-19T18:02:15.093+0800 DEBUG zap3/main.go:32 i am debug, using sugar {"uuid": "79432609-3ae9-4728-bbd2-f368d404018d"}
2020-12-19T18:02:15.093+0800 INFO zap3/main.go:33 i am info, using sugar {"uuid": "79432609-3ae9-4728-bbd2-f368d404018d"}
2020-12-19T18:02:15.093+0800 WARN zap3/main.go:34 i am warn, using sugar {"uuid": "79432609-3ae9-4728-bbd2-f368d404018d"}
2020-12-19T18:02:15.093+0800 ERROR zap3/main.go:35 i am error, using sugar {"uuid": "79432609-3ae9-4728-bbd2-f368d404018d"}
2020-12-19T18:02:15.093+0800 FATAL zap3/main.go:36 i am fatal, using sugar {"uuid": "79432609-3ae9-4728-bbd2-f368d404018d"}
uuid