golang如何通过viper读取config.yaml文件

 更新时间:2022年03月16日 17:16:33   作者:峰啊疯了  
这篇文章主要介绍了golang通过viper读取config.yaml文件,围绕golang读取config.yaml文件的相关资料展开详细内容,需要的小伙伴可以参考一下

1.导入依赖包

import (
    "github.com/spf13/viper"
)

2.编写yaml文件

放在conf目录下,文件名叫config.yaml

# TODO  本地调试时放开
KubeSphere_URL: http://192.168.103.48:3188
# TODO 部署到环境时放开
#KubeSphere_URL: http://ks-apiserver.kubesphere-system.svc:80
KubesphereAdminUser: admin
KubespherePassword: Admin123

#TODO 调用梅姐服务的ip,暂用当前,后续需要修改
Other_service_IP: http://192.168.103.48:30412
#Other_service_IP: http://container-cloud-system-controller-manager-metrics-service.container-cloud-system-system.svc:8093
Other_service_URL: /capis/quota.ictnj.io/v1alpha1/namespaces/


#TODO harbor镜像仓库地址
HARBOR_URL: https://192.168.66.4:443
HARBOR_ADMIN_USERNAME: admin
HARBOR_ADMIN_PASSWD: Harbor12345

HARBOR_IP_HTTPS: 192.168.66.4:443

HARBOR_SSH_ADDRESS: 192.168.103.48:53304
HARBOR_SSH_USERNAME: root
HARBOR_SSH_PASSWD: peng123.

3.编写读取yaml文件的go文件

放在config目录下,文件名叫config.go

需要注意的是目录的问题,如果放在同目录,直接用configurationPath,不同的编辑器,

vscode跟golang对相对路径处理不同

package config

import (
    "github.com/spf13/viper"
)

const (
    configurationName = "config"
    configurationPath = "./conf"
    // vscode特殊读取路径
  //  configurationPath_vscode = "../conf" 
)

var Config *viper.Viper

func init() {
    Config = viper.New()
    Config.SetConfigName(configurationName)
    Config.AddConfigPath(configurationPath)
    Config.SetConfigType("yaml")
    Config.AddConfigPath(configurationPath)
    if err := config.ReadInConfig(); err != nil {
     panic(err)
   } 
}

如果config.yaml跟config.go放在同目录简单的路径用上面这个,如果路径不同,且不同的同事用不同的编译软件,可以尝试下面的路径兼容

package config

import (
    "github.com/spf13/viper"
)

const (
    configurationName = "config"
    configurationPath = "./conf"
    // vscode特殊读取路径
    configurationPath_vscode = "../conf" 
)

var Config *viper.Viper

func init() {
    Config = viper.New()
    Config.SetConfigName(configurationName)
    Config.AddConfigPath(configurationPath)
    Config.SetConfigType("yaml")
    if err := Config.ReadInConfig(); err != nil {
        Config.AddConfigPath(configurationPath_vscode)
        if err := Config.ReadInConfig(); err != nil {
            Config.AddConfigPath(configurationPath)
            panic(err)
        }
    }
}

4.使用config对象

Config.GetString("KubeSphere_URL")

5.viper源码分析

type Viper struct {
    // Delimiter that separates a list of keys
    // used to access a nested value in one go
    keyDelim string

    // A set of paths to look for the config file in
    configPaths []string

    // The filesystem to read config from.
    fs afero.Fs

    // A set of remote providers to search for the configuration
    remoteProviders []*defaultRemoteProvider

    // Name of file to look for inside the path
    configName        string
    configFile        string
    configType        string
    configPermissions os.FileMode
    envPrefix         string

    automaticEnvApplied bool
    envKeyReplacer      StringReplacer
    allowEmptyEnv       bool

    config         map[string]interface{}
    override       map[string]interface{}
    defaults       map[string]interface{}
    kvstore        map[string]interface{}
    pflags         map[string]FlagValue
    env            map[string]string
    aliases        map[string]string
    typeByDefValue bool

    // Store read properties on the object so that we can write back in order with comments.
    // This will only be used if the configuration read is a properties file.
    properties *properties.Properties

    onConfigChange func(fsnotify.Event)
}
func (v *Viper) ReadInConfig() error {
    jww.INFO.Println("Attempting to read in config file")
    filename, err := v.getConfigFile()
    if err != nil {
        return err
    }

    if !stringInSlice(v.getConfigType(), SupportedExts) {
        return UnsupportedConfigError(v.getConfigType())
    }

    jww.DEBUG.Println("Reading file: ", filename)
    file, err := afero.ReadFile(v.fs, filename)
    if err != nil {
        return err
    }

    config := make(map[string]interface{})

    err = v.unmarshalReader(bytes.NewReader(file), config)
    if err != nil {
        return err
    }

    v.config = config
    return nil
}

把yaml文件的键值读取到viper对象的config当中

到此这篇关于golang如何通过viper读取config.yaml文件的文章就介绍到这了,更多相关golang读取config.yaml内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go语言编程中判断文件是否存在是创建目录的方法

    Go语言编程中判断文件是否存在是创建目录的方法

    这篇文章主要介绍了Go语言编程中判断文件是否存在是创建目录的方法,示例都是使用os包下的函数,需要的朋友可以参考下
    2015-10-10
  • Go语言入门学习之Channel通道详解

    Go语言入门学习之Channel通道详解

    go routine可以使用channel来进行通信,使用通信的手段来共享内存,下面这篇文章主要给大家介绍了关于Go语言入门学习之Channel通道的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2022-07-07
  • Win10系统下Golang环境搭建全过程

    Win10系统下Golang环境搭建全过程

    在编程语言的选取上,越来越多的人选择了Golang,下面这篇文章主要给大家介绍了关于Win10系统下Golang环境搭建的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-01-01
  • Go中的go.mod使用详解

    Go中的go.mod使用详解

    这篇文章主要介绍了Go中的go.mod使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • 解决Golang并发工具Singleflight的问题

    解决Golang并发工具Singleflight的问题

    前段时间在一个项目里使用到了分布式锁进行共享资源的访问限制,后来了解到Golang里还能够使用singleflight对共享资源的访问做限制,于是利用空余时间了解,将知识沉淀下来,并做分享
    2022-05-05
  • go语言Timer计时器的用法示例详解

    go语言Timer计时器的用法示例详解

    Go语言的标准库里提供两种类型的计时器Timer和Ticker。这篇文章通过实例代码给大家介绍go语言Timer计时器的用法,代码简单易懂,感兴趣的朋友跟随小编一起看看吧
    2020-05-05
  • Go中的 panic / recover 简介与实践记录

    Go中的 panic / recover 简介与实践记录

    这篇文章主要介绍了Go中的 panic / recover 简介与实践,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-04-04
  • go sync Once实现原理示例解析

    go sync Once实现原理示例解析

    这篇文章主要为大家介绍了go sync Once实现原理示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-01-01
  • 使用systemd部署和守护golang应用程序的操作方法

    使用systemd部署和守护golang应用程序的操作方法

    systemd是一个流行的守护进程管理器,可以轻松管理服务的启动、停止、重启等操作,让我们的应用程序始终保持在线,本文介绍了如何使用systemd部署和守护golang应用程序,感兴趣的朋友一起看看吧
    2023-10-10
  • golang使用redis实现全文搜索功能详解

    golang使用redis实现全文搜索功能详解

    这篇文章主要为大家详细介绍了golang如何使用redis实现全文搜索功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-02-02

最新评论