MyException - 我的异常网
当前位置:我的异常网» Go » 怎么为 Go 设计一个通用的日志包

怎么为 Go 设计一个通用的日志包

www.MyException.Cn  网友分享于:2013-09-19  浏览:0次
如何为 Go 设计一个通用的日志包

需求

一个通用的日志包,应该满足以下几个需求:

兼容 log.Logger,标准库大量使用了 log.Logger 作为其错误内容的输出通道,比如 net/http.Server.ErrorLog,所以兼容 log.Logger 是首要的需求;

自定义配置,不同的运行环境,往往需要不同的日志输出配置,在不重新编译源码的情况下,就能改变配置也应该成为一项标配;

不同的输出类型,根据目前市面上大部分的日志库,我们把日志分为以下六种类型:INFOWARNDEBUGTRACEERROR 和 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

文章评论

亲爱的项目经理,我恨你
亲爱的项目经理,我恨你
Google伦敦新总部 犹如星级庄园
Google伦敦新总部 犹如星级庄园
看13位CEO、创始人和高管如何提高工作效率
看13位CEO、创始人和高管如何提高工作效率
鲜为人知的编程真相
鲜为人知的编程真相
Web开发人员为什么越来越懒了?
Web开发人员为什么越来越懒了?
旅行,写作,编程
旅行,写作,编程
总结2014中国互联网十大段子
总结2014中国互联网十大段子
程序员的一天:一寸光阴一寸金
程序员的一天:一寸光阴一寸金
老美怎么看待阿里赴美上市
老美怎么看待阿里赴美上市
漫画:程序员的工作
漫画:程序员的工作
中美印日四国程序员比较
中美印日四国程序员比较
一个程序员的时间管理
一个程序员的时间管理
我的丈夫是个程序员
我的丈夫是个程序员
如何成为一名黑客
如何成为一名黑客
我是如何打败拖延症的
我是如何打败拖延症的
10个调试和排错的小建议
10个调试和排错的小建议
如何区分一个程序员是“老手“还是“新手“?
如何区分一个程序员是“老手“还是“新手“?
不懂技术不要对懂技术的人说这很容易实现
不懂技术不要对懂技术的人说这很容易实现
每天工作4小时的程序员
每天工作4小时的程序员
科技史上最臭名昭著的13大罪犯
科技史上最臭名昭著的13大罪犯
程序员的鄙视链
程序员的鄙视链
程序猿的崛起——Growth Hacker
程序猿的崛起——Growth Hacker
要嫁就嫁程序猿—钱多话少死的早
要嫁就嫁程序猿—钱多话少死的早
5款最佳正则表达式编辑调试器
5款最佳正则表达式编辑调试器
我跳槽是因为他们的显示器更大
我跳槽是因为他们的显示器更大
十大编程算法助程序员走上高手之路
十大编程算法助程序员走上高手之路
程序员眼里IE浏览器是什么样的
程序员眼里IE浏览器是什么样的
“肮脏的”IT工作排行榜
“肮脏的”IT工作排行榜
聊聊HTTPS和SSL/TLS协议
聊聊HTTPS和SSL/TLS协议
当下全球最炙手可热的八位少年创业者
当下全球最炙手可热的八位少年创业者
那些性感的让人尖叫的程序员
那些性感的让人尖叫的程序员
写给自己也写给你 自己到底该何去何从
写给自己也写给你 自己到底该何去何从
程序员应该关注的一些事儿
程序员应该关注的一些事儿
团队中“技术大拿”并非越多越好
团队中“技术大拿”并非越多越好
Java程序员必看电影
Java程序员必看电影
程序员都该阅读的书
程序员都该阅读的书
老程序员的下场
老程序员的下场
为啥Android手机总会越用越慢?
为啥Android手机总会越用越慢?
 程序员的样子
程序员的样子
Web开发者需具备的8个好习惯
Web开发者需具备的8个好习惯
60个开发者不容错过的免费资源库
60个开发者不容错过的免费资源库
做程序猿的老婆应该注意的一些事情
做程序猿的老婆应该注意的一些事情
初级 vs 高级开发者 哪个性价比更高?
初级 vs 高级开发者 哪个性价比更高?
那些争议最大的编程观点
那些争议最大的编程观点
2013年中国软件开发者薪资调查报告
2013年中国软件开发者薪资调查报告
2013年美国开发者薪资调查报告
2013年美国开发者薪资调查报告
程序员必看的十大电影
程序员必看的十大电影
编程语言是女人
编程语言是女人
什么才是优秀的用户界面设计
什么才是优秀的用户界面设计
软件开发程序错误异常ExceptionCopyright © 2009-2015 MyException 版权所有