Golang快速开发框架——项目立项与系统配置读取组件viper（一）

Golang快速开发框架——项目立项与系统配置读取组件viper（一）

背景

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

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

开发环境

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

内容

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

1、整体目录划分

• conf ------------------ 配置文件
• deploy ------------------ 部署相关
• doc --------------------- 框架相关文档
• main ------------------- 初始入口
• router ------------------ 业务路由
• src ---------------------- 业务代码
  • base ------------------ 框架基础模块
    • config -------------------- 配置文件管理部分
    • constant ------------------ 常量包
    • begin ---------------------- 框架初始启动部分
    • util ---------------------- 基础工具类部分
• go.mod ---------------- 模块管理配置文件

2、开始整合自定义配置文件读取组件

2.1、分析对比

日常我们读取配置文件时常用的格式有：

• json 格式字符串
• xml 文件
• yml 格式文件
• toml 格式文件
• ini 格式文件
  常用的golang配置文件读取库目前市面上也有很多，其中我认为Viper更适合于这个框架的使用，因此本次框架中使用该组件库作为配置文件的管理组件。

2.2、安装Viper

go get github.com/spf13/viper

2.3、创建启动函数，并增加初始化功能，作为框架启动时的初始化模块。

package begin

import (
    "bufio"
    "flag"
    "fmt"
    "github.com/spf13/viper"
    "os"
    "strings"
)

// Start 主配置启动函数
func Start() error {
    sysConfigDir := flag.String("d", "./conf/", "配置一个启动配置文件存放目录，默认：./conf/")
    flag.Parse()
    sysConfigName := flag.String("n", "sys", "配置启动配置文件名称，默认：sys")
    flag.Parse()
    sysConfigType := flag.String("t", "toml", "配置启动配置文件类型，默认：toml")
    flag.Parse()
    // 加载启动配置
    configLoad(*sysConfigDir, *sysConfigName, *sysConfigType)
    return nil
}

func configLoad(sysConfigDir, sysConfigName, sysConfigType string) {
    // 设定读取名称
    viper.SetConfigName(sysConfigName)
    // 设定配置文件类型
    viper.SetConfigType(sysConfigType)
    // 设定扫描目录
    viper.AddConfigPath(sysConfigDir)
    // 读取配置文件
    if err := viper.ReadInConfig(); err != nil {
        if _, ok := err.(viper.ConfigFileNotFoundError); ok {
            reader := bufio.NewReader(os.Stdin)
            fmt.Println("没有找到配置文件，是否自动创建默认配置文件并启动?y/n")
            // Config file not found; ignore error if desired
            for ok {
                fmt.Print("-> ")
                isContinue, err := reader.ReadString('\n')
                if err != nil {
                    panic(fmt.Errorf("发生致命错误: %w \n", err))
                    break
                } else {
                    // 转换为小写并去除前后空格
                    isContinue = strings.TrimSpace(strings.ToLower(isContinue))
                    // 判断输入是否正确
                    if isContinue == "y" || isContinue == "yes" || isContinue == "0" {
                        // 正常进行
                        //TODO 调用自动化创建初始配置文件函数
                        break
                    } else if isContinue == "n" || isContinue == "no" || isContinue == "1" {
                        // 结束
                        break
                    }
                }
            }
        } else {
            // Config file was found but another error was produced
            panic(fmt.Errorf("配置文件致命错误: %w \n", err))
        }
    }
}

2.4、进行启动测试，读取和命令行输入确认有效完成。

func main() {
    begin.Start()
}

到这里我们就创建完成了这个框架的基础框架包结构和配置文件读取功能和启动时命令参数设定功能，下一节我们对于该部分的初始配置文件和缺失时如何创建进行代码补充，欢迎持续关注，同时在搭建过程中遇到的一些代码小知识我也会同步整理出来制作成小demo便于大家学习使用。

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

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

• 代码仓库：FastDevelopGo

本文声明：

88x31.png

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