Golang 统一日志接口与最佳实践：集成插件库 Logur 的使用

警告

这个项目已经归档且不再维护。建议考虑使用 log/slog 替代。

Logur 简介

Logur 是一个遵循日志最佳实践的日志库，其主要特点包括：

核心特性

• 统一的日志接口
• 用于测试日志记录的测试日志器
• 用于丢弃日志事件的无操作日志器
• io.Writer 支持
• 标准库日志器支持
• 与知名库的集成（如 gRPC、MySQL 驱动、Watermill 等）
• 知名日志库的适配器（如 hclog、logrus、zap 等）

安装

使用 Go Modules 安装：

go get logur.dev/logur

最佳实践示例

创建自定义接口

建议定义自己的日志接口而不是直接使用 Logur 的接口：

type MyLogger interface {
    Trace(msg string, fields ...map[string]interface{})
    Debug(msg string, fields ...map[string]interface{})
    Info(msg string, fields ...map[string]interface{})
    Warn(msg string, fields ...map[string]interface{})
    Error(msg string, fields ...map[string]interface{})
}

func main() {
    logger := logur.NewNoopLogger()

    myFunc(logger)
}

func myFunc(logger MyLogger) {
    logger.Debug("myFunc ran")
    // 或
    logger.Debug("myFunc ran", map[string]interface{}{"key": "value"})
}

带字段的日志接口

如果需要添加公共上下文，可以这样扩展接口：

type MyLogger interface {
    Trace(msg string, fields ...map[string]interface{})
    Debug(msg string, fields ...map[string]interface{})
    // ...
    WithFields(fields map[string]interface{}) MyLogger
}

type myLogger struct {
    logger logur.Logger
}

func (l *myLogger) Debug(msg string, fields ...map[string]interface{}) { l.logger.Debug(msg, fields...) }
func (l *myLogger) WithFields(fields map[string]interface{}) MyLogger {
    return &myLogger{logur.WithFields(l.logger, fields)}
}

func main() {
    logger := &myLogger{logur.NewNoopLogger()}
    myFunc(logger)
}

func myFunc(logger MyLogger) {
    logger.WithFields(map[string]interface{}{"key": "value"}).Debug("myFunc ran", nil)
}

标准库日志器集成

创建标准库日志器用于 HTTP 服务器错误日志：

func newStandardErrorLogger() *log.Logger {
    return logur.NewStandardLogger(logur.NewNoopLogger(), logur.ErrorLevel, "", 0)
}

func main() {
    server := &http.Server{
        Handler: nil,
        ErrorLog: newStandardErrorLogger(),
    }
}

常见问题

为什么不直接使用某个日志库？

使用自定义接口可以避免将应用程序与特定日志库耦合。

为什么不使用 Go kit 日志器？

虽然 Go kit 的日志接口简单强大，但它需要导入额外的包来实现结构化或分级日志。

为什么不使用 logger.With(keyvals ...interface{})？

虽然这种接口更简洁，但使用 map[string]interface{} 也有其优势：

• 更清晰的键值对关系
• 避免奇数个参数的问题
• 性能差异在大多数情况下可以忽略

为什么没有格式化函数（*f）？

现代日志实践更推荐结构化日志而不是格式化消息。

为什么没有行日志函数（*ln）？

单独的日志事件通常已经占据一行，添加这些函数价值不大。

完整示例

package main

import (
    "logur.dev/logur"
)

// 自定义日志接口
type AppLogger interface {
    Debug(msg string, fields ...map[string]interface{})
    Info(msg string, fields ...map[string]interface{})
    Error(msg string, fields ...map[string]interface{})
    WithFields(fields map[string]interface{}) AppLogger
}

// 适配器实现
type logurAdapter struct {
    logger logur.Logger
}

func (l *logurAdapter) Debug(msg string, fields ...map[string]interface{}) {
    l.logger.Debug(msg, fields...)
}

func (l *logurAdapter) Info(msg string, fields ...map[string]interface{}) {
    l.logger.Info(msg, fields...)
}

func (l *logurAdapter) Error(msg string, fields ...map[string]interface{}) {
    l.logger.Error(msg, fields...)
}

func (l *logurAdapter) WithFields(fields map[string]interface{}) AppLogger {
    return &logurAdapter{logur.WithFields(l.logger, fields)}
}

func main() {
    // 使用无操作日志器
    logger := &logurAdapter{logur.NewNoopLogger()}
    
    // 带上下文的日志
    serviceLogger := logger.WithFields(map[string]interface{}{
        "service": "user",
        "version": "1.0",
    })
    
    serviceLogger.Info("Service started")
    serviceLogger.Debug("Processing request", map[string]interface{}{
        "user_id": 123,
        "action":  "create",
    })
    
    // 错误日志
    serviceLogger.Error("Failed to process request", map[string]interface{}{
        "error": "connection timeout",
    })
}

Logur 虽然不再维护，但它展示的日志接口设计和最佳实践仍然值得学习。对于新项目，建议考虑 Go 1.21 引入的 log/slog 作为替代方案。