日志可以用于查看和分析应用程序的运行状态。日志一般可以支持输出多种形式，如命令行、文件、网络等。本例将搭建一个支持多种写入器的日志系统，可以自由扩展多种日志写入设备。

日志对外接口

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

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

package main

// 声明日志写入器接口
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{}
}

文件写入器

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

package main

import (
    "errors"
    "fmt"
    "os"
)

// 声明文件写入器
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{}
}

命令行写入器

在 UNIX 的思想中，一切皆文件。文件包括内存、磁盘、网络和命令行等。这种抽象方法方便我们访问这些看不见摸不着的虚拟资源。命令行在Go语言中也是一种文件，os.Stdout 对应标准输出，一般表示屏幕，也就是命令行，也可以被重定向为打印机或者磁盘文件；os.Stderr 对应标准错误输出，一般将错误输出到日志中，不过大多数情况，os.Stdout 会与 os.Stderr 合并输出；os.Stdin 对应标准输入，一般表示键盘。os.Stdout、os.Stderr、os.Stdin 都是 *os.File 类型，和文件一样实现了 io.Writer 接口的 Write() 方法。

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{}
}

使用日志

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

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")
}

编译整个代码并运行，输出如下：hello

同时，当前目录的 log.log 文件中也会出现 hello 字符。

提示


Go语言的 log 包实现了一个小型的日志系统。这个日志系统可以在创建日志器时选择输出设备、日志前缀及 flag，函数定义如下：

func New(out io.Writer, prefix string, flag int) *Logger {
    return &Logger{out: out, prefix: prefix, flag: flag}
}

在 flag 中，还可以定制日志中是否输出日期、日期精度和详细文件名等。

这个日志器在编写时，也最大程度地保证了输出的效率，如果读者对日志器的编写比较感兴趣，可以在 log 包的基础上进行扩展，形成方便自己使用的日志库。