Go语言的log
包提供了用于记录日志的基本功能。相比fmt
包,log
包增加了时间戳、日志级别等日志管理功能,非常适合用于调试和记录运行信息。下面是对log
包的详细说明,以及它与fmt
包的区别。
1. log
包的基础功能
log
包中包含一系列函数,可以用于打印带时间戳的日志信息,默认将日志写入标准错误输出(os.Stderr
),并在每条日志的开头添加时间戳。
常用函数
log.Print
:基本日志输出函数,类似于fmt.Print
,但会在输出前添加时间戳。log.Println
:类似于fmt.Println
,会在输出前添加时间戳,并在结尾添加换行符。log.Printf
:类似于fmt.Printf
,支持格式化输出,并在输出前添加时间戳。
示例代码:
package main
import "log"func main() {log.Print("This is a log message.")log.Println("This is another log message.")log.Printf("Formatted log: %d + %d = %d", 2, 3, 2+3)
}
2. log
包的日志级别函数
log
包还提供了两种特殊的日志函数,用于处理错误和程序退出的情况:
log.Fatal
:用于记录严重的错误信息,输出日志后会调用os.Exit(1)
,终止程序执行。log.Panic
:用于记录错误信息,同时调用panic
,引发恐慌(程序崩溃并抛出堆栈信息),适合用于调试和处理非正常情况。
示例代码:
package main
import "log"func main() {log.Print("This is a normal log.")log.Fatal("This is a fatal error log, program will exit.") // 输出后程序会退出log.Panic("This will not be executed because of Fatal above.")
}
3. 自定义日志输出位置
log
包默认将日志输出到标准错误流(os.Stderr
),但是可以通过log.SetOutput
方法自定义输出位置。可以将日志输出到文件、网络或其他符合io.Writer
接口的目标。
示例:将日志输出到文件
package main
import ("log""os"
)func main() {file, err := os.Create("app.log")if err != nil {log.Fatal("Failed to create log file:", err)}defer file.Close()log.SetOutput(file) // 将日志输出设置为文件log.Println("This log will be written to app.log file.")
}
4. 自定义日志前缀和标记
log
包允许自定义日志的前缀和格式,帮助识别日志的来源或类型。使用log.SetPrefix
方法可以设置日志的前缀,使用log.SetFlags
可以控制日志的标记。
日志标记
log
包提供了以下几个标记(使用SetFlags
设置):
log.Ldate
:日期(yyyy/mm/dd)。log.Ltime
:时间(hh:mm)。log.Lmicroseconds
:微秒级时间。log.Llongfile
:完整文件路径和行号。log.Lshortfile
:简短文件名和行号。log.LUTC
:使用UTC时间。log.LstdFlags
:默认标记,等价于log.Ldate | log.Ltime
。
示例:自定义日志前缀和标记
package main
import "log"func main() {log.SetPrefix("INFO: ") // 设置日志前缀log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile) // 设置日志标记log.Println("This is a customized log message.")
}
5. 创建自定义的日志记录器
使用log.New
可以创建自定义的日志记录器(Logger),并指定不同的输出目标、前缀和标记。多个日志记录器可以记录不同类型的日志信息。
示例:创建两个不同的日志记录器
package main
import ("log""os"
)func main() {// 创建错误日志记录器,输出到标准错误errorLogger := log.New(os.Stderr, "ERROR: ", log.Ldate|log.Ltime|log.Lshortfile)// 创建信息日志记录器,输出到文件infoFile, err := os.Create("info.log")if err != nil {log.Fatal(err)}defer infoFile.Close()infoLogger := log.New(infoFile, "INFO: ", log.Ldate|log.Ltime)infoLogger.Println("This is an informational message.")errorLogger.Println("This is an error message.")
}
log
包与fmt
包的区别
-
用途不同:
fmt
包主要用于格式化输入和输出,适合输出一般信息,不具备日志管理功能。log
包专为日志设计,提供日志记录功能,适合程序中的重要信息、错误、调试信息等的输出。
-
输出内容不同:
fmt
包输出没有时间戳,默认不包含额外信息。log
包输出包含时间戳,且可以设置额外的标记和前缀。
-
输出位置:
fmt
包的输出目标默认为标准输出(os.Stdout
),可以通过fmt.Fprint
将输出定向到指定目标。log
包的默认输出为标准错误(os.Stderr
),且可以通过log.SetOutput
轻松修改输出目标。
-
日志级别:
fmt
包没有日志级别的概念。log
包提供了日志级别的支持(如Fatal
和Panic
)。
-
程序控制:
fmt
包的函数不会影响程序的控制流程。log.Fatal
会终止程序,log.Panic
会引发恐慌,帮助处理异常情况。
总结
fmt
包适合通用的格式化输出,如打印普通消息、调试输出等。log
包适合用于正式的日志记录,提供时间戳、日志级别、日志标记和自定义输出等特性,能够更好地记录和追踪程序的运行状态。