Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 2.52 KB

README.zh.md

File metadata and controls

92 lines (59 loc) · 2.52 KB

ZapLog - 灵活且高性能的 Go 日志工具

ZapLog 是一个轻量级、灵活的 Go 日志工具,基于快速且结构化的日志库 zap 构建。

README

English Documentation

安装

go get github.com/yyle88/zaplog

核心功能

1. 基础日志打印

您可以使用 zaplog.LOG 记录带有键值对的日志:

zaplog.LOG.Debug("调试信息", zap.String("key", "value"))
zaplog.LOG.Error("错误信息", zap.Error(errors.New("错误")))

2. 打印多个键值对

通过传递多个键值对,您可以在单条日志中打印多个字段:

zaplog.LOG.Debug("调试信息", zap.String("key1", "value1"), zap.Int("key2", 2))
zaplog.LOG.Error("错误信息", zap.Int("key1", 1), zap.Error(errors.New("错误")))

3. 使用 SugaredLogger

对于更简化的日志记录,您可以使用 zaplog.SUG,它支持变参形式的日志记录:

SUG.Debug("简化日志", "key1", "value1", "key2", 2)
SUG.Error("简化错误", errors.New("错误"))

4. 创建子日志(SubZap)

您可以创建带有默认字段的子日志,以提供额外的上下文信息,使日志更具可读性。使用 SubZapSubZap2SubZap3 创建子日志:

使用 SubZap 创建子日志:

zp := zaplog.LOGGER.SubZap(zap.String("module", "abc"), zap.String("key", "value"))
zp.LOG.Debug("子日志信息", zap.Int("a", 1))
zp.SUG.Error("简化子日志错误", 1, 2, 3)

使用 SubZap2 创建子日志:

zp := zaplog.LOGGER.SubZap2("module", "abc", zap.String("key", "value"))
zp.LOG.Debug("子日志信息2", zap.Int("a", 2))

使用 SubZap3 创建子日志:

zp := zaplog.LOGGER.SubZap3("模块名", zap.String("key", "value"))
zp.LOG.Debug("子日志信息3", zap.Int("a", 3))

5. 在 SugaredLogger 中处理多参数

SugaredLogger 中,您可以传递各种类型的参数,包括数组和切片:

zaplog.SUG.Debug("调试信息", 1, 2, 3)
zaplog.SUG.Debug([]int{0, 1, 2})

贡献

欢迎贡献!无论是修复 bug、改进文档,还是添加新特性,我们都非常感谢您的贡献。请遵循标准的 fork-and-pull 请求流程。

许可证

ZapLog 是开源软件,采用 MIT 许可证 进行发布。

感谢

如果您觉得这个包对您有帮助,请在 GitHub 上给它加个星标!感谢您的支持!!!

如果觉得本库对您有帮助,请在 GitHub 上给个 ⭐,感谢支持!!!