日志同样作为一个服务，创建三个服务，contract/log.go、provider/log下的provider.go和service.go。

• 什么样的日志需要输出
• 日志输出哪些内容
• 日志输出到哪里

日志级别

• panic，表示会导致整个程序出现崩溃的日志信息
• fatal，表示会导致当前这个请求出现提前终止的错误信息
• error，表示出现错误，但是不一定影响后续请求逻辑的错误信息
• warn，表示出现错误，但是一定不影响后续请求逻辑的报警信息
• info，表示正常的日志信息输出
• debug，表示在调试状态下打印出来的日志信息
• trace，表示最详细的信息，一般信息量比较大，可能包含调用堆栈等信息

我们在contract目录中定义log.go表示接口：

import "context"const LogKey = "hade:log"type LogLevel uint32const (UnknownLevel LogLevel = iotaPanicLevelFatalLevelErrorLevelWarnLevelInfoLevelDebugLevelTraceLevel
)type Log interface {Panic(ctx context.Context, msg string, fields map[string]interface{})Fatal(ctx context.Context, msg string, fields map[string]interface{})Error(ctx context.Context, msg string, fields map[string]interface{})Warn(ctx context.Context, msg string, fields map[string]interface{})Info(ctx context.Context, msg string, fields map[string]interface{})Debug(ctx context.Context, msg string, fields map[string]interface{})Trace(ctx context.Context, msg string, fields map[string]interface{})SetLevel(ctx context.Context, msg string, fields map[string]interface{})
}

日志格式

格式包括输出哪些内容、如何输出？
输出内容有：

• 级别，当前日志的级别信息
• 时间，当前日志的打印时间
• 简要信息，简单描述信息，一句话说明日志错误
• 上下文字段，当前日志的附带信息，这些字段代表日志打印的上下文（比如traceID）

[Info]  2021-09-22T00:04:21+08:00       "demo test error"       map[api:demo/demo cspan_id: parent_id: span_id:c55051d94815vbl56i2g trace_id:c55051d94815vbl56i20 user:jianfengye]

比如该条日志对应的调用函数为：

logger.Info(c, "demo test error", map[string]interface{}{"api": "demo/demo","user": "jianfengye",
})

日志上下文是一个map值，来源可以为打印时自主传入的参数，也可以为context，因为开发中某些通用信息如trace_id放在context中，打印时希望取出来放入到日志的上下文中，取得方法如下：

type CtxFielder func(ctx context.Context) map[string]interface{}

然后定义输出格式：

// Formatter 定义了将日志信息组织成字符串的通用方法
type Formatter func(level LogLevel, t time.Time, msg string, fields map[string]interface{}) ([]byte, error)

同时接口中增加设置输出格式和设置取ctx参数的方法：

// Log 定义了日志服务协议
type Log interface {...// SetCtxFielder 从context中获取上下文字段fieldSetCtxFielder(handler CtxFielder)// SetFormatter 设置输出格式SetFormatter(formatter Formatter)...
}

日志输出

解决了级别和输出格式，那日志可以输出在哪些地方？
接口中定义输出位置，是一个io.Writer:

// Log 定义了日志服务协议
type Log interface {...// SetOutput 设置输出管道SetOutput(out io.Writer)
}

创建服务提供者

服务器提供者的register方法，返回具体的实例，这里我们根据情况把log服务实例分为四种：

• ConsoleLog：控制台输出
• SingleLog：本地单个文件输出
• RotateLog：本地单个文件输出且进行自动切割
• CustomLog: 自定义输出
  register方法中，根据Driver字段，判断采用哪个具体实例：

// Register 注册一个服务实例
func (l *HadeLogServiceProvider) Register(c framework.Container) framework.NewInstance {if l.Driver == "" {tcs, err := c.Make(contract.ConfigKey)if err != nil {// 默认使用consolereturn services.NewHadeConsoleLog}cs := tcs.(contract.Config)l.Driver = strings.ToLower(cs.GetString("log.Driver"))}// 根据driver的配置项确定switch l.Driver {case "single":return services.NewHadeSingleLogcase "rotate":return services.NewHadeRotateLogcase "console":return services.NewHadeConsoleLogcase "custom":return services.NewHadeCustomLogdefault:return services.NewHadeConsoleLog}
}

前面的日志配置项：日志级别、输出格式、context内容获取方法、输出方法，都在服务提供者中以参数提供：

type HadeLogServiceProvider struct {Driver     stringLevel      contract.LogLevelFormatter  contract.FormatterCtxFielder contract.CtxFielderOutput     io.Writer
}

提供两种输出格式，TextFormatter和JsonFormatter：

// TextFormatter 表示文本格式输出
func TextFormatter(level contract.LogLevel, t time.Time, msg string, fields map[string]interface{}) ([]byte, error) {bf := bytes.NewBuffer([]byte{})Separator := "\t"// 先输出日志级别prefix := Prefix(level)bf.WriteString(prefix)bf.WriteString(Separator)// 输出时间ts := t.Format(time.RFC3339)bf.WriteString(ts)bf.WriteString(Separator)// 输出msgbf.WriteString("\"")bf.WriteString(msg)bf.WriteString("\"")bf.WriteString(Separator)// 输出mapbf.WriteString(fmt.Sprint(fields))return bf.Bytes(), nil
}

日志服务的具体实现