良好的日志记录可以提供丰富的日志数据,便于在调试时发现问题,从而大大提高编码效率。 记录器提供的自动化信息越多越好,日志信息也需要以简洁的方式呈现,便于找到重要的数据。
日志需求:
- 无需修改业务代码即可切换到其他日志库
- 不需直接依赖任何日志库
- 整个应用程序只有一个日志库的全局实例,因此你可以在一个位置更改日志配置并将其应用于整个程序。
- 可以在不修改代码的情况下轻松更改日志记录选项,例如,日志级别
- 能够在程序运行时动态更改日志级别
资源句柄:为什么日志记录与数据库不同
当应用程序需要处理外部资源时,例如数据库,文件系统,网络连接, SMTP服务器时,它通常需要一个资源句柄(Resource Handler)。在依赖注入中,容器创建一个资源句柄并将其注入每个业务函数,因此它可以使用资源句柄来访问底层资源。在此应用程序中,资源句柄是一个接口,因此业务层不会直接依赖于资源句柄的任何具体实现。数据库和gRPC链接都以这种方式处理。
但是,日志记录器稍有不同,因为几乎每个函数都需要它,但数据库不是。在Java中,我们为每个Java类初始化一个记录器(Logger)实例。 Java日志记录框架使用层次关系来管理不同的记录器,因此它们从父日志记录器继承相同的日志配置。在Go中,不同的记录器之间没有层次关系,因此你要么创建一个记录器,要么具有许多彼此不相关的不同记录器。为了获得一致的日志记录配置,最好创建一个全局记录器并将其注入每个函数。但者将需要做很多工作,所以我决定在一个中心位置创建一个全局记录器,每个函数可以直接引用它。
为了不将应用程序紧密绑定到特定的记录器,我创建了一个通用的记录器接口,因此应用程序对于具体的记录器透明的。以下是记录器(Logger)接口。
// Log is a package level variable, every program should access logging function through "Log"
var Log Logger
// Logger represent common interface for logging function
type Logger interface {
Errorf(format string, args ...interface{})
Fatalf(format string, args ...interface{})
Fatal(args ...interface{})
Infof(format string, args ...interface{})
Info( args ...interface{})
Warnf(format string, args ...interface{})
Debugf(format strin