Golang:手撸一个支持六种级别的日志库
Golang标准日志库提供的日志输出方法有Print、Fatal、Panic等,没有常见的Debug、Info、Error等日志级别,用起来不太顺手。这篇文章就来手撸一个自己的日志库,可以记录不同级别的日志。
其实对于追求简单来说,Golang标准日志库的三个输出方法也够用了,理解起来也很容易:
- Print用于记录一个普通的程序日志,开发者想记点什么都可以。
- Fatal用于记录一个导致程序崩溃的日志,并会退出程序。
- Panic用于记录一个异常日志,并触发panic。
不过对于用惯了Debug、Info、Error的人来说,还是有点不习惯;对于想更细致的区分日志级别的需求,标准日志库还提供了一个通用的Output方法,开发者在要输出的字符串中加入级别也是可以的,但总是有点别扭,不够直接。
目前市面上也已经有很多优秀的三方日志库,比如uber开源的zap,常见的还有zerolog、logrus等。不过我这里还是想自己手撸一个,因为大多数开源产品都不会完全贴合自己的需求,有很多自己用不上的功能,这会增加系统的复杂性,有没有隐藏的坑也很难说,当然自己入坑的可能性也很大;再者看了官方日志库的实现之后,感觉可以简单封装下即可实现自己想要的功能,能够hold住。
初始需求
我这里的初始需求是:
- 将日志写入磁盘文件,每个月一个文件夹,每个小时一个文件。
- 支持常见日志级别:Trace、Debug、Info、Warn、Error、Fatal,并且程序能够设置日志级别。
我给这个日志库取名为ylog,预期的使用方法如下:
ylog.SetLevel(LevelInfo)
ylog.Debug("I am a debug log.")
ylog.Info("I am a Info log.")
技术实现
类型定义
需要定义一个结构体,保存日志级别、要写入的文件等信息。
type FileLogger struct {
lastHour int64
file *os.File
Level LogLevel
mu sync.Mutex
iLogger *log.Logger
Path string
}
来看一下这几个参数:
lastHour 用来记录创建日志文件时的小时数,如果小时变了,就要创建新的日志文件。
file 当前使用的日志文件。
Level 当前使用的日志级别。
mu 因为可能在不同的go routine中写日志,需要一个互斥体保证日志文件不会重复创建。
iLogger 标准日志库实例,因为这里是封装了标准日志库。
Path 日志输出的最上层目录,比如程序根目录下的logs目录,这里就保存一个字符串:logs。
日志级别
先把日志级别定义出来,这里日志级别其实是int类型,从0到5,级别不断升高。
如果设置为ToInfo,则Info级别及比Info级别高的日志都能输出。
type LogLevel int
const (
LevelTrace LogLevel = iota
LevelDebug
LevelInfo
LevelWarn
LevelError
LevelFatal
)
上文提到可以在Output方法的参数中加入日志级别,这里就通过封装Output方法来实现不同级别的日志记录方法。这里贴出其中一个方法,封装的方式都一样,就不全都贴出来了:
func (l *FileLogger) CanInfo() bool {
return l.Level <= LevelInfo
}
func (l *FileLogger) Info(v ...any) {
if l.CanInfo() {
l.ensureFile()
v = append([]any{"Info "}, v...)
l.iLogger.Output(2, fmt.Sprintln(v...))
}
}
输出日志前做了三件事:
- 判断日志级别,如果设置的日志级别小于等于当前输出级别,则可以输出。
- 确保日志文件已经创建好,后边会讲如何确保。
- 将日志级别前插到日志字符串中。
然后调用标准库的Output函数输出日志,这里第一个参数是为了获取到当前正在写日志的程序文件名,传入的是在程序调用栈中进行查找的深度值,这里用2就正好。
写到文件
标准库的log是支持输出到多种目标的,只要实现了io.Write接口:
type Writer interface {
Write(p []byte) (n int, err error)
}
因为文件对象也实现了这个接口,所以这里可以创建os.File的实例,并把它设置到内嵌的标准日志库实例,也就是设置到前边创建的FileLogger中的iLogger中。这个操作在ensureFile方法中,看一下这个文件的实现:
func (l *FileLogger) ensureFile() (err error) {
currentTime := time.Now()
if l.file == nil {
l.mu.Lock()
defer l.mu.Unlock()
if l.file == nil {
l.file, err = createFile(&l.Path, ¤tTime)
l.iLogger.SetOutput(l.file)
l.iLogger.SetFlags(log.Lshortfile | log.Ldate | log.Ltime | log.Lmicroseconds)
l.lastHour = getTimeHour(¤tTime)
}
return
}
currentHour := getTimeHour(¤tTime)
if l.lastHour != currentHour {
l.mu.Lock()
defer l.mu.Unlock()
if l.lastHour != currentHour {
_ = l.file.Close()
l.file, err = createFile(&l.Path, ¤tTime)
l.iLogger.SetOutput(l.file)
l.iLogger.SetFlags(log.Llongfile | log.Ldate | log.Ltime)
l.lastHour = getTimeHour(¤tTime)
}
}
return
}
这里稍微有点复杂,基本逻辑是:如果文件实例不存在,则创建;如果需要创建新的文件,则先关闭旧的文件再创建新的文件。
更改文件实例时需要加锁,否则可能多次操作,出现预期之外的情况。
设置输出到文件后,标准log库的Output方法就会将日志输出到这个文件了。
默认实现
经过上边一系列操作,这个FileLogger就可以使用了:
var logger = NewFileLogger(LevelInfo, "logs")
logger.Info("This is a info.")
不过和最初设想的用法有点差别: ylog.Info("xxxx")
这需要在ylog包中再定义一个名为Info的公开函数,可以在这个公开函数中调用一个默认创建的FileLogger实例,代码是这样的:
var stdPath = "logs"
var std = NewFileLogger(LevelInfo, stdPath)
func Trace(v ...any) {
if std.CanTrace() {
std.ensureFile()
v = append([]any{"Trace"}, v...)
std.iLogger.Output(2, fmt.Sprintln(v...))
}
}
注意这里没有调用std的Trace方法,这是因为Output中的第一个参数,如果嵌套调用std.Trace,则多了一层,这个参数就得设置为3,但是自己创建实例调用Trace时这个参数需要为2,这就产生冲突了。
经过以上这些操作,就可以实现预期的日志操作了:
ylog.SetLevel(LevelInfo)
ylog.Debug("I am a debug log.")
ylog.Info("I am a Info log.")
完整的程序已经上传到Github,欢迎访问:https://github.com/bosima/ylog/tree/v1.0.1
下篇文章将继续改造这个日志库,支持输出Json格式的日志,以及输出日志到Kafka。
收获更多架构知识,请关注微信公众号 萤火架构。原创内容,转载请注明出处。
Golang:手撸一个支持六种级别的日志库的更多相关文章
- 使用Java Socket手撸一个http服务器
原文连接:使用Java Socket手撸一个http服务器 作为一个java后端,提供http服务可以说是基本技能之一了,但是你真的了解http协议么?你知道知道如何手撸一个http服务器么?tomc ...
- 【手撸一个ORM】MyOrm的使用说明
[手撸一个ORM]第一步.约定和实体描述 [手撸一个ORM]第二步.封装实体描述和实体属性描述 [手撸一个ORM]第三步.SQL语句构造器和SqlParameter封装 [手撸一个ORM]第四步.Ex ...
- 第二篇-用Flutter手撸一个抖音国内版,看看有多炫
前言 继上一篇使用Flutter开发的抖音国际版 后再次撸一个国内版抖音,大部分功能已完成,主要是Flutter开发APP速度很爽, 先看下图 项目主要结构介绍 这次主要的改动在api.dart 及 ...
- 通过 Netty、ZooKeeper 手撸一个 RPC 服务
说明 项目链接 微服务框架都包括什么? 如何实现 RPC 远程调用? 开源 RPC 框架 限定语言 跨语言 RPC 框架 本地 Docker 搭建 ZooKeeper 下载镜像 启动容器 查看容器日志 ...
- C#基于Mongo的官方驱动手撸一个Super简易版MongoDB-ORM框架
C#基于Mongo的官方驱动手撸一个简易版MongoDB-ORM框架 如题,在GitHub上找了一圈想找一个MongoDB的的ORM框架,未偿所愿,就去翻了翻官网(https://docs.mongo ...
- 手撸一个SpringBoot-Starter
1. 简介 通过了解SpringBoot的原理后,我们可以手撸一个spring-boot-starter来加深理解. 1.1 什么是starter spring官网解释 starters是一组方便的依 ...
- 手撸一个springsecurity,了解一下security原理
手撸一个springsecurity,了解一下security原理 转载自:www.javaman.cn 手撸一个springsecurity,了解一下security原理 今天手撸一个简易版本的sp ...
- 五分钟,手撸一个Spring容器!
大家好,我是老三,Spring是我们最常用的开源框架,经过多年发展,Spring已经发展成枝繁叶茂的大树,让我们难以窥其全貌. 这节,我们回归Spring的本质,五分钟手撸一个Spring容器,揭开S ...
- 以鶸ice为例,手撸一个解释器(一)明确目标
代码地址 # HelloWorld.ice print("hello, world") 前言(废话) 其实从开始学习编译原理到现在已经有快半年的时间了,但是其间常常不能坚持看下去龙 ...
随机推荐
- JVM的基础知识
一.JVM的基础知识 1.JVM内存结构: 1.JVM堆内存结构: 2.JVM内存分配: 3.Java的堆机构和垃圾回收: 4.Jvm堆内存配置参数: 5.JVM新生代概念和配置: 6.JVM老生代概 ...
- 使用 vscode 插件可视化制作和管理脚手架及原理解析
提到脚手架,大家想到的可能就是各种 xxx-cli,本文介绍的是另一种方式:以 vscode 插件的形式实现,提供 web 可视化操作,如下图: 下面介绍如何安装使用,以及实现原理. 安装使用 vsc ...
- Robinhood基于Apache Hudi的下一代数据湖实践
1. 摘要 Robinhood 的使命是使所有人的金融民主化. Robinhood 内部不同级别的持续数据分析和数据驱动决策是实现这一使命的基础. 我们有各种数据源--OLTP 数据库.事件流和各种第 ...
- Ubuntu 18.04 磁盘根目录在线扩容 & 修改分区 inode 数量
Ubuntu 18.04 磁盘根目录在线扩容 & 修改分区 inode 数量 Ubuntu 作为服务器系统使用的时候,系统盘的空间可能并不是很充裕,apt apt 着,根目录就满了.诚然, ...
- HTTP权威指南:第二章
URL概览 前面提到,URL资源是HTTP协议所使用的寻找资源位置的定位符.分为三个部分,主要的结构是: 方案://服务器/路径 这种结构使得网络上的每一个资源都只有唯一的命名方法,从而使得浏览器可以 ...
- 判断页面环境是否在小程序的webview中
最近公司需要做小程序项目,但是又希望能够快速开发,就想着把web端的响应式页面放到webview里快速开发.但在判断页面环境的时候出现一些问题. 环境问题 用小程序提供的wx.miniProgram. ...
- Issues with position fixed & scroll(移动端 fixed 和 scroll 问题)
转载请注明英文原文及译文出处 原文地址:Issues with position fixed & scrolling on iOS 原文作者:Remy Sharp译文地址:移动端 fixed ...
- 深入解析丨母婴App如何迅速收割2W新用户?
在讲案例前,我们需要先说一下精细化分析. 我们常说的精细化分析,就是一个持续"解构"的过程,通过像漏斗.留存.细分等高级分析功能,将"整体"按照事件属性解构成& ...
- 存储过程 psal emp.sal%type是什么意思
psal emp.sal%type 就是指psal这个变量是引用了表emp中的sal字段的类型.如果emp表中sal的类型变了,psal这个字段的类型也会跟着变化,总之,psal和表emp中sal字段 ...
- uni-app开发的h5 访问url自动添加 #的问题
在manifest.json配置文件修改h5的内容,添加router部分 "h5" : { "title" : "xxx", "d ...