知识分享之Golang——和我一起搭建一个快速开发框架（三）

知识分享之Golang——和我一起搭建一个快速开发框架(三)

背景

知识分享之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"
)

var (
    Logger zap.Logger
)

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

type Conf struct {
    JsonConfig JsonConfig `json:"log"`
    Sys        Sys        `json:"sys"`
}

type Sys struct {
    ConfType string `json:"conf_type,omitempty"`
    ConfDir  string `json:"conf_dir,omitempty"`
    ConfName string `json:"conf_name,omitempty"`
}

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

// 日志加载逻辑
func logLoad() error {
    var cfg zap.Config
    var jsonConfig Conf
    fmt.Println(viper.Get("log"))
    if err := viper.Unmarshal(&jsonConfig); err != nil {
        return err
    }
    cf, err := json.Marshal(jsonConfig)
    if err != nil {
        return err
    }
    fmt.Printf("%s\n", string(cf))
    if err = json.Unmarshal(cf, cfg); err != nil {
        return err
    }
    Logger, err := cfg.Build()
    if err != nil {
        return err
    }
    defer Logger.Sync()

    Logger.Info("logger construction succeeded")
    return nil
}

3、在启动入口处增加该逻辑的启用

package begin

import (
    "FastDevelopGo/src/base/config"
    "FastDevelopGo/src/base/log"
    "fmt"
)

// Start 主配置启动函数
func Start() error {
    // 初始配置文件
    if err := config.InitConfig(); err != nil {
        panic(fmt.Errorf("致命错误: %s \n", err))
    }
    //TODO 启动日志组件
    if err := log.InitLog(); err != nil {
        panic(fmt.Errorf("致命错误: %s \n", err))
    }

    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 国际许可协议 进行许可。