如何为 Go 设计一个通用的日志包
2017-08-23 00:28
246 查看
需求
一个通用的日志包,应该满足以下几个需求:兼容
log.Logger,标准库大量使用了
log.Logger作为其错误内容的输出通道,比如 net/http.Server.ErrorLog,所以兼容
log.Logger是首要的需求;
自定义配置,不同的运行环境,往往需要不同的日志输出配置,在不重新编译源码的情况下,就能改变配置也应该成为一项标配;
不同的输出类型,根据目前市面上大部分的日志库,我们把日志分为以下六种类型:
INFO、
WARN、
DEBUG、
TRACE、
ERROR和
CRITICAL;
对日志内容的自定义处理,比如将日志按时间段进行切割,或是重要内容发邮箱进行提醒等。
配置文件
根据以上的需求,我们可以拟定一个以下格式的 XML 配置文件:<?xml version="1.0" encoding="utf-8"?> <logs> <info prefix="INFO" flag="log.lstdflag" > <!-- 向控制台输出信息 --> <console output="stderr" foreground="red" background="blue" /> </info> <error prefix="ERROR" flag="log.lstdflag" /> <!-- 向控制台输出信息 --> <console output="stderr" foreground="red" background="blue" /> <!-- 输出到 /var/logs/debug 目录下,如果大于 5M,则新建文件 --> <rotate dir="/var/logs/debug/" size="5M" /> </error> <critical prefix="CRITICAL" flag="log.lstdflag" > <!-- 向指定的邮箱发送错误信息 --> <smtp username="u" password="p" host="smtp.example.com" subject="CRITICAL" sendTo="u1@example.com;u2@example.com" /> </critical> </logs>
顶级元素固定为
logs;
二级元素为
INFO和
WARN等六种固定的类型,在加载时,将其初始为一个
*log.Logger实例,初始化参数可以直接从 XML 的属性和子元素中获取;
二级以下的元素,统一初始化为
io.Writer实例,当作
log.New()的参数,用于初始化其父元素。用户可通过接口自定义这些元素,若有初始化参数,则从其 XML 属性值中获取。
这样就达到了一个自由度相对比较高的配置文件。
接口设计
根据以上要求,我们大致上可以确定下来接口的内容。一个从配置文件进行初始化的接口:
func InitFromConfig(path string) error
以及各个输出类型的操作函数,最主要的就是获取
*log.Logger的接口,以及一些常用的简化调用。以 INFO 类型为例,我们可以定义以下几个函数,其它类型也都相同,只是函数名不同。
func INFO() *log.Logger // 返回与 INFO 类型对应的 *log.Logger 实例 // 针对 INFO 类型日志的一些常用操作进行封装 func Info(v ...interface{}) // 相当于 INFO().Println() func Infof(format string, v...interface{}) // 相当于 INFO().Printf()
我们还需要公开一个注册接口,用于注册用户自定义的元素:
type Init func(args map[string]string)(io.Writer, error) func Register(name string, fn Init)
使用
只要在 main() 中正确定加载了配置文件,之后随处都可以调用:// main.go func main() { err := logs.InitFromConfig("./config/logs.xml") if err !=nil { panic(err) } // do something } // file1.go func h1(w http.ResponseWriter, r *http.Request) { if !auth() { logs.Infof("鉴权失败") w.WriteHeader(http.StatusUnauthorized) return } } // file2.go func getServer(port string, h http.Handler) *http.Server { return &http.Server { Addr: port, Handler: h, ErrorLog: logs.INFO(), } }
实现
完整的实现代码在:https://github.com/issue9/logs。原文地址:https://caixw.io/posts/2017/how-to-design-log-package-with-go.html
相关文章推荐
- 如何给多个子系统设计一个简单通用的权限管理方案?(详细讲解及源代码下载)
- [SharePoint 工作流] 如何设计一个通用的多级多审核工作流程(一):工作流定义
- [SharePoint 工作流] 如何设计一个通用的多级多审核工作流程(二):关联设置与启动设置
- 从”如何设计一个通用数据类型的数组“谈什么才是程序员真正应该干的事
- [SharePoint 工作流] 如何设计一个通用的多级多审核工作流程(四):任务表单、流转的简要图示
- 一个通用的单元测试框架的思考和设计06-实现篇-自动管理测试数据-如何临时关闭数据外键约束
- 一个通用的单元测试框架的思考和设计06-实现篇-自动管理测试数据-如何临时关闭数据外键约束
- J2EE项目中如何设计一个比较通用的Excel模板功能
- 一个通用的单元测试框架的思考和设计07-实现篇-自动管理测试数据-如何为自增长主键id赋值
- [SharePoint 工作流] 如何设计一个通用的多级多审核工作流程(一):工作流定义
- 一个通用的单元测试框架的思考和设计07-实现篇-自动管理测试数据-如何为自增长主键id赋值
- [SharePoint 工作流] 如何设计一个通用的多级多审核工作流程(三):工作流开发
- [SharePoint 工作流] 如何设计一个通用的多级多审核工作流程(三):工作流开发
- [SharePoint 工作流] 如何设计一个通用的多级多审核工作流程(二):关联设置与启动设置
- 产品框架初步设计后,如何为每个部件定义一个清晰的职责范畴?
- 如何设计一个大型的AJAX应用程序
- 如何一步一步用DDD设计一个电商网站(二)—— 项目架构
- 如何设计一个软件的架构,使它可以提供二次开发的功能?
- Flume(NG)架构设计要点及配置实践 Flume NG是一个分布式、可靠、可用的系统,它能够将不同数据源的海量日志数据进行高效收集
- 一个通用的单元测试框架的思考和设计03-实现篇-核心类源码