golang中的标准库log

Go语言内置的log包实现了简单的日志服务。本文介绍了标准库log的基本使用。

使用Logger

log包定义了Logger类型，该类型提供了一些格式化输出的方法。本包也提供了一个预定义的“标准”logger，可以通过调用函数Print系列(Print|Printf|Println）、Fatal系列（Fatal|Fatalf|Fatalln）、和Panic系列（Panic|Panicf|Panicln）来使用，比自行创建一个logger对象更容易使用。

例如，我们可以像下面的代码一样直接通过log包来调用上面提到的方法，默认它们会将日志信息打印到终端界面：

func main() {
	defer func() {
		log.Println(recover())  // 捕获panic抛出的异常，并输出
	}()
	log.Println("这是一个普通的日志")
	v := "一个普通的"
	log.Printf("这是%s日志\n", v)

	log.Panicln("这是一条会触发Panicln的日志")

	log.Fatalln("这是一条会触发Fatalln的日志")
}

输出结果：

2021/11/29 15:44:33 这是一个普通的日志
2021/11/29 15:44:33 这是一个普通的日志
2021/11/29 15:44:33 这是一条会触发Panicln的日志
2021/11/29 15:44:33 这是一条会触发Panicln的日志

logger会打印每条日志信息的日期、时间，默认输出到系统的标准错误。Fatal系列函数会在写入日志信息后调用os.Exit(1)。Panic系列函数会在写入日志信息后panic。

配置Logger

默认情况下的logger只会提供日志的时间信息，但是很多情况下我们希望得到更多信息，比如记录该日志的文件名和行号等。log标准库中为我们提供了定制这些设置的方法。

log标准库中的Flags函数会返回标准logger的输出配置，而SetFlags函数用来设置标准logger的输出配置。

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.Ldate | log.Ltime | log.Llongfile)
	log.Printf("标准日志输出格式")
}

输出结果：

2021/11/29 16:26:55 C:/Users/mayanan/Desktop/pro_go/common_standard_library/main.go:7: 标准日志输出格式

配置日志前缀

log标准库中还提供了关于日志信息前缀的两个方法：

func main() {
	log.SetFlags(log.Ldate | log.Ltime | log.Llongfile)
	log.Println("标准日志输出格式")

	log.SetPrefix("[pprof]")
	log.Println("日志")
}

输出结果：

2021/11/29 16:31:30 C:/Users/mayanan/Desktop/pro_go/common_standard_library/main.go:7: 标准日志输出格式
[pprof]2021/11/29 16:31:30 C:/Users/mayanan/Desktop/pro_go/common_standard_library/main.go:10: 日志

这样我们就能够在代码中为我们的日志信息添加指定的前缀，方便之后对日志信息进行检索和处理。

配置日志输出位置

SetOutput函数用来设置标准logger的输出目的地，默认是标准错误输出。

func main() {
	// 注意第一步要先建个log目录,文件系统可以自己建
	today := time.Now().Format("2006-01-02")
	logPath := fmt.Sprintf("./log/%s.txt", today)
	logFile, err := os.OpenFile(logPath, 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("这是一条很普通的日志。2222")
	log.SetPrefix("[小王子]")  // 设置日志输出前缀
	log.Println("这是一条很普通的日志22222。")
}

如果你要使用标准的logger，我们通常会把上面的配置操作写到init函数中。

func init() {
	// 注意第一步要先建个log目录,文件系统可以自己建
	today := time.Now().Format("2006-01-02")
	logPath := fmt.Sprintf("./log/%s.txt", today)
	logFile, err := os.OpenFile(logPath, 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.SetPrefix("[小王子]")  // 设置日志输出前缀

}

func main() {
	log.Println("日志成功完成")
}

创建Logger

log标准库中还提供了一个创建新logger对象的构造函数–New，支持我们创建自己的logger示例

var MyLogger *log.Logger
func init() {
	// 注意第一步要先建个log目录,文件系统可以自己建
	today := time.Now().Format("2006-01-02")
	logPath := fmt.Sprintf("./log/%s.txt", today)
	logFile, err := os.OpenFile(logPath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
	if err != nil {
		fmt.Println("open log file failed, err:", err)
		return
	}

	MyLogger = log.New(logFile, "sankuan", log.Ldate|log.Ltime|log.Llongfile)

}

func main() {
	MyLogger.Println("我自定义的一个日志")
}

总结 : Go内置的log库功能有限，例如无法满足记录不同级别日志的情况，我们在实际的项目中根据自己的需要选择使用第三方的日志库，如logrus、zap等。