Go 语言之自定义 zap 日志

Go 语言之自定义 zap 日志

zap 日志：https://github.com/uber-go/zap
一、日志写入文件

• zap.NewProduction、zap.NewDevelopment 是预设配置好的。
  
• zap.New 可自定义配置
  

zap.New源码

这是构造Logger最灵活的方式，但也是最冗长的方式。
对于典型的用例，高度固执己见的预设(NewProduction、NewDevelopment和NewExample)或Config结构体更方便。

1. // New constructs a new Logger from the provided zapcore.Core and Options. If
2. // the passed zapcore.Core is nil, it falls back to using a no-op
3. // implementation.
4. //
5. // This is the most flexible way to construct a Logger, but also the most
6. // verbose. For typical use cases, the highly-opinionated presets
7. // (NewProduction, NewDevelopment, and NewExample) or the Config struct are
8. // more convenient.
9. //
10. // For sample code, see the package-level AdvancedConfiguration example.
11. func New(core zapcore.Core, options ...Option) *Logger {
12.         if core == nil {
13.                 return NewNop()
14.         }
15.         log := &Logger{
16.                 core:        core,
17.                 errorOutput: zapcore.Lock(os.Stderr),
18.                 addStack:    zapcore.FatalLevel + 1,
19.                 clock:       zapcore.DefaultClock,
20.         }
21.         return log.WithOptions(options...)
22. }

复制代码

zapcore.Core 源码

1. // Core is a minimal, fast logger interface. It's designed for library authors
2. // to wrap in a more user-friendly API.
3. type Core interface {
4.         LevelEnabler
6.         // With adds structured context to the Core.
7.         With([]Field) Core
8.         // Check determines whether the supplied Entry should be logged (using the
9.         // embedded LevelEnabler and possibly some extra logic). If the entry
10.         // should be logged, the Core adds itself to the CheckedEntry and returns
11.         // the result.
12.         //
13.         // Callers must use Check before calling Write.
14.         Check(Entry, *CheckedEntry) *CheckedEntry
15.         // Write serializes the Entry and any Fields supplied at the log site and
16.         // writes them to their destination.
17.         //
18.         // If called, Write should always log the Entry and Fields; it should not
19.         // replicate the logic of Check.
20.         Write(Entry, []Field) error
21.         // Sync flushes buffered logs (if any).
22.         Sync() error
23. }

复制代码

zapcore.AddSync(file) 源码解析

1. func AddSync(w io.Writer) WriteSyncer {
2.         switch w := w.(type) {
3.         case WriteSyncer:
4.                 return w
5.         default:
6.                 return writerWrapper{w}
7.         }
8. }
10. type writerWrapper struct {
11.         io.Writer
12. }
14. func (w writerWrapper) Sync() error {
15.         return nil
16. }
18. type WriteSyncer interface {
19.         io.Writer
20.         Sync() error
21. }

复制代码

日志级别

1. // A Level is a logging priority. Higher levels are more important.
2. type Level int8
4. const (
5.         // DebugLevel logs are typically voluminous, and are usually disabled in
6.         // production.
7.         DebugLevel Level = iota - 1
8.         // InfoLevel is the default logging priority.
9.         InfoLevel
10.         // WarnLevel logs are more important than Info, but don't need individual
11.         // human review.
12.         WarnLevel
13.         // ErrorLevel logs are high-priority. If an application is running smoothly,
14.         // it shouldn't generate any error-level logs.
15.         ErrorLevel
16.         // DPanicLevel logs are particularly important errors. In development the
17.         // logger panics after writing the message.
18.         DPanicLevel
19.         // PanicLevel logs a message, then panics.
20.         PanicLevel
21.         // FatalLevel logs a message, then calls os.Exit(1).
22.         FatalLevel
24.         _minLevel = DebugLevel
25.         _maxLevel = FatalLevel
27.         // InvalidLevel is an invalid value for Level.
28.         //
29.         // Core implementations may panic if they see messages of this level.
30.         InvalidLevel = _maxLevel + 1
31. )

复制代码

实操

