log
Go语言内置的log包实现了简单的日志服务。本文介绍了标准库log的基本使用。
Go内置的log库功能有限,例如无法满足记录不同级别日志的情况,我们在实际的项目中根据自己的需要选择使用第三方的日志库,如logrus、zap等。
使用Logger
log包定义了Logger类型,该类型提供了一些格式化输出的方法。本包也提供了一个预定义的“标准”logger,可以通过调用函数Print系列(Print|Printf|Println)、Fatal系列(Fatal|Fatalf|Fatalln)、和Panic系列(Panic|Panicf|Panicln)来使用,比自行创建一个logger对象更容易使用。
例如,我们可以像下面的代码一样直接通过log包来调用上面提到的方法,默认它们会将日志信息打印到终端界面:
package main
import (
"log"
)
func main() {
log.Println("这是一条很普通的日志。")
v := "很普通的"
log.Printf("这是一条%s日志。\n", v)
log.Fatalln("这是一条会触发fatal的日志。")
log.Panicln("这是一条会触发panic的日志。")
}
编译并执行上面的代码会得到如下输出:
2017/06/19 14:04:17 这是一条很普通的日志。
2017/06/19 14:04:17 这是一条很普通的日志。
2017/06/19 14:04:17 这是一条会触发fatal的日志。
logger会打印每条日志信息的日期、时间,默认输出到系统的标准错误。Fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后panic。
配置logger
标准logger的配置
默认情况下的logger只会提供日志的时间信息,但是很多情况下我们希望得到更多信息,比如记录该日志的文件名和行号等。log标准库中为我们提供了定制这些设置的方法。
log标准库中的Flags函数会返回标准logger的输出配置,而SetFlags函数用来设置标准logger的输出配置。
func Flags() int
func SetFlags(flag int)
flag选项
log标准库提供了如下的flag选项,它们是一系列定义好的常量。
const (
// 控制输出日志信息的细节,不能控制输出的顺序和格式。
// 输出的日志在每一项后会有一个冒号分隔:例如2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
Ldate = 1 << iota // 日期:2009/01/23
Ltime // 时间:01:23:23
Lmicroseconds // 微秒级别的时间:01:23:23.123123(用于增强Ltime位)
Llongfile // 文件全路径名+行号: /a/b/c/d.go:23
Lshortfile // 文件名+行号:d.go:23(会覆盖掉Llongfile)
LUTC // 使用UTC时间
LstdFlags = Ldate | Ltime // 标准logger的初始值
)
下面我们在记录日志之前先设置一下标准logger的输出选项如下:
func main() {
log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
log.Println("这是一条很普通的日志。")
}
编译执行后得到的输出结果如下:
2017/06/19 14:05:17.494943 .../log_demo/main.go:11: 这是一条很普通的日志。
配置日志前缀
log标准库中还提供了关于日志信息前缀的两个方法:
func Prefix() string
func SetPrefix(prefix string)
其中Prefix函数用来查看标准logger的输出前缀,SetPrefix函数用来设置输出前缀。
func main() {
log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
log.Println("这是一条很普通的日志。")
log.SetPrefix("[小王子]")
log.Println("这是一条很普通的日志。")
}
上面的代码输出如下:
[小王子]2017/06/19 14:05:57.940542 .../log_demo/main.go:13: 这是一条很普通的日志。
这样我们就能够在代码中为我们的日志信息添加指定的前缀,方便之后对日志信息进行检索和处理。
配置日志输出位置
func SetOutput(w io.Writer)
SetOutput函数用来设置标准logger的输出目的地,默认是标准错误输出。
例如,下面的代码会把日志输出到同目录下的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("[小王子]")
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, "<New>", log.Lshortfile|log.Ldate|log.Ltime)
logger.Println("这是自定义的logger记录的日志。")
}
将上面的代码编译执行之后,得到结果如下:
<New>2017/06/19 14:06:51 main.go:34: 这是自定义的logger记录的日志。
encoding/json
json.Marshal
json.Marshal 用于将Go的结构体或其他数据类型序列化为JSON格式的字节数组。如果序列化成功,它返回JSON格式的字节切片和nil作为错误值。如果序列化失败,它返回错误。
bytes_slice, err := json.Marshal(a_struct)
if err != nil {
log.Fatalf("JSON marshaling failed: %s", err)
}
json.MarshalIndent
json.MarshalIndent 类似于 json.Marshal,但它会产生格式化的JSON,使输出更易读。它接受额外的参数来控制缩进。第一个参数是要序列化的数据,第二个参数是每行输出的前缀字符串,第三个参数是每个层级的缩进字符串。
bytes_slice, err := json.MarshalIndent(a_struct, "", " ")
if err != nil {
log.Fatalf("JSON marshaling failed: %s", err)
}
json.Unmarshal
json.Unmarshal 用于将JSON字节切片反序列化为Go的数据结构。它接受一个JSON字节切片和一个指向要填充的数据结构的指针。
err := json.Unmarshal(bytes_slice, &a_struct)
if err != nil {
log.Fatalf("JSON unmarshaling failed: %s", err)
}
json.Encode
json.Encode 用于直接将Go的数据结构序列化为JSON格式并写入io.Writer接口(如文件、网络连接等)。这个函数是流式的,适用于将数据直接输出到HTTP响应体或文件中。
encoder := json.NewEncoder(outputWriter)
err := encoder.Encode(a_struct)
if err != nil {
log.Fatalf("JSON encoding failed: %s", err)
}
json.Decode
json.Decode 用于直接从io.Reader接口(如文件、网络连接等)读取并反序列化JSON数据到Go的数据结构。这个函数是流式的,适用于从HTTP请求体或文件中读取数据。
decoder := json.NewDecoder(inputReader)
err := decoder.Decode(&a_struct)
if err != nil {
log.Fatalf("JSON decoding failed: %s", err)
}
在这些函数中,json.Marshal 和 json.MarshalIndent 用于将Go数据结构转换为JSON格式的字节切片,而json.Unmarshal 用于将JSON字节切片转换回Go数据结构。json.Encode 和 json.Decode 则提供了一种流式的方式来直接序列化和反序列化JSON数据。