在Golang项目开发中,错误日志记录是不可或缺的功能,它可以帮助开发者快速定位程序运行时的异常,追溯问题发生的前因后果。不管是小型工具还是大型服务,合理的错误日志记录机制都能大幅降低运维和问题排查的成本。

Golang标准库log的基础用法
Golang标准库自带了log包,提供了最基础的日志记录能力,无需额外安装依赖就可以直接使用,适合简单的日志记录场景。
基础的错误日志记录示例如下:
package main
import (
"log"
"os"
)
func main() {
// 设置日志前缀和标志位,Lshortfile表示日志中携带文件名和行号
log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
// 模拟一个错误场景
err := os.Open("not_exist.txt")
if err != nil {
// 记录错误日志
log.Printf("打开文件失败,错误信息:%v", err)
// 也可以使用Fatal,记录日志后会直接退出程序
// log.Fatalf("打开文件失败,错误信息:%v", err)
}
}log包默认将日志输出到标准错误流,我们也可以自定义输出目标,比如输出到指定文件:
package main
import (
"log"
"os"
)
func main() {
// 创建或打开日志文件
logFile, err := os.OpenFile("app.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
if err != nil {
log.Fatalf("打开日志文件失败:%v", err)
}
defer logFile.Close()
// 设置日志输出到文件
log.SetOutput(logFile)
log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
log.Println("这是一条输出到文件的错误日志")
}自定义错误日志格式
标准库log包的默认格式比较简单,如果需要自定义日志格式,比如添加日志级别、自定义时间格式,可以基于log.Logger结构体实现:
package main
import (
"log"
"os"
"time"
)
type CustomLogger struct {
logger *log.Logger
level string
}
func NewCustomLogger(file *os.File, level string) *CustomLogger {
return &CustomLogger{
logger: log.New(file, "", 0),
level: level,
}
}
func (c *CustomLogger) Error(format string, v ...interface{}) {
// 自定义日志格式:时间 [级别] 内容
prefix := time.Now().Format("2006-01-02 15:04:05") + " [" + c.level + "] "
c.logger.SetPrefix(prefix)
c.logger.Printf(format, v...)
}
func main() {
logFile, _ := os.OpenFile("custom.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
defer logFile.Close()
logger := NewCustomLogger(logFile, "ERROR")
logger.Error("用户登录失败,用户名:%s", "test_user")
}错误日志分级与第三方库选择
如果项目需要更复杂的日志功能,比如多级别日志、日志轮转、结构化日志,标准库就不够用了,此时可以选择成熟的第三方日志库,常用的有logrus、zap等。
以logrus为例,它支持多种日志级别,使用起来非常方便:
package main
import (
"github.com/sirupsen/logrus"
"os"
)
func main() {
// 创建logrus实例
logger := logrus.New()
// 设置输出到文件
file, _ := os.OpenFile("logrus.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
logger.SetOutput(file)
// 设置日志格式为JSON格式,方便后续日志分析
logger.SetFormatter(&logrus.JSONFormatter{})
// 设置日志级别,低于该级别的日志不会输出
logger.SetLevel(logrus.InfoLevel)
// 记录错误日志
logger.WithFields(logrus.Fields{
"user_id": 1001,
"module": "login",
}).Error("用户登录时密码错误")
}错误日志记录的最佳实践
在实际项目中实现错误日志记录时,有几个需要注意的点:
- 日志内容要包含足够的上下文信息,比如操作人、相关ID、错误发生的模块,方便快速定位问题
- 敏感信息不要记录到日志中,比如用户密码、身份证号、token等,避免信息泄露
- 生产环境的日志级别不要设置过低,避免产生大量无用日志占用磁盘空间,一般设置为Info或Warn级别
- 日志文件要做好轮转策略,避免单个日志文件过大,影响读写和排查效率
总的来说,小型项目可以优先使用标准库log包实现基础的错误日志记录,中大型项目或者对日志功能有更高要求的场景,可以选择logrus、zap这类成熟的第三方库,根据项目实际需求灵活调整日志记录的策略。