Golang快速开发框架——增加日志组件zap（三）

Golang快速开发框架——增加日志组件zap（三）

背景

知识分享之Golang篇是我在日常使用Golang时学习到的各种各样的知识的记录，将其整理出来以文章的形式分享给大家，来进行共同学习。欢迎大家进行持续关注。

知识分享系列目前包含Java、Golang、Linux、Docker等等。

开发环境

• 系统：windows10
• 语言：Golang
• golang版本：1.17
• 代码仓库：FastDevelopGo

内容

日常我们使用golang开发项目时经常需要使用一些基础组件，每次新建较为繁琐，现有市面上的感觉不太适合自己，因此决定自己搭建一套，同时开源出来分享给大家使用，欢迎大家提出各种需求。
下面我们开始对于该框架进行继续完善，本节我们要完成的需求是：

• 增加日志组件
  这里对比了多个日志组件后，最终选择了zap，下面是整合代码：
  1、进行安装日志组件

go get -u go.uber.org/zap

2、编写一个日志初始化工具，用于日志的初始操作

package log

import (
    "encoding/json"
    "fmt"
    "github.com/spf13/viper"
    "go.uber.org/zap"
    "time"
)

var (
    Logger zap.Logger
)

// InitLog 日志组件初始化函数
func InitLog() error {
    return logLoad()
}

type JsonConfig struct {
    Level            string        ` json:"level,omitempty" mapstructure:"level"`
    Encoding         string        `json:"encoding,omitempty" mapstructure:"encoding"`
    OutputPaths      []string      `json:"outputPaths,omitempty" mapstructure:"outputPaths"`
    ErrorOutputPaths []string      `json:"errorOutputPaths,omitempty" mapstructure:"errorOutputPaths"`
    InitialFields    InitialFields `json:"initialFields" mapstructure:"initialFields"`
    EncoderConfig    EncoderConfig `json:"encoderConfig" mapstructure:"encoderConfig"`
}
type InitialFields struct {
    Foo string `json:"foo,omitempty" mapstructure:"foo"`
}
type EncoderConfig struct {
    MessageKey   string `json:"messageKey,omitempty" mapstructure:"messageKey"`
    LevelKey     string `json:"levelKey,omitempty" mapstructure:"levelKey"`
    LevelEncoder string `json:"levelEncoder,omitempty" mapstructure:"levelEncoder"`
}

// 日志加载逻辑
func logLoad() error {
    // zap组件的日志配置对象
    var cfg zap.Config
    // 自定义的日志配置对象
    var jsonConfig JsonConfig
    // 注意这里反序列化时使用的是指针，另外结构体中属性需要大写（公开）
    // 将读取出来的日志配置反序列到对象中，用于后续的日志初始化使用
    if err := viper.UnmarshalKey("log", &jsonConfig); err != nil {
        return err
    }
    // 将自定义的日志对象初始化为[]byte
    cf, err := json.Marshal(jsonConfig)
    if err != nil {
        return err
    }
    fmt.Printf("%s\n", string(cf))
    // 将[]byte后的日志配置反序列为zap组件的日志对象，注意这里是因为viper的反序列化时对象类型不匹配导致问题，因此才增加了这一步
    //TODO 后续对其进行优化，直接使用viper组件反序列化为zap组件的配置对象。
    if err = json.Unmarshal(cf, &cfg); err != nil {
        return err
    }
    // 日志对象建立，整个框架里面均使用该Logger对象作为统一日志输出对象
    Logger, err := cfg.Build()
    if err != nil {
        return err
    }
    defer Logger.Sync()

    Logger.Info("logger construction succeeded")

    // 打开协程观察配置文件变更
    go func() {
        for {
            time.Sleep(time.Second * 5) // 每次请求后延迟

            // 刷新配置
            err := viper.WatchRemoteConfig()
            if err != nil {
                Logger.Error("unable to read remote config: %v", zap.Error(err))
                continue
            }

            // 将配置重新反序列化到对象中
            viper.Unmarshal(&jsonConfig)
        }
    }()
    return nil
}

4、在基础配置文件中增加日志配置

# 这是一个默认的配置文件
[sys]
conf_type="toml"
conf_dir="conf/app"
conf_name="base"

[log]
level="debug"
encoding="json"
outputPaths=["stdout", "./tmp/logs"]
errorOutputPaths=["stderr"]
[log.initialFields]
foo = "bar"
[log.encoderConfig]
messageKey="message"
levelKey="level"
levelEncoder="lowercase"

5、这时启动发现日志正常打印了，后续我们再对日志进行详细设置

注：
这个框架我的初步想法时后续增加可视化页面、代码快速生成模块、项目框架快速生成模块等等，有其他需求想法的小伙伴欢迎在评论区留言或直接到代码仓库中提出宝贵的issue

欢迎大家积极start，大家的关注是我最大的动力。

• 代码仓库：FastDevelopGo

本文声明：

88x31.png

知识共享许可协议
本作品由 cn華少 采用 知识共享署名-非商业性使用 4.0 国际许可协议 进行许可。