Go标准库之Log
文章引用自
Go语言标准库log介绍
无论是软件开发的调试阶段还是软件上线之后的运行阶段,日志一直都是非常重要的一个环节,我们也应该养成在程序中记录日志的好习惯。
log
Go语言内置的log
包实现了简单的日志服务。本文介绍了标准库log
的基本使用。
使用Logger
log包定义了Logger类型,该类型提供了一些格式化输出的方法。本包也提供了一个预定义的“标准”logger,可以通过调用函数Print系列
(Print|Printf|Println)、Fatal系列
(Fatal|Fatalf|Fatalln)、和Panic系列
(Panic|Panicf|Panicln)来使用,比自行创建一个logger对象更容易使用。
例如,我们可以像下面的代码一样直接通过log
包来调用上面提到的方法,默认它们会将日志信息打印到终端界面:
1 2 3 4 5 6 7 8 9 10 11 12 13 | package main import ( "log" ) func main() { log.Println( "这是一条很普通的日志。" ) v := "很普通的" log.Printf( "这是一条%s日志。\n" , v) log.Fatalln( "这是一条会触发fatal的日志。" ) log.Panicln( "这是一条会触发panic的日志。" ) } |
编译并执行上面的代码会得到如下输出:
1 2 3 | 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的输出配置。
1 2 | func Flags() int func SetFlags(flag int) |
flag选项
log
标准库提供了如下的flag选项,它们是一系列定义好的常量。
1 2 3 4 5 6 7 8 9 10 11 | 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的输出选项如下:
1 2 3 4 | func main() { log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate) log.Println( "这是一条很普通的日志。" ) } |
编译执行后得到的输出结果如下:
1 | 2017/06/19 14:05:17.494943 .../log_demo/main. go :11: 这是一条很普通的日志。 |
配置日志前缀
log
标准库中还提供了关于日志信息前缀的两个方法:
1 2 | func Prefix() string func SetPrefix(prefix string) |
其中Prefix
函数用来查看标准logger的输出前缀,SetPrefix
函数用来设置输出前缀。
1 2 3 4 5 6 | func main() { log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate) log.Println( "这是一条很普通的日志。" ) log.SetPrefix( "[小王子]" ) log.Println( "这是一条很普通的日志。" ) } |
上面的代码输出如下:
1 | [小王子]2017/06/19 14:05:57.940542 .../log_demo/main. go :13: 这是一条很普通的日志。 |
这样我们就能够在代码中为我们的日志信息添加指定的前缀,方便之后对日志信息进行检索和处理。
配置日志输出位置
1 | func SetOutput(w io.Writer) |
SetOutput
函数用来设置标准logger的输出目的地,默认是标准错误输出。
例如,下面的代码会把日志输出到同目录下的xx.log
文件中。
1 2 3 4 5 6 7 8 9 10 11 12 | 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
函数中。
1 2 3 4 5 6 7 8 9 | 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定义日志的属性(时间、文件等等)。
举个例子:
1 2 3 4 | func main() { logger := log.New(os.Stdout, "<New>" , log.Lshortfile|log.Ldate|log.Ltime) logger.Println( "这是自定义的logger记录的日志。" ) } |
将上面的代码编译执行之后,得到结果如下:
1 | <New>2017/06/19 14:06:51 main. go :34: 这是自定义的logger记录的日志。 |
总结
Go内置的log库功能有限,例如无法满足记录不同级别日志的情况,我们在实际的项目中根据自己的需要选择使用第三方的日志库,如logrus、zap等。
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· PostgreSQL 和 SQL Server 在统计信息维护中的关键差异
· DeepSeek “源神”启动!「GitHub 热点速览」
· 我与微信审核的“相爱相杀”看个人小程序副业
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· 如何使用 Uni-app 实现视频聊天(源码,支持安卓、iOS)
· C# 集成 DeepSeek 模型实现 AI 私有化(本地部署与 API 调用教程)