随笔- 542 文章- 6 评论- 27 阅读- 29万

Go从入门到精通——接口(interface)——示例：便于扩展输出方式的日志系统

示例：便于扩展输出方式的日志系统

日志可以用于查看和分析应用程序的运行状态。日志一般可以支持输出多种形式，如命令行、文件、网络等。

1、日志对外接口

本例中定义一个日志写入器接口（LogWriter）,要求写入设备必须遵守这个接口协议才能被日志器（Logger）注册。日志器有一个写入器的注册方法（Logger 的 RegisterWriter() 方法）。

日志器还有一个 Log() 方法，进行日志的输出，这个函数会将日志写入到所有已经注册的日志写入器（LogWriter）中，详细代码实现如下：

代码 1-1 日志写入器（logger/logger.go）

package main
 
// LogWriter 声明日志写入器接口。
// 这个接口可以被外部使用。 日志的输出可以有多种设备，这个写入器就是用来实现一个日志的输出设备。
type LogWriter interface {
    Write(data interface{}) error
}
 
// Logger 日志器结构。日志器使用 writeList 记录输出到哪些设备上。
type Logger struct {
    //这个日志器用到的日志写入器
    writerList []LogWriter
}
 
/*RegisterWriter 注册一个日志写入器。
使用日志器方法 RegisterWriter() 将一个日志写入器（LogWriter）注册到日志器（Logger）中。
注册的意思就是将日志写入器的接口添加到 writerList 中。
*/
func (l *Logger) RegisterWriter(writer LogWriter) {
    l.writerList = append(l.writerList, writer)
}
 
// Log 将一个 data 类型的数据写入日志
func (l *Logger) Log(data interface{}) {
 
    //遍历日志器拥有的所有日志写入器
    for _, writer := range l.writerList {
 
        //将本次日志的内容写入日志写入器
        writer.Write(data)
    }
}
 
// NewLogger 创建日志器的实例。
// 定义 Logger结构的函数，返回 Logger 指针
func NewLogger() *Logger {
 
    //取地址实例化 Logger 的结构体
    return &Logger{}
}

2、文件写入器

文件写入器（fileWriter）是众多日志写入器（LogWriter）中的一种。文件写入器的功能是根据一个文件名创建日志文件（fileWriter 的 SetFile 方法）。在有日志写入时，将要日志写入文件中。

代码 1-2 文件写入器（logger/file.go）

package main
 
import (
    "errors"
    "fmt"
    "os"
)
 
//声明文件写入器。在结构体中保存一个文件句柄，以便每次写入时操作。
type fileWriter struct {
    //从字面上看，os.File类型代表了操作系统中的文件。
    //比如对于类Unix的操作系统，括Linux、macOS、FreeBSD等，其中的一切都可以被看作是文件。
    //os.File类型拥有的都是指针方法，它的指针实现了很多io包中的接口。
    file *os.File
}
 
//设置文件写入器写入的文件名。
//文件写入器通过文件名创建文件，这里通过 SetFile() 的参数提供一个文件名，并创建该文件名。
func (f *fileWriter) SetFile(filename string) (err error) {
 
    //考虑到 SetFile() 方法可以被多次调用，如果文件已经打开，关闭前一个文件
    if f.file != nil {
        f.file.Close()
    }
 
    //创建一个文件并保存文件句柄
    f.file, err = os.Create(filename)
 
    //如果创建的过程出现错误，则返回错误
    return err
}
 
// fileWriter 实现 LogWriter 的 Write() 方法
func (f *fileWriter) Write(data interface{}) error {
 
    //日志文件可能没有创建成功
    if f.file == nil {
 
        //如果文件没有准备好，文件句柄就为nil，此时使用 errors 包中的 New() 函数返回一个错误对象，包含一个错误字符串返回。
        return errors.New("文件不存在！")
    }
 
    //传入的参数 data 是 interface{} 类型，而 f.file 的 Write（） 方法需要的是 []bytes 类型。
    //所以使用 fmt.Sprintf 将 data 转换为字符串，"%v" 意思是将 data 按其本来的值转换为
    str := fmt.Sprintf("%v\n", data)
 
    //通过 f.file 的 Write() 方法，将 str 字符串转换为 []byte 字节数组，再将数据以字节数组写入文件中
    _, err := f.file.Write([]byte(str))
 
    return err
}
 
//创建文件写入器实例
func newFileWriter() *fileWriter {
    return &fileWriter{}
}

提示：

    一个完备的文件写入器会提供多种文件写入的模式，例子中使用的模式是将日志添加到日志文件的尾部。
    随着文件原来越大，文件的访问效率和查看变量性也会大大降低。此时，就需要另外一钟写入模式：滚动写入文件。
    滚动写入文件模式也是将日志添加到文件的尾部，但当文件达到设定的期望大小时，会自动开启一个新的文件继续写入文件，最终将获得多个日志文件。
    日志文件不仅可以按照文件大小进行分割，还可以按照日期范围进行分割。在到达设定的日期范围，如每天、每小时的周期范围时，日志器会自动创建新的日志文件。这种日志文件创建方法也能方便开发者按日志查看日志。

3、命令行写入器

在 UNIX 的思想中，一切皆文件。文件包括内存、磁盘、网络和命令行等。这种抽象方法方便我们访问这些看不见摸不着的虚拟资源。命令行在 Go 中也是一种文件。

os.Stdout 对应标准输出，一般表示屏幕，也就是命令行，也可以被重定向为打印机或者磁盘文件。

os.Stderr 对应标准错误输出，一般将错误输出到日志中。

不过大多数情况，os.Stdout 会与 os.Stderr 合并输出；

os.Stdin 对应标准输入，一般表示键盘。

os.Stdout、os.Stderr、os.Stdin 都是 *os.File 类型，和文件一样实现了 io.Writer 接口的 Write() 方法。

如何将命令行抽象为日志写入器，代码如下：

代码 1-3 文件写入器（logger/console.go）

package main
 
import (
    "fmt"
    "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{}
}

4、使用日志

在程序中使用日志器一般会先通过代码创建日志器（Logger），为日志器添加输出设备（fileWriter、consoleWriter 等）。这些设备中有一部分需要一些参数设定，如文件日志写入器需要提供文件名（fileWriter 的 SetFile() 方法）。

代码 1-4 文件写入器（logger/main.go）

package main
 
import "fmt"
 
//创建日志器
func createLogger() *Logger {
 
    //创建日志器
    l := newLogger()
 
    //创建命令行写入器
    cw := newConsoleWriter()
 
    //注册命令行写入器到日志器中
    l.RegisterWriter(cw)
 
    //创建文件写入器
    fw := newFileWriter()
 
    //设置文件名
    if err := fw.SetFile("log.log"); err != nil {
        fmt.Println(err)
    }
 
    //注册文件写入器到日志器中
    l.RegisterWriter(fw)
 
    return l
}
 
func main() {
 
    //准备日志器
    l := createLogger()
 
    //写一个日志
    l.Log("hello")
}