位置：首页-资讯-后端开发

GoLang实现日志收集器流程讲解

2023-05-20 05:27

短信预约 -IT技能 免费直播动态提醒

Go自己动手实现日志收集

看日志是开发者平时排查BUG所必须的掌握的技能，但是日志是如何来的呢？通过平时开发者自己打日志，经过日志包进行处理，打印日志到控制台还是记录日志到文件中！

下面咱就来学一下日志是如何记录下来的

1. 日志器的接口

以下日志器定义了各类日志器的行为，通过RegisterWriter注册实现了日志器的子类日志器，然后通过Log方法来进行循环调用注册进来的日志收集器的write写日志方法。

// 声明日志写入器接口
type LogWriter interface {
	Write(data interface{}) error
}
// 日志器
type Logger struct {
	// 这个日志器用到的日志写入器
	writerList []LogWriter
}
// 注册一个日志写入器
func (l *Logger) RegisterWriter(writer LogWriter) {
	l.writerList = append(l.writerList, writer)
}
// 将一个data类型的数据写入日志
func (l *Logger) Log(data interface{}) {
	// 遍历所有注册的写入器
	for _, writer := range l.writerList {
		// 将日志输出到每一个写入器中
		writer.Write(data)
	}
}
// 创建日志器的实例
func NewLogger() *Logger {
	return &Logger{}
}

2. 命令写入日志器

这个日志器实现了日志器的接口行为write，可以进行日志的写入，其写入手法是通过Os包来写入到命令行(控制台)中!

// 命令行写入器
type consoleWriter struct {
}
// 实现LogWriter的Write()方法
func (f *consoleWriter) Write(data interface{}) error {
	// 将数据序列化为字符串
	str := fmt.Sprintf("%v\n", data)
	// 将数据以字节数组写入命令行中
	_, err := os.Stdout.Write([]byte(str))
	return err
}
// 创建命令行写入器实例
func NewConsoleWriter() *consoleWriter {
	return &consoleWriter{}
}

3. 文件写入日志器

这也是实现了日志器的一个实现类，文件日志器，一种常见的将日志写入文件记录的日志收集器。使用前需要先SetFile设置好日志文件名，最后将日志作为字节写入到文件中。

// 声明文件写入器
type fileWriter struct {
	file *os.File
}
// 设置文件写入器写入的文件名
func (f *fileWriter) SetFile(filename string) (err error) {
	// 如果文件已经打开, 关闭前一个文件
	if f.file != nil {
		f.file.Close()
	}
	// 创建一个文件并保存文件句柄
	f.file, err = os.Create(filename)
	// 如果创建的过程出现错误, 则返回错误
	return err
}
// 实现LogWriter的Write()方法
func (f *fileWriter) Write(data interface{}) error {
	// 日志文件可能没有创建成功
	if f.file == nil {
		// 日志文件没有准备好
		return errors.New("file not created")
	}
	// 将数据序列化为字符串
	str := fmt.Sprintf("%v\n", data)
	// 将数据以字节数组写入文件中
	_, err := f.file.Write([]byte(str))
	return err
}
// 创建文件写入器实例
func NewFileWriter() *fileWriter {
	return &fileWriter{}
}

4. Demo演示

通过New的方式创建日志器，进行注册到日志器集合中，下面演示了两种日志器如何使用！！！

// 创建日志器
func createLogger() *Logger {
	// 创建日志器
	l := NewLogger()
	// 创建命令行写入器
	cw := cmdwriter.NewConsoleWriter()
	// 注册命令行写入器到日志器中，cw实现了LogWriter接口，故可作为RegisterWriter函数的参数，类型为Logwriter
	l.RegisterWriter(cw)
	// 创建文件写入器
	fw := filerwriter.NewFileWriter()
	// 设置文件名
	if err := fw.SetFile("log.log"); err != nil {
		fmt.Println(err)
	}
	// 注册文件写入器到日志器中，fw实现了LogWriter接口
	l.RegisterWriter(fw)
	return l
}
func main() {
	// 准备日志器
	l := createLogger()
	// 写一个日志
	l.Log("hello")
}