阿坝州网站建设公司

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) {
	curTime := time.Now()
	curHour := getTimeHour(curTime)
	if atomic.LoadInt64(&l.lastHour) != curHour {
		return l.ensureFileSlow(curTime, curHour)
	}

	return
}

func (l *FileLogger) ensureFileSlow(curTime time.Time, curHour int64) (err error) {
	l.mu.Lock()
	defer l.mu.Unlock()
	if l.lastHour != curHour {
		defer atomic.StoreInt64(&l.lastHour, curHour)
		l.createFile(curTime, curHour)
	}
	return
}

func (l *FileLogger) createFile(curTime time.Time, curHour int64) (err error) {
	if l.file == nil {
		l.file, err = createFile(l.Path, curTime)
		if err != nil {
			return err
		}
		l.iLogger.SetOutput(l.file)
		l.iLogger.SetFlags(log.Lshortfile | log.Ldate | log.Ltime | log.Lmicroseconds)
	} else {
		_ = l.file.Close()
		l.file, err = createFile(l.Path, curTime)
		if err != nil {
			return err
		}
		l.iLogger.SetOutput(l.file)
		l.iLogger.SetFlags(log.Lshortfile | log.Ldate | log.Ltime | log.Lmicroseconds)
	}

	return
}

这里稍微有点复杂，基本逻辑是：如果文件实例不存在，则创建；如果需要创建新的文件，则先关闭旧的文件再创建新的文件。

这里使用了双检锁的模式，避免了每次访问都使用互斥锁的开销，同时考虑到Golang中对变量的读写也不是协程安全的，会出现同时读写的情况，所以使用了原子操作，写法参考了sync.Once的源码。

设置输出到文件后，标准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/ylog/tree/v1.0.2

下篇文章将继续改造这个日志库，支持输出Json格式的日志，以及输出日志到Kafka。

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


当前题目：Golang：手撸一个支持六个级别的日志库
标题路径：http://azwzsj.com/article/dsoisoe.html

其他资讯