关于golang:Golang手撸一个支持六种级别的日志库

Golang 规范日志库提供的日志输入办法有 Print、Fatal、Panic 等，没有常见的 Debug、Info、Error 等日志级别，用起来不太棘手。这篇文章就来手撸一个本人的日志库，能够记录不同级别的日志。

其实对于谋求简略来说，Golang 规范日志库的三个输入办法也够用了，了解起来也很容易：

• Print 用于记录一个一般的程序日志，开发者想记点什么都能够。
• Fatal 用于记录一个导致程序解体的日志，并会退出程序。
• Panic 用于记录一个异样日志，并触发 panic。

不过对于用惯了 Debug、Info、Error 的人来说，还是有点不习惯；对于想更粗疏的辨别日志级别的需要，规范日志库还提供了一个通用的 Output 办法，开发者在要输入的字符串中退出级别也是能够的，但总是有点顺当，不够间接。

目前市面上也曾经有很多优良的三方日志库，比方 uber 开源的 zap，常见的还有 zerolog、logrus 等。不过我这里还是想本人手撸一个，因为大多数开源产品都不会齐全贴合本人的需要，有很多本人用不上的性能，这会减少零碎的复杂性，有没有暗藏的坑也很难说，当然本人入坑的可能性也很大；再者看了官网日志库的实现之后，感觉能够简略封装下即可实现本人想要的性能，可能 hold 住。

初始需要

我这里的初始需要是：

• 将日志写入磁盘文件，每个月一个文件夹，每个小时一个文件。
• 反对常见日志级别：Trace、Debug、Info、Warn、Error、Fatal，并且程序可能设置日志级别。

我给这个日志库取名为 ylog，预期的应用办法如下：

ylog.SetLevel(LevelInfo)
ylog.Debug("I am a debug log.")
ylog.Info("I am a Info log.")

技术实现

类型定义

须要定义一个构造体，保留日志级别、要写入的文件等信息。

type FileLogger struct {
    lastHour int64
    file     *os.File
    Level    LogLevel
    mu       sync.Mutex
    iLogger  *log.Logger
    Path     string
}

来看一下这几个参数：

lastHour 用来记录创立日志文件时的小时数，如果小时变了，就要创立新的日志文件。

file 以后应用的日志文件。

Level 以后应用的日志级别。

mu 因为可能在不同的 go routine 中写日志，须要一个互斥体保障日志文件不会反复创立。

iLogger 规范日志库实例，因为这里是封装了规范日志库。

Path 日志输入的最上层目录，比方程序根目录下的 logs 目录，这里就保留一个字符串：logs。

日志级别

先把日志级别定义进去，这里日志级别其实是 int 类型，从 0 到 5，级别一直升高。

如果设置为 ToInfo，则 Info 级别及比 Info 级别高的日志都能输入。

type LogLevel int
const (
    LevelTrace LogLevel = iota
    LevelDebug
    LevelInfo
    LevelWarn
    LevelError
    LevelFatal
)

上文提到能够在 Output 办法的参数中退出日志级别，这里就通过封装 Output 办法来实现不同级别的日志记录办法。这里贴出其中一个办法，封装的形式都一样，就不全都贴出来了：

func (l *FileLogger) CanInfo() bool {return l.Level <= LevelInfo}

func (l *FileLogger) Info(v ...any) {if l.CanInfo() {l.ensureFile()
        v = append([]any{"Info"}, v...)
        l.iLogger.Output(2, fmt.Sprintln(v...))
    }
}

输入日志前做了三件事：

• 判断日志级别，如果设置的日志级别小于等于以后输入级别，则能够输入。
• 确保日志文件曾经创立好，后边会讲如何确保。
• 将日志级别前插到日志字符串中。

而后调用规范库的 Output 函数输入日志，这里第一个参数是为了获取到以后正在写日志的程序文件名，传入的是在程序调用栈中进行查找的深度值，这里用 2 就正好。

写到文件

规范库的 log 是反对输入到多种指标的，只有实现了 io.Write 接口：

type Writer interface {Write(p []byte) (n int, err error)
}

因为文件对象也实现了这个接口，所以这里能够创立 os.File 的实例，并把它设置到内嵌的规范日志库实例，也就是设置到前边创立的 FileLogger 中的 iLogger 中。这个操作在 ensureFile 办法中，看一下这个文件的实现：

func (l *FileLogger) ensureFile() (err error) {currentTime := time.Now()
    if l.file == nil {l.mu.Lock()
        defer l.mu.Unlock()
        if l.file == nil {l.file, err = createFile(&l.Path, &currentTime)
            l.iLogger.SetOutput(l.file)
            l.iLogger.SetFlags(log.Lshortfile | log.Ldate | log.Ltime | log.Lmicroseconds)
            l.lastHour = getTimeHour(&currentTime)
        }
        return
    }

    currentHour := getTimeHour(&currentTime)
    if l.lastHour != currentHour {l.mu.Lock()
        defer l.mu.Unlock()
        if l.lastHour != currentHour {_ = l.file.Close()
            l.file, err = createFile(&l.Path, &currentTime)
            l.iLogger.SetOutput(l.file)
            l.iLogger.SetFlags(log.Llongfile | log.Ldate | log.Ltime)
            l.lastHour = getTimeHour(&currentTime)
        }
    }

    return
}

这里略微有点简单，根本逻辑是：如果文件实例不存在，则创立；如果须要创立新的文件，则先敞开旧的文件再创立新的文件。

更改文件实例时须要加锁，否则可能屡次操作，呈现预期之外的状况。

设置输入到文件后，规范 log 库的 Output 办法就会将日志输入到这个文件了。

默认实现

通过上边一系列操作，这个 FileLogger 就能够应用了：

var logger = NewFileLogger(LevelInfo, "logs")
logger.Info("This is a info.")

不过和最后构想的用法有点差异：ylog.Info(“xxxx”)

这须要在 ylog 包中再定义一个名为 Info 的公开函数，能够在这个公开函数中调用一个默认创立的 FileLogger 实例，代码是这样的：

var stdPath = "logs"
var std = NewFileLogger(LevelInfo, stdPath)

func Trace(v ...any) {if std.CanTrace() {std.ensureFile()
        v = append([]any{"Trace"}, v...)
        std.iLogger.Output(2, fmt.Sprintln(v...))
    }
}

留神这里没有调用 std 的 Trace 办法，这是因为 Output 中的第一个参数，如果嵌套调用 std.Trace，则多了一层，这个参数就得设置为 3，然而本人创立实例调用 Trace 时这个参数须要为 2，这就产生抵触了。

通过以上这些操作，就能够实现预期的日志操作了：

ylog.SetLevel(LevelInfo)
ylog.Debug("I am a debug log.")
ylog.Info("I am a Info log.")

残缺的程序曾经上传到 Github，欢送拜访：https://github.com/bosima/ylo…

下篇文章将持续革新这个日志库，反对输入 Json 格局的日志，以及输入日志到 Kafka。

播种更多架构常识，请关注微信公众号 萤火架构。原创内容，转载请注明出处。