Go viper读取配置文件的示例详解

 更新时间:2023年08月29日 10:01:04   作者:copyLeft  
这篇文章主要为大家详细介绍了Go语言如何利用viper实现读取配置文件,文中的示例代码讲解详细,具有一定的借鉴价值,需要的可以参考一下

参考

viper github

API

Viper-Go一站式配置管理工具

安装

    go get github.com/spf13/viper

简单例子

/*
  目录
    - main.go
    - config.yaml
*/
func main(){
	viper.SetConfigName("config") // 设置配置名称
	viper.SetConfigFile("config.yaml") // 设置配置文件路径
    // 读取配置
	if err := viper.ReadInConfig(); err != nil{
		log.Fatal(err)
	}
    // 获取配置数据
	summary := viper.GetString("Summary")
	fmt.Println(summary)
}

新建 Viper

viper 提供默认 Viper对象, 可直接使用。 也通过 New 方法创建自定义Viper

// 直接使用默认对象
viper.GetInt("count")
// 获取全局Viper对象
globalViper := viper.GetViper()
// 新建Viper
conf := viper.New()
conf.SetConfigFile("config.yaml")

读取配置文件

从配置读取

 viper.SetConfigName("config")
 viper.SetConfigFile("config.yaml")
 if err := viper.ReadInConfig(); err != nil{
     log.Fatal(err)
 }
 version := viper.GetString("version")

从 io.Reader 读取

func main(){
    file, err := os.Open("./config.yaml")
    if err != nil{
        log.Fatal(err)
    }
    defer file.Close()
    viper.SetConfig("yaml")
    version := viper.GetString("version")
    // 这里需要设置配置类型, 否则无法正确解释配置内容
    // 如果未配置类型,也可以通过 Get 方法获取数据自行解析。
}

从 flag 读取

import (
	"fmt"
	"github.com/spf13/pflag"
	"github.com/spf13/viper"
)
func main() {
	pflag.String("ip", "127.0.0.1", "Server running address")
	pflag.Int64("port", 8080, "Server running port")
	pflag.Parse()
	viper.BindPFlags(pflag.CommandLine)
	fmt.Printf("ip :%s , port:%s", viper.GetString("ip"), viper.GetString("port"))
}

获取值

值得获取方法名为 Get[type] 形式

接口类型,既未作解析

Get

布尔

GetBool

时间

  • GetDuration
  • GetTime

数字

  • GetInt
  • GetInt32
  • GetInt64
  • GetFloat64
  • GetIntSlice
  • ....

字符

  • GetString
  • GetStringSlice
  • ....

设置默认值

setDefault

 viper.setConfigFile("config.yaml")
 viper.SetDefault("port", 8000)
 println(viper.GetInt("port") // 8000
 // 这里未读取配置文件,将返回默认值

将配置映射到结构体

Unmarshal 将配置属性映射到 struct 中, 匹配模式类似 JSON 解析,只匹配大写开头的属性

type User struct{
    ID string
    Name string
    nickName string // 小写属性将不做匹配
}
func main(){
    /* config.yaml
        id: id11
        name: Rogan
        nickName: "wolf"  
    */
    ...
    user := &User{}
    viper.Unmarshal(user)
    println(&user) // { id11, Rogan } 
}

UnmarshalExact 用法与 Unmarshal 相同, 不同的是struct 必须与配置属性完全匹配,否则加报错

 /*
  config.yaml
    id: 111
    name: Rogan
 */
 type Conf_1 struct{
     Id string
     Name string
 }
 // 将报错
 type Conf_2 struct{
     Id string
 }

UnmarshalKey 匹配某一字段

 /*
  config.yaml
    server: 
        port: 8000
        host: localhost
 */
type ServerConf struct{
    Port int
    host string
}
func main(){
    ...
    serverConf := &ServerConf{}
    viper.UnmarshalKey("server", serverConfig)
}

混合配置 Merge[type]

MergeConfig

func main(){
    viper.SetConfigName("config")
	viper.SetConfigFile("config.yaml")
	viper.ReadInConfig()
	log.Println(viper.GetString("Summary"), viper.InConfig("Summary"))
	buff := []byte(`Name: jeck`)
	viper.MergeConfig(bytes.NewReader(buff))
	log.Println(viper.GetString("Name"))
}

监听文件

WatchConfig

func main(){
	viper.SetConfigName("config")
	viper.SetConfigFile("config.yaml")
	viper.ReadInConfig()
	viper.WatchConfig()
	for {
		log.Println(viper.GetString("version"))
		time.Sleep(time.Second * 5)
	}
}
// 初始 versioni: 1
// --> 1
// 修改config.yaml version: 2
// --> 2

OnConfigChange 响应配置变化

以上就是Go viper读取配置文件的示例详解的详细内容,更多关于go viper的资料请关注脚本之家其它相关文章!

相关文章

  • GO语言基本类型String和Slice,Map操作详解

    GO语言基本类型String和Slice,Map操作详解

    这篇文章主要为大家介绍了GO语言基本类型String和Slice,Map操作示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • GO workPool的线程池实现

    GO workPool的线程池实现

    本文主要介绍了GO workPool的线程池实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-03-03
  • B站新一代 golang规则引擎gengine基础语法

    B站新一代 golang规则引擎gengine基础语法

    这篇文章主要为大家介绍了B站新一代 golang规则引擎gengine基础语法,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-12-12
  • 详解Go语言中如何高效遍历目录

    详解Go语言中如何高效遍历目录

    目录遍历是一个很常见的操作,它的使用场景有如文件目录查看、文件系统清理、日志分析、项目构建等,本文将详细介绍在Go中几种遍历目录文件的方法,需要的可以参考下
    2024-02-02
  • go语言中if语句用法实例

    go语言中if语句用法实例

    这篇文章主要介绍了go语言中if语句用法,以实例形式分析了if语句的定义及使用技巧,非常具有实用价值,需要的朋友可以参考下
    2015-02-02
  • 浅谈golang fasthttp踩坑经验

    浅谈golang fasthttp踩坑经验

    本文主要介绍了golang fasthttp踩坑经验,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • 提升Go语言开发效率的小技巧实例(GO语言语法糖)汇总

    提升Go语言开发效率的小技巧实例(GO语言语法糖)汇总

    这篇文章主要介绍了提升Go语言开发效率的小技巧汇总,也就是Go语言的语法糖,掌握好这些可以提高我们的开发效率,需要的朋友可以参考下
    2022-11-11
  • 详解Go语言如何利用高阶函数写出优雅的代码

    详解Go语言如何利用高阶函数写出优雅的代码

    高阶函数(Hiher-order Function)定义为:满足下列条件之一的函数:接收一个或多个函数作为参数;返回值是一个函数。本文为大家介绍了如何利用高阶函数写出优雅的代码,希望对大家有所帮助
    2023-01-01
  • Golang中的int类型和uint类型到底有多大?

    Golang中的int类型和uint类型到底有多大?

    int和uint类型在我们日常开发中经常会用到,但有个疑问就是这两个类型有多大,通过各种尝试最终得到了答案,所以下面这篇文章主要给大家介绍了关于Golang中的int类型和uint类型到底有多大的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下。
    2017-12-12
  • Go语言使用ioutil.ReadAll函数需要注意基本说明

    Go语言使用ioutil.ReadAll函数需要注意基本说明

    这篇文章主要为大家介绍了Go语言使用ioutil.ReadAll函数需要注意基本说明,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-07-07

最新评论