Golang实现Log4j风格日志记录的插件库go-log的使用

介绍

go-log是一个Golang日志库，兼容log和log4go，在大多数情况下可以直接使用而无需修改代码。

安装

使用以下命令安装go-log：

go get github.com/ian-kent/go-log/log

基本使用

简单日志记录

import(
  "github.com/ian-kent/go-log/log"
)

// 直接传递日志消息和参数
log.Debug("Example log message: %s", "example arg")

// 传递返回日志消息和参数的函数
log.Debug(func(){[]interface{}{"Example log message: %s", "example arg"}})
log.Debug(func(i ...interface{}){[]interface{}{"Example log message: %s", "example arg"}})

获取日志记录器实例

// 获取默认日志记录器
logger := log.Logger()
logger.Debug("Yey!")

// 获取命名日志记录器
logger := log.Logger("foo.bar")

日志级别

默认日志级别是DEBUG。

获取和设置日志级别

// 获取当前日志级别
level := logger.Level()

// 从LogLevel设置
logger.SetLevel(levels.TRACE)

// 从字符串设置
logger.SetLevel(log.Stol("TRACE"))

日志附加器(Appenders)

默认日志附加器是appenders.Console()，它将原始消息记录到STDOUT。

获取和设置附加器

// 获取当前附加器
appender := logger.Appender()

// 设置附加器
logger.SetAppender(appenders.Console())

滚动文件附加器

// 追加到(或创建)文件
logger.SetAppender(appenders.RollingFile("filename.log", true))

// 截断(或创建)文件
logger.SetAppender(appenders.RollingFile("filename.log", false))

// 控制备份文件数量
r := appenders.RollingFile("filename.log", true)
r.MaxBackupIndex = 2 // filename.log, filename.log.1, filename.log.2

// 控制最大文件大小(字节)
r := appenders.RollingFile("filename.log", true)
r.MaxFileSize = 1024 // 1KB, 默认为100MB

Fluentd附加器

logger.SetAppender(appenders.Fluentd(fluent.Config{}))

布局(Layouts)

每个附加器都有自己的布局，允许在写入附加器时转换日志数据。

获取和设置布局

// 获取当前布局
appender := logger.Appender()
layout := appender.Layout()

// 设置布局
appender.SetLayout(layout.Basic())

模式布局

// 使用类似log4j的模式格式
appender.SetLayout(layout.Pattern("%d [%p] %c - %m%n"))

模式代码说明：

日志记录器继承

日志记录器使用.命名空间，遵循与Log4j类似的规则。

logger := log.Logger("foo.bar")
logger.SetLevel(levels.TRACE)
logger.SetAppender(appenders.Console())

完整示例

package main

import (
	"github.com/ian-kent/go-log/log"
	"github.com/ian-kent/go-log/log/levels"
	"github.com/ian-kent/go-log/log/appenders"
	"github.com/ian-kent/go-log/log/layout"
)

func main() {
	// 获取根日志记录器
	rootLogger := log.Logger()
	
	// 设置日志级别为DEBUG
	rootLogger.SetLevel(levels.DEBUG)
	
	// 设置控制台附加器，使用自定义模式布局
	consoleAppender := appenders.Console()
	consoleAppender.SetLayout(layout.Pattern("%d [%p] %c - %m%n"))
	rootLogger.SetAppender(consoleAppender)
	
	// 记录不同级别的日志
	rootLogger.Debug("This is a debug message")
	rootLogger.Info("This is an info message")
	rootLogger.Warn("This is a warning message")
	rootLogger.Error("This is an error message")
	
	// 创建命名日志记录器
	serviceLogger := log.Logger("myapp.service")
	
	// 设置滚动文件附加器
	fileAppender := appenders.RollingFile("service.log", true)
	fileAppender.MaxBackupIndex = 3
	fileAppender.MaxFileSize = 1024 * 1024 // 1MB
	serviceLogger.SetAppender(fileAppender)
	
	// 使用命名日志记录器
	serviceLogger.Info("Service started")
	serviceLogger.Debug("Processing request #%d", 123)
	
	// 创建子日志记录器
	dbLogger := log.Logger("myapp.service.database")
	dbLogger.SetLevel(levels.TRACE)
	dbLogger.Trace("Database connection established")
}

注意事项

go-log与默认的Go 'log’包不一致，log.Fatal调用不会触发os.Exit(1)。这已在当前版本的go-log中修复，可能会破坏向后兼容性。

可以通过设置ExitOnFatal为false来禁用此修复：

log.Logger().ExitOnFatal = false