1. package main
3. import (
4.         "go.uber.org/zap"
5.         "go.uber.org/zap/zapcore"
6.         "net/http"
7.         "os"
8. )
10. // 定义一个全局 logger 实例
11. // Logger提供快速、分级、结构化的日志记录。所有方法对于并发使用都是安全的。
12. // Logger是为每一微秒和每一个分配都很重要的上下文设计的，
13. // 因此它的API有意倾向于性能和类型安全，而不是简便性。
14. // 对于大多数应用程序，SugaredLogger在性能和人体工程学之间取得了更好的平衡。
15. var logger *zap.Logger
17. // SugaredLogger将基本的Logger功能封装在一个较慢但不那么冗长的API中。任何Logger都可以通过其Sugar方法转换为sugardlogger。
18. //与Logger不同，SugaredLogger并不坚持结构化日志记录。对于每个日志级别，它公开了四个方法:
19. //   - methods named after the log level for log.Print-style logging
20. //   - methods ending in "w" for loosely-typed structured logging
21. //   - methods ending in "f" for log.Printf-style logging
22. //   - methods ending in "ln" for log.Println-style logging
24. // For example, the methods for InfoLevel are:
25. //
26. //        Info(...any)           Print-style logging
27. //        Infow(...any)          Structured logging (read as "info with")
28. //        Infof(string, ...any)  Printf-style logging
29. //        Infoln(...any)         Println-style logging
30. var sugarLogger *zap.SugaredLogger
32. func main() {
33.         // 初始化
34.         InitLogger()
35.         // Sync调用底层Core的Sync方法，刷新所有缓冲的日志条目。应用程序在退出之前应该注意调用Sync。
36.         // 在程序退出之前，把缓冲区里的日志刷到磁盘上
37.         defer logger.Sync()
38.         simpleHttpGet("www.baidu.com")
39.         simpleHttpGet("http://www.baidu.com")
40. }
42. func InitLogger() {
43.         writeSyncer := getLogWriter()
44.         encoder := getEncoder()
45.         // NewCore创建一个向WriteSyncer写入日志的Core。
47.         // A WriteSyncer is an io.Writer that can also flush any buffered data. Note
48.         // that *os.File (and thus, os.Stderr and os.Stdout) implement WriteSyncer.
50.         // LevelEnabler决定在记录消息时是否启用给定的日志级别。
51.         // Each concrete Level value implements a static LevelEnabler which returns
52.         // true for itself and all higher logging levels. For example WarnLevel.Enabled()
53.         // will return true for WarnLevel, ErrorLevel, DPanicLevel, PanicLevel, and
54.         // FatalLevel, but return false for InfoLevel and DebugLevel.
55.         core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)
57.         // New constructs a new Logger from the provided zapcore.Core and Options. If
58.         // the passed zapcore.Core is nil, it falls back to using a no-op
59.         // implementation.
60.         logger = zap.New(core)
61.         // Sugar封装了Logger，以提供更符合人体工程学的API，但速度略慢。糖化一个Logger的成本非常低，
62.         // 因此一个应用程序同时使用Loggers和SugaredLoggers是合理的，在性能敏感代码的边界上在它们之间进行转换。
63.         sugarLogger = logger.Sugar()
64. }
66. func getEncoder() zapcore.Encoder {
67.         // NewJSONEncoder创建了一个快速、低分配的JSON编码器。编码器适当地转义所有字段键和值。
68.         // NewProductionEncoderConfig returns an opinionated EncoderConfig for
69.         // production environments.
70.         return zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig())
71. }
73. func getLogWriter() zapcore.WriteSyncer {
74.         // Create创建或截断指定文件。如果文件已经存在，它将被截断。如果该文件不存在，则以模式0666(在umask之前)创建。
75.         // 如果成功，返回的File上的方法可以用于IO;关联的文件描述符模式为O_RDWR。如果有一个错误，它的类型将是PathError。
76.         file, _ := os.Create("./test.log")
77.         // AddSync converts an io.Writer to a WriteSyncer. It attempts to be
78.         // intelligent: if the concrete type of the io.Writer implements WriteSyncer,
79.         // we'll use the existing Sync method. If it doesn't, we'll add a no-op Sync.
80.         return zapcore.AddSync(file)
81. }
83. func simpleHttpGet(url string) {
84.         // Get向指定的URL发出Get命令。如果响应是以下重定向代码之一，则Get跟随重定向，最多可重定向10个:
85.         //        301 (Moved Permanently)
86.         //        302 (Found)
87.         //        303 (See Other)
88.         //        307 (Temporary Redirect)
89.         //        308 (Permanent Redirect)
90.         // Get is a wrapper around DefaultClient.Get.
91.         // 使用NewRequest和DefaultClient.Do来发出带有自定义头的请求。
92.         resp, err := http.Get(url)
93.         if err != nil {
94.                 // Error在ErrorLevel记录消息。该消息包括在日志站点传递的任何字段，以及日志记录器上积累的任何字段。
95.                 //logger.Error(
97.                 // 错误使用fmt。以Sprint方式构造和记录消息。
98.                 sugarLogger.Error(
99.                         "Error fetching url..",
100.                         zap.String("url", url), // 字符串用给定的键和值构造一个字段。
101.                         zap.Error(err))         // // Error is shorthand for the common idiom NamedError("error", err).
102.         } else {
103.                 // Info以infollevel记录消息。该消息包括在日志站点传递的任何字段，以及日志记录器上积累的任何字段。
104.                 //logger.Info("Success..",
106.                 // Info使用fmt。以Sprint方式构造和记录消息。
107.                 sugarLogger.Info("Success..",
108.                         zap.String("statusCode", resp.Status),
109.                         zap.String("url", url))
110.                 resp.Body.Close()
111.         }
112. }

复制代码

运行

[code]Code/go/zap_demo via
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！