您现在的位置是：网站首页> 编程资料编程资料
Go学习笔记之Zap日志的使用_Golang_
2023-05-26
450人已围观
简介 Go学习笔记之Zap日志的使用_Golang_
Log包
Go语言提供的默认日志包：https://golang.org/pkg/log/
基本用法
log包定义了Logger类型，该类型提供了一些格式化输出的方法。
type Logger struct { mu sync.Mutex // ensures atomic writes; protects the following fields prefix string // prefix on each line to identify the logger (but see Lmsgprefix) flag int // properties out io.Writer // destination for output buf []byte // for accumulating text to write }mu属性主要是为了确保原子操作，prefix设置每一行的前缀，flag设置输出的各种属性，比如时间、行号、文件路径等。out输出的方向，用于把日志存储文件。
本包也提供了一个预定义的“标准”logger，可以通过调用函数Print系列(Print|Printf|Println）、Fatal系列（Fatal|Fatalf|Fatalln）、和Panic系列（Panic|Panicf|Panicln）来使用，比自行创建一个logger对象更容易使用。
例如，我们可以像下面的代码一样直接通过log包来调用上面提到的方法，默认它们会将日志信息打印到终端界面：
log.Println("这是一条优雅的日志。") v := "优雅的" log.Printf("这是一个%s日志\n", v) //fatal系列函数会在写入日志信息后调用os.Exit(1) log.Fatalln("这是一天会触发fatal的日志") //Panic系列函数会在写入日志信息后panic log.Panicln("这是一个会触发panic的日志。") //执行后会自动触发一个异常flag属性
默认情况下的logger只会提供日志的时间信息，但是很多情况下我们希望得到更多信息，比如记录该日志的文件名和行号等。log标准库中为我们提供了定制这些设置的方法。
log标准库中的Flags函数会返回标准logger的输出配置，而SetFlags函数用来设置标准logger的输出配置。下面是flag属性对应的常量
const ( Ldate = 1 << iota // the date in the local time zone: 2009/01/23 Ltime // the time in the local time zone: 01:23:23 Lmicroseconds // microsecond resolution: 01:23:23.123123. assumes Ltime. Llongfile // full file name and line number: /a/b/c/d.go:23 Lshortfile // final file name element and line number: d.go:23. overrides Llongfile LUTC // if Ldate or Ltime is set, use UTC rather than the local time zone Lmsgprefix // move the "prefix" from the beginning of the line to before the message LstdFlags = Ldate | Ltime // initial values for the standard logger )
设置输出属性的代码如下：
func main() { log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate) log.Println("这是一条优雅的日志。") }编译输出：
2020/07/14 22:51:06.079594 D:/xxx/test_log.go:24: 这是一条优雅的日志。
prefix属性
log标准库中还提供了关于日志信息前缀的两个方法：其中Prefix函数用来查看标准logger的输出前缀，SetPrefix函数用来设置输出前缀。
func Prefix() string func SetPrefix(prefix string)
设置日志输出前缀的代码如下：
func main() { log.SetPrefix("[PS]") log.Println("这是一条很普通的日志。") }编译输出：
[PS]2020/07/14 22:56:15.652555 D:/xxx/test_log.go:26: 这是一个普通的日志
out属性
out属性是一个io.Writer输出流，使用它可以把日志输出为文件。
需要用的方法为：设置标准logger的输出目的地，默认是标准错误输出。
func SetOutput(w io.Writer)
例如，下面的代码会把日志输出到同目录下的xx.log文件中。
func main() { logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644) if err != nil { fmt.Println("open log file failed, err:", err) return } log.SetOutput(logFile) log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate) log.Println("这是一条很普通的日志。") log.SetPrefix("[PS]") log.Println("这是一条很普通的日志。") }如果你要使用标准的logger，我们通常会把上面的配置操作写到init函数中。
func init() { logFile, err := os.OpenFile("./xx.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644) if err != nil { fmt.Println("open log file failed, err:", err) return } log.SetOutput(logFile) log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate) }创建新的Logger
log标准库中还提供了一个创建新logger对象的构造函数 New，支持我们创建自己的logger示例。New函数的签名如下：
func New(out io.Writer, prefix string, flag int) *Logger
New创建一个Logger对象。其中，参数out设置日志信息写入的目的地。参数prefix会添加到生成的每一条日志前面。参数flag定义日志的属性（时间、文件等等）。
举个例子：
func main() { logger := log.New(os.Stdout, "", log.Lshortfile|log.Ldate|log.Ltime) logger.Println("这是自定义的logger记录的日志。") } 编译输出：
2020/07/14 23:02:59 test_log.go:43: 这是自定义的logger记录的日志
自定义Go Logger
可以设置任何io.Writer作为日志记录输出并向其发送要写入的日志
设置
func SetupLogger() { logFileLocation, _ := os.OpenFile("./test.log", os.O_CREATE|os.O_APPEND|os.O_RDWR, 0744) log.SetOutput(logFileLocation) }使用
func test(){ log.Printf("Test log: %s %s", "Hello", "World") }运行
func main() { SetupLogger() test() }Zap
Zap是非常快的、结构化的，分日志级别的Go日志库。
安装
go get -u go.uber.org/zap
配置Zap Logger
Zap提供了两种类型的日志记录器—Sugared Logger和Logger。
- Logger更快，但只支持强类型的结构化日志记录。
- Sugared Logger支持结构化和printf风格的日志记录。
Logger
- 通过调用
zap.NewProduction()/zap.NewDevelopment()或者zap.Example()创建一个Logger。 Example和Production使用的是json格式输出，Development使用行的形式输出Development从警告级别(Warn)向上打印到堆栈中来跟踪，ProductionError , Dpanic 级别的记录，会在堆栈中跟踪文件， Warn 不会- 通过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/itxiaoma/zap_demo/temp.go:25\nmain.main\n\t/Users/itxiaoma/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
slogger := logger.Sugar()
suger logger基于 printf 分割的反射类型检测，提供更简单的语法来添加混合类型的标签。
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
相关内容
- 深入了解Go语言的基本语法与常用函数_Golang_
- 执行go vendor第三方包版本冲突问题解决_Golang_
- Go语言怎么使用变长参数函数_Golang_
- Golang 中 omitempty的作用_Golang_
- Golang range slice 与range array 之间的区别_Golang_
- Golang使用CGO与Plugin技术运行加载C动态库_Golang_
- Go泛型应用工厂方法及泛型使用_Golang_
- GoLang使goroutine停止的五种方法实例_Golang_
- Go编写定时器与定时任务详解(附第三方库gocron用法)_Golang_
- Go语言中interface语法与使用详解_Golang_
