使用Logger
log包定义了Logger类型,该类型提供了一些格式化输出的方法。本包也提供了一个预定义的“标准”logger,可以通过调用函数Print系列(Print|Printf|Println),Fatal系(Fatal|Fatalf|Fatalln)和Panic系列(Panic|Panicf|Panicln)来使用,比自行创建一个logger对象更容易使用。后面会有自行创建。
例如,我们可以像下面的代码一样直接通过log包来调用上面提到的方法,默认它们会将日志信息打印到终端界面:
package main
import "log"
func main() {
//std.Output(2, fmt.Sprintf(format, v...))
v := "很普通的"
log.Printf("这是一条%s日志。\n", v)
//std.Output(2, fmt.Sprintln(v...))
log.Println("这是一条很普通的日志。")
//std.Output(2, fmt.Sprintln(v...))
//os.Exit(1)
log.Fatalln("这是一条会触发fatal的日志。")
//s := fmt.Sprintln(v...)
//std.Output(2, s)
//panic(s)
log.Panicln("这是一条会触发panic的日志。")
}
$ go run main.go
2021/10/27 23:51:54 这是一条很普通的日志。
2021/10/27 23:51:54 这是一条很普通的日志。
2021/10/27 23:51:54 这是一条会触发fatal的日志。
exit status 1
logger会打印每条日志信息的日期、时间,默认输出到系统的标准错误。Fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后panic。
配置logger
默认情况下的logger只会提供日志的时间信息,但是很多情况下我们希望得到更多信息,比如记录该日志的文件名和行号等。log标准库中为我们提供了定制这些设置的方法。
log标准库中的Flags函数会返回标准logger的输出配置,而SetFlags函数用来设置标准logger的输出配置。
func Flags() int
func SetFlags(flag int)
配置日志格式-Flags
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.Lshortfile| log.Lmicroseconds | log.Ldate)
log.Println("这是一条很普通的日志。")
fmt.Println("flags=",log.Flags())
}
$ go run main.go
2021/10/27 23:56:22.987681 main.go:10: 这是一条很普通的日志。
flags= 21
配置日志前缀-Prefix
log标准库中还提供了关于日志信息前缀的两个方法
func Prefix() string
func SetPrefix(prefix string)
其中Prefix函数用来查看标准logger的输出前缀,SetPrefix函数用来设置输出前缀。
func main() {
log.SetFlags(log.Lshortfile | log.Lmicroseconds | log.Ldate)
log.Println("这是一条很普通的日志。")
log.SetPrefix("[info]")
log.Println("这是一条很普通的日志。")
fmt.Println(log.Prefix())
}
$ go run main.go
2021/10/27 23:58:16.750975 main.go:10: 这是一条很普通的日志。
[info]2021/10/27 23:58:16.797155 main.go:12: 这是一条很普通的日志。
[info]
这样我们就能够在代码中为我们的日志信息添加指定的前缀,方便之后对日志信息进行检索和处理。
配置日志输出位置-Output
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.Lshortfile | log.Lmicroseconds | log.Ldate)
log.SetPrefix("[info]")
log.Println("这是一条很普通的日志。")
}
使用标准logger
//log.go源码片段
var std = New(os.Stderr, "", LstdFlags)
func New(out io.Writer, prefix string, flag int) *Logger {
return &Logger{out: out, prefix: prefix, flag: flag}
}
使用标准的logger即全局变量std,我们通常会把上面的配置操作写到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.Lshortfile | log.Lmicroseconds | log.Ldate)
}
自定义logger
log标准库中还提供了一个创建新logger对象的构造函数–New,支持我们创建自己的logger示例
func New(out io.Writer, prefix string, flag int) *Logger {
return &Logger{out: out, prefix: prefix, flag: flag}
}
New创建一个Logger对象。其中,参数out设置日志信息写入的目的地。参数prefix会添加到生成的每一条日志前面。参数flag定义日志的属性(时间、文件等等)。
func main() {
logger := log.New(os.Stdout, "<New>", log.Lshortfile|log.Lmicroseconds|log.Ldate)
logger.Println("这是自定义的logger记录的日志。")
}
$ go run main.go
<New>2021/10/28 00:06:36.734481 main.go:10: 这是自定义的logger记录的日志。
总结
Go内置的log库功能有限,例如无法满足记录不同级别日志的情况,我们在实际的项目中根据自己的需要选择使用第三方的日志库,如logrus、zap等。目前zap是主流