首页 >> 知识 >> 各类配置文件格式简介(ini,yaml,conf,xml...)和nb的Viper

各类配置文件格式简介(ini,yaml,conf,xml...)和nb的Viper

目录 配置文件ini介绍语法demo库 json语法demo库 xml介绍语法&demo yamldemo tomlpropertiesHOCONplist(plist 是捆上了手脚的 xml) Viper(22k star)安装why viperSet默认值读取配置文件写入配置文件监控配置文件从io.Reader读取配置覆盖设置注册和使用别名使用环境变量使用Flagsflag接口 远程Key/Value存储支持远程Key/Value存储示例-未加密(etcd)远程Key/Value存储示例-加密(etcd)监控etcd中的更改-未加密从Viper获取值访问嵌套的键提取子树反序列化序列化成字符串单例viper使用多个viper实例使用Viper示例使用结构体变量保存配置信息 gopkg.in/yaml.v3与Viper对比

配置文件

适合人类编写:ini > toml > yaml > json > xml > plist 可以存储的数据复杂度:xml > yaml > toml ~ json ~ plist > ini

ini 介绍

ini文件是一个无固定标准格式的配置文件。它以简单的文字与简单的结构组成,常常使用在Windows操作系统。ini文件的命名来源,是取自英文“初始(Initial)”的首字缩写,正与它的用途——初始化程序相应。

语法 一个ini文件是由多个section(段)组成。每个段中都包含多个option(数据项),以key=vlaue形式存储数据;注释 以 # 或者 ; 开头。 demo # config.ini[user_info] name = zhangsanage = 18gender = 男is_admin = true[connect]host = 127.0.0.1user = dbpassword = 123456port = 1521db = zet 库 python使用内置包 configparser对ini文件进行操作,不需要安装依赖包。 json

JSON(JavaScript Object Notation)是一种轻量级的数据交换语言,以文字为基础,且易于让人阅读。尽管JSON是Javascript的一个子集,但JSON是独立于语言的文本格式,并且采用了类似于C语言家族的一些习惯。

JSON 数据格式与语言无关,脱胎于 JavaScript,但目前很多编程语言都支持 JSON 格式数据的生成和解析, 所以也常常用作配置文件。

语法 对象(object):一个对象以 { 开始,并以 } 结束。一个对象包含一系列非排序的名称/值对,每个名称/值对之间使用 , 分区名称/值(collection):名称和值之间使用 : 隔开,一般的形式是: {name:value}值的有序列表(Array):一个或者多个值用,分区后,使用 [,] 括起来就形成了这样的列表字符串:以””括起来的一串字符。数值:一系列0-9的数字组合,可以为负数或者小数。还可以用e或者E表示为指数形式。布尔值:表示为true或者false。 demo { "listener": [ { "tcp": { "address": "127.0.0.1:443" } } ], "cluster_cipher_suites": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", "storage": { "consul": { "foo": "bar", "disable_clustering": "true" } }, "telemetry": { "statsite_address": "baz" }, "max_lease_ttl": "10h", "default_lease_ttl": "10h", "cluster_name": "testcluster", "ui": true} 库 python jsongo encoding/json,jsoniter xml 介绍 可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。XML设计用来传送及携带数据信息,所以也经常用来做配置文件。 语法&demo yaml

YAML的语法和其他高级语言类似,并且可以简单表达清单、散列表,标量等数据形态。它使用空白符号缩进和大量依赖外观的特色, 比较适合用来表达层次结构式的数据结构。

demo alerting: alertmanagers: - scheme: https static_configs: - targets: - "1.2.3.4:9093" - "1.2.3.5:9093" - "1.2.3.6:9093"storage: tsdb: out_of_order_time_window: 30mtracing: endpoint: "localhost:4317" client_type: "grpc" headers: foo: "bar" timeout: 5s compression: "gzip" tls_config: cert_file: valid_cert_file key_file: valid_key_file insecure_skip_verify: true toml

TOML是一种旨在成为一个小规模、易于使用的语义化的配置文件格式,它被设计为可以无二义性的转换为一个哈希表。

TOML的语法广泛地由 key = “value” 、 [节名] 与 #注释 构成。

它支持以下数据类型:字符串、整形、浮点型、布尔型、日期时间、数组和图表。

# This is a TOML document.title = "TOML Example"[owner]name = "Tom Preston-Werner"dob = 1979-05-27T07:32:00-08:00 # First class dates[database]server = "192.168.1.1"ports = [ 8001, 8001, 8002 ]connection_max = 5000enabled = true[servers]# Indentation (tabs and/or spaces) is allowed but not required[servers.alpha]ip = "10.0.0.1"dc = "eqdc10"[servers.beta]ip = "10.0.0.2"dc = "eqdc10"[clients]data = [ ["gamma", "delta"], [1, 2] ]# Line breaks are OK when inside arrayshosts = [ "alpha", "omega"] properties

properties是一种主要在Java相关技术中用来存储应用程序的可配置参数的文件的文件扩展名。它们也可以存储用于国际化和本地化的字符串,这种文件被称为属性资源包(Property Resource Bundles)。

每个参数被存储为一对字符串:一个存储名称参数(被称为“键”),另一个存储值。

每个properties 文件中的行通常存储单个属性。对于每一行可能有这么几种格式,包括键=值,键 = 值,键:值,以及键 值。

# ===============================# = DATA SOURCE# ===============================# Set here configurations for the database connection# Connection url for the database "netgloo_blog"spring.datasource.url = jdbc:mysql://localhost:3306/netgloo_blog?useSSL=false# Username and passwordspring.datasource.username = rootspring.datasource.password = root# Keep the connection alive if idle for a long time (needed in production)spring.datasource.testWhileIdle = truespring.datasource.validationQuery = SELECT 1 HOCON

HOCON,全称Human-Optimized Config Object Notation(人性化配置对象表示法)是一种人类可读的数据格式,并是JSON和properties的一个超集。它由Lightbend(用Scala开发的人都知道)开发,主要与Play框架结合使用。它也在Puppet中作为配置格式使用。

play.http.secret.key = "changeme"play.modules { # Disable built-in i18n module disabled += play.api.i18n.I18nModule # Enable Hocon module enabled += com.marcospereira.play.i18n.HoconI18nModule}play.i18n { langs = [ "en" ]} plist(plist 是捆上了手脚的 xml)

苹果的属性列表(Property List)文件是一种用来存储序列化后的对象的文件。属性列表文件的文件扩展名为.plist,因此通常被称为plist文件。

Plist文件通常用于储存用户设置,也可以用于存储捆绑的信息,该功能在旧式的Mac OS中是由资源分支提供的。

Labelcom.plex.pmsKeepAliveProgramArguments/Applications/Plex Media Server.app/Contents/MacOS/Plex Media ServerRunAtLoadUserName__USERNAME__WorkingDirectory/ApplicationsServiceDescriptionPMS Viper(22k star)

Viper是适用于Go应用程序的完整配置解决方案。

安装

go get github.com/spf13/viper

why viper

它支持以下特性:

设置默认值从JSON、TOML、YAML、HCL、envfile和Java properties格式的配置文件读取配置信息实时监控和重新读取配置文件(可选)从环境变量中读取从远程配置系统(etcd或Consul)读取并监控配置变化从命令行参数读取配置从buffer读取配置显式配置值

Viper会按照下面的优先级。每个项目的优先级都高于它下面的项目:

显示调用Set设置值命令行参数(flag)环境变量配置文件key/value存储默认值 Set默认值 viper.SetDefault("ContentDir", "content")viper.SetDefault("LayoutDir", "layouts")viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "categories"}) 读取配置文件 Viper需要至少要知道在哪里查找配置文件的配置。Viper支持JSON、TOML、YAML、HCL、envfile和Java properties格式的配置文件。Viper可以搜索多个路径,但目前单个Viper实例只支持单个配置文件。Viper不默认任何配置搜索路径,将默认决策留给应用程序。 viper.SetConfigFile("./config.yaml") // 指定配置文件路径viper.SetConfigName("config") // 配置文件名称(无扩展名)viper.SetConfigType("yaml") // 如果配置文件的名称中没有扩展名,则需要配置此项viper.AddConfigPath("/etc/appname/") // 查找配置文件所在的路径viper.AddConfigPath("$HOME/.appname") // 多次调用以添加多个搜索路径viper.AddConfigPath(".") // 还可以在工作目录中查找配置err := viper.ReadInConfig() // 查找并读取配置文件if err != nil { // 处理读取配置文件的错误panic(fmt.Errorf("Fatal error config file: %s ", err))}

You can handle the specific case where no config file is found like this:

if err := viper.ReadInConfig(); err != nil {if _, ok := err.(viper.ConfigFileNotFoundError); ok {// Config file not found; ignore error if desired} else {// Config file was found but another error was produced}}// Config file found and successfully parsed 写入配置文件

从配置文件中读取配置文件是有用的,但是有时你想要存储在运行时所做的所有修改。为此,可以使用下面一组命令,每个命令都有自己的用途:

WriteConfig - 将当前的viper配置写入预定义的路径并覆盖(如果存在的话)。如果没有预定义的路径,则报错。SafeWriteConfig - 将当前的viper配置写入预定义的路径。如果没有预定义的路径,则报错。如果存在,将不会覆盖当前的配置文件。WriteConfigAs - 将当前的viper配置写入给定的文件路径。将覆盖给定的文件(如果它存在的话)。SafeWriteConfigAs - 将当前的viper配置写入给定的文件路径。不会覆盖给定的文件(如果它存在的话)。标记为safe的所有方法都不会覆盖任何文件,而是直接创建(如果不存在),而默认行为是创建或截断。 viper.WriteConfig() // 将当前配置写入“viper.AddConfigPath()”和“viper.SetConfigName”设置的预定义路径viper.SafeWriteConfig()viper.WriteConfigAs("/path/to/my/.config")viper.SafeWriteConfigAs("/path/to/my/.config") // 因为该配置文件写入过,所以会报错viper.SafeWriteConfigAs("/path/to/my/.other_config") 监控配置文件

Viper支持在运行时实时读取配置文件的功能。

需要重新启动服务器以使配置生效的日子已经一去不复返了,viper驱动的应用程序可以在运行时读取配置文件的更新,而不会错过任何消息。

只需告诉viper实例watchConfig。可选地,你可以为Viper提供一个回调函数,以便在每次发生更改时运行。

// 确保在调用WatchConfig()之前添加了所有的配置路径。viper.WatchConfig()viper.OnConfigChange(func(e fsnotify.Event) { // 配置文件发生变更之后会调用的回调函数fmt.Println("Config file changed:", e.Name)}) 从io.Reader读取配置 viper.SetConfigType("yaml") // 或者 viper.SetConfigType("YAML")// 任何需要将此配置添加到程序中的方法。var yamlExample = []byte(`Hacker: truename: stevehobbies:- skateboarding- snowboarding- goclothing: jacket: leather trousers: denimage: 35eyes : brownbeard: true`)viper.ReadConfig(bytes.NewBuffer(yamlExample))viper.Get("name") // 这里会得到 "steve" 覆盖设置 viper.Set("Verbose", true)viper.Set("LogFile", LogFile) 注册和使用别名 viper.RegisterAlias("loud", "Verbose")viper.Set("verbose", true) viper.Set("loud", true)viper.GetBool("loud") // trueviper.GetBool("verbose") // true 使用环境变量

Viper完全支持环境变量。

AutomaticEnv()BindEnv(string…) : errorSetEnvPrefix(string)SetEnvKeyReplacer(string…) *strings.ReplacerAllowEmptyEnv(bool)

使用ENV变量时,务必要意识到Viper将ENV变量视为区分大小写。

Viper提供了一种机制来确保ENV变量是惟一的。通过使用SetEnvPrefix,你可以告诉Viper在读取环境变量时使用前缀。BindEnv和AutomaticEnv都将使用这个前缀。

BindEnv使用一个或两个参数。第一个参数是键名称,第二个是环境变量的名称。环境变量的名称区分大小写。如果没有提供ENV变量名,那么Viper将自动假设ENV变量与以下格式匹配:前缀+ “_” +键名全部大写。当你显式提供ENV变量名(第二个参数)时,它 不会 自动添加前缀。例如,如果第二个参数是“id”,Viper将查找环境变量“ID”。

在使用ENV变量时,需要注意的一件重要事情是,每次访问该值时都将读取它。Viper在调用BindEnv时不固定该值。

AutomaticEnv是一个强大的助手,尤其是与SetEnvPrefix结合使用时。调用时,Viper会在发出viper.Get请求时随时检查环境变量。它将应用以下规则。它将检查环境变量的名称是否与键匹配(如果设置了EnvPrefix)。

SetEnvKeyReplacer允许你使用strings.Replacer对象在一定程度上重写 Env 键。如果你希望在Get()调用中使用-或者其他什么符号,但是环境变量里使用_分隔符,那么这个功能是非常有用的。可以在viper_test.go中找到它的使用示例。

或者,你可以使用带有NewWithOptions工厂函数的EnvKeyReplacer。与SetEnvKeyReplacer不同,它接受StringReplacer接口,允许你编写自定义字符串替换逻辑。

默认情况下,空环境变量被认为是未设置的,并将返回到下一个配置源。若要将空环境变量视为已设置,请使用AllowEmptyEnv方法。

SetEnvPrefix("spf") // 将自动转为大写BindEnv("id")os.Setenv("SPF_ID", "13") // 通常是在应用程序之外完成的id := Get("id") // 13 使用Flags

Viper 具有绑定到标志的能力。具体来说,Viper支持Cobra库中使用的Pflag。

与BindEnv类似,该值不是在调用绑定方法时设置的,而是在访问该方法时设置的。这意味着你可以根据需要尽早进行绑定,即使在init()函数中也是如此。

对于单个标志,BindPFlag()方法提供此功能。

serverCmd.Flags().Int("port", 1138, "Port to run Application server on")viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))

你还可以绑定一组现有的pflags (pflag.FlagSet):

pflag.Int("flagname", 1234, "help message for flagname")pflag.Parse()viper.BindPFlags(pflag.CommandLine)i := viper.GetInt("flagname") // 从viper而不是从pflag检索值

在 Viper 中使用 pflag 并不阻碍其他包中使用标准库中的 flag 包。pflag 包可以通过导入这些 flags 来处理flag包定义的flags。这是通过调用pflag包提供的便利函数AddGoFlagSet()来实现的。

package mainimport ("flag""github.com/spf13/pflag")func main() {// 使用标准库 "flag" 包flag.Int("flagname", 1234, "help message for flagname")pflag.CommandLine.AddGoFlagSet(flag.CommandLine)pflag.Parse()viper.BindPFlags(pflag.CommandLine)i := viper.GetInt("flagname") // 从 viper 检索值...} flag接口

如果你不使用Pflag,Viper 提供了两个Go接口来绑定其他 flag 系统。

FlagValue表示单个flag。这是一个关于如何实现这个接口的非常简单的例子:

type myFlag struct {}func (f myFlag) HasChanged() bool { return false }func (f myFlag) Name() string { return "my-flag-name" }func (f myFlag) ValueString() string { return "my-flag-value" }func (f myFlag) ValueType() string { return "string" }

一旦你的 flag 实现了这个接口,你可以很方便地告诉Viper绑定它:

viper.BindFlagValue("my-flag-name", myFlag{})

FlagValueSet代表一组 flags 。这是一个关于如何实现这个接口的非常简单的例子:

type myFlagSet struct {flags []myFlag}func (f myFlagSet) VisitAll(fn func(FlagValue)) {for _, flag := range flags {fn(flag)}}

一旦你的flag set实现了这个接口,你就可以很方便地告诉Viper绑定它:

fSet := myFlagSet{flags: []myFlag{myFlag{}, myFlag{}},}viper.BindFlagValues("my-flags", fSet) 远程Key/Value存储支持

在Viper中启用远程支持,需要在代码中匿名导入viper/remote这个包。

import _ “github.com/spf13/viper/remote”

Viper将读取从Key/Value存储(例如etcd或Consul)中的路径检索到的配置字符串(如JSON、TOML、YAML、HCL、envfile和Java properties格式)。这些值的优先级高于默认值,但是会被从磁盘、flag或环境变量检索到的配置值覆盖。(译注:也就是说Viper加载配置值的优先级为:磁盘上的配置文件>命令行标志位>环境变量>远程Key/Value存储>默认值。)

Viper使用crypt从K/V存储中检索配置,这意味着如果你有正确的gpg密匙,你可以将配置值加密存储并自动解密。加密是可选的。

你可以将远程配置与本地配置结合使用,也可以独立使用。

crypt有一个命令行助手,你可以使用它将配置放入K/V存储中。crypt默认使用在http://127.0.0.1:4001的etcd。

$ go get github.com/bketelsen/crypt/bin/crypt$ crypt set -plaintext /config/hugo.json /Users/hugo/settings/config.json

确认值已经设置:

$ crypt get -plaintext /config/hugo.json 远程Key/Value存储示例-未加密(etcd) viper.AddRemoteProvider("etcd", "http://127.0.0.1:4001","/config/hugo.json")viper.SetConfigType("json") // 因为在字节流中没有文件扩展名,所以这里需要设置下类型。支持的扩展名有 "json", "toml", "yaml", "yml", "properties", "props", "prop", "env", "dotenv"err := viper.ReadRemoteConfig() 远程Key/Value存储示例-加密(etcd) viper.AddSecureRemoteProvider("etcd","http://127.0.0.1:4001","/config/hugo.json","/etc/secrets/mykeyring.gpg")viper.SetConfigType("json") // 因为在字节流中没有文件扩展名,所以这里需要设置下类型。支持的扩展名有 "json", "toml", "yaml", "yml", "properties", "props", "prop", "env", "dotenv"err := viper.ReadRemoteConfig() 监控etcd中的更改-未加密 // 或者你可以创建一个新的viper实例var runtime_viper = viper.New()runtime_viper.AddRemoteProvider("etcd", "http://127.0.0.1:4001", "/config/hugo.yml")runtime_viper.SetConfigType("yaml") // 因为在字节流中没有文件扩展名,所以这里需要设置下类型。支持的扩展名有 "json", "toml", "yaml", "yml", "properties", "props", "prop", "env", "dotenv"http:// 第一次从远程读取配置err := runtime_viper.ReadRemoteConfig()// 反序列化runtime_viper.Unmarshal(&runtime_conf)// 开启一个单独的goroutine一直监控远端的变更go func(){for { time.Sleep(time.Second * 5) // 每次请求后延迟一下 // 目前只测试了etcd支持 err := runtime_viper.WatchRemoteConfig() if err != nil { log.Errorf("unable to read remote config: %v", err) continue } // 将新配置反序列化到草莓视频在线观看APP运行时的配置结构体中。你还可以借助channel实现一个通知系统更改的信号 runtime_viper.Unmarshal(&runtime_conf)}}() 从Viper获取值 Get(key string) : interface{}GetBool(key string) : boolGetFloat64(key string) : float64GetInt(key string) : intGetIntSlice(key string) : []intGetString(key string) : stringGetStringMap(key string) : map[string]interface{}GetStringMapString(key string) : map[string]stringGetStringSlice(key string) : []stringGetTime(key string) : time.TimeGetDuration(key string) : time.DurationIsSet(key string) : boolAllSettings() : map[string]interface{}

需要认识到的一件重要事情是,每一个Get方法在找不到值的时候都会返回零值。为了检查给定的键是否存在,提供了IsSet()方法。

viper.GetString("logfile") // 不区分大小写的设置和获取if viper.GetBool("verbose") { fmt.Println("verbose enabled")} 访问嵌套的键 { "host": { "address": "localhost", "port": 5799 }, "datastore": { "metric": { "host": "127.0.0.1", "port": 3099 }, "warehouse": { "host": "198.0.0.1", "port": 2112 } }}

Viper可以通过传入.分隔的路径来访问嵌套字段:

GetString("datastore.metric.host") // (返回 "127.0.0.1")

这遵守上面建立的优先规则;搜索路径将遍历其余配置注册表,直到找到为止。(译注:因为Viper支持从多种配置来源,例如磁盘上的配置文件>命令行标志位>环境变量>远程Key/Value存储>默认值,草莓视频在线观看APP在查找一个配置的时候如果在当前配置源中没找到,就会继续从后续的配置源查找,直到找到为止。)

例如,在给定此配置文件的情况下,datastore.metric.host和datastore.metric.port均已定义(并且可以被覆盖)。如果另外在默认值中定义了datastore.metric.protocol,Viper也会找到它。

然而,如果datastore.metric被直接赋值覆盖(被flag,环境变量,set()方法等等…),那么datastore.metric的所有子键都将变为未定义状态,它们被高优先级配置级别“遮蔽”(shadowed)了。

最后,如果存在与分隔的键路径匹配的键,则返回其值。例如:

{ "datastore.metric.host": "0.0.0.0", "host": { "address": "localhost", "port": 5799 }, "datastore": { "metric": { "host": "127.0.0.1", "port": 3099 }, "warehouse": { "host": "198.0.0.1", "port": 2112 } }}GetString("datastore.metric.host") // 返回 "0.0.0.0" 提取子树

从Viper中提取子树。

app: cache1: max-items: 100 item-size: 64 cache2: max-items: 200 item-size: 80

执行后:

subv := viper.Sub("app.cache1")

subv现在就代表:

max-items: 100item-size: 64 反序列化

你还可以选择将所有或特定的值解析到结构体、map等。

有两种方法可以做到这一点:

Unmarshal(rawVal interface{}) : errorUnmarshalKey(key string, rawVal interface{}) : error type config struct {Port intName stringPathMap string `mapstructure:"path_map"`}var C configerr := viper.Unmarshal(&C)if err != nil {t.Fatalf("unable to decode into struct, %v", err)}

如果你想要解析那些键本身就包含.(默认的键分隔符)的配置,你需要修改分隔符:

v := viper.NewWithOptions(viper.KeyDelimiter("::"))v.SetDefault("chart::values", map[string]interface{}{ "ingress": map[string]interface{}{ "annotations": map[string]interface{}{ "traefik.frontend.rule.type": "PathPrefix", "traefik.ingress.kubernetes.io/ssl-redirect": "true", }, },})type config struct {Chart struct{ Values map[string]interface{} }}var C configv.Unmarshal(&C)

Viper还支持解析到嵌入的结构体:

/*Example config:module: enabled: true token: 89h3f98hbwf987h3f98wenf89ehf*/type config struct {Module struct {Enabled boolmoduleConfig `mapstructure:",squash"`}}// moduleConfig could be in a module specific packagetype moduleConfig struct {Token string}var C configerr := viper.Unmarshal(&C)if err != nil {t.Fatalf("unable to decode into struct, %v", err)}

Viper在后台使用github.com/mitchellh/mapstructure来解析值,其默认情况下使用mapstructuretag。

注意 当需要将viper读取的配置反序列到草莓视频在线观看APP定义的结构体变量中时,一定要使用mapstructuretag!

序列化成字符串

你可能需要将viper中保存的所有设置序列化到一个字符串中,而不是将它们写入到一个文件中。你可以将自己喜欢的格式的序列化器与AllSettings()返回的配置一起使用。

import ( yaml "gopkg.in/yaml.v2" // ...)func yamlStringSettings() string { c := viper.AllSettings() bs, err := yaml.Marshal(c) if err != nil { log.Fatalf("unable to marshal config to YAML: %v", err) } return string(bs)} 单例viper

Viper是开箱即用的。你不需要配置或初始化即可开始使用Viper。由于大多数应用程序都希望使用单个中央存储库管理它们的配置信息,所以viper包提供了这个功能。它类似于单例模式。

在上面的所有示例中,它们都以其单例风格的方法演示了如何使用viper。

使用多个viper实例

还可以在应用程序中创建许多不同的viper实例。每个都有自己独特的一组配置和值。每个人都可以从不同的配置文件,key value存储区等读取数据。每个都可以从不同的配置文件、键值存储等中读取。viper包支持的所有功能都被镜像为viper实例的方法。

x := viper.New()y := viper.New()x.SetDefault("ContentDir", "content")y.SetDefault("ContentDir", "foobar")//... 使用Viper示例 package mainimport ("fmt""net/http""github.com/gin-gonic/gin""github.com/spf13/viper")func main() {viper.SetConfigFile("./conf/config.yaml") // 指定配置文件路径err := viper.ReadInConfig() // 读取配置信息if err != nil { // 读取配置信息失败panic(fmt.Errorf("Fatal error config file: %s ", err))}// 监控配置文件变化viper.WatchConfig()r := gin.Default()// 访问/version的返回值会随配置文件的变化而变化r.GET("/version", func(c *gin.Context) {c.String(http.StatusOK, viper.GetString("version"))})if err := r.Run(fmt.Sprintf(":%d", viper.GetInt("port"))); err != nil {panic(err)}} 使用结构体变量保存配置信息 package mainimport ("fmt""net/http""github.com/fsnotify/fsnotify""github.com/gin-gonic/gin""github.com/spf13/viper")type Config struct {Port int `mapstructure:"port"`Version string `mapstructure:"version"`}var Conf = new(Config)func main() {viper.SetConfigFile("./conf/config.yaml") // 指定配置文件路径err := viper.ReadInConfig() // 读取配置信息if err != nil { // 读取配置信息失败panic(fmt.Errorf("Fatal error config file: %s ", err))}// 将读取的配置信息保存至全局变量Confif err := viper.Unmarshal(Conf); err != nil {panic(fmt.Errorf("unmarshal conf failed, err:%s ", err))}// 监控配置文件变化viper.WatchConfig()// 注意!!!配置文件发生变化后要同步到全局变量Confviper.OnConfigChange(func(in fsnotify.Event) {fmt.Println("夭寿啦~配置文件被人修改啦...")if err := viper.Unmarshal(Conf); err != nil {panic(fmt.Errorf("unmarshal conf failed, err:%s ", err))}})r := gin.Default()// 访问/version的返回值会随配置文件的变化而变化r.GET("/version", func(c *gin.Context) {c.String(http.StatusOK, Conf.Version)})if err := r.Run(fmt.Sprintf(":%d", Conf.Port)); err != nil {panic(err)}} gopkg.in/yaml.v3

在 Go 语言中,你可以使用第三方库来解析 YAML 文件。最常用的库之一是 gopkg.in/yaml.v2 或 gopkg.in/yaml.v3。以下是如何使用 gopkg.in/yaml.v3 库来解析 YAML 的步骤:

安装 YAML 库:首先,你需要安装 yaml 包。使用以下命令安装:

go get gopkg.in/yaml.v3

定义数据结构:创建一个 Go 结构体,它的字段与 YAML 文件中的键相对应。

解析 YAML:使用 yaml.Unmarshal 函数将 YAML 数据解析到结构体中。

下面是一个简单的示例,展示了如何解析 YAML 数据:

package mainimport ( "fmt" "io/ioutil" "log" "gopkg.in/yaml.v3")// 定义与YAML结构匹配的结构体type Config struct { Server struct { Port int `yaml:"port"` } `yaml:"server"` Database struct { User string `yaml:"user"` Password string `yaml:"password"` } `yaml:"database"`}func main() { // 读取YAML文件 data, err := ioutil.ReadFile("config.yaml") if err != nil { log.Fatalf("error: %v", err) } // 解析YAML var config Config err = yaml.Unmarshal(data, &config) if err != nil { log.Fatalf("error: %v", err) } // 使用解析后的数据 fmt.Printf("Server Port: %d ", config.Server.Port) fmt.Printf("Database User: %s ", config.Database.User)}

在这个示例中,定义了一个 Config 结构体,它包含了 Server 和 Database 两个嵌套的结构体。这些结构体的字段与草莓视频在线观看APP想要解析的 YAML 文件中的键相对应。读取了一个名为 config.yaml 的文件,并使用 yaml.Unmarshal 函数将其内容解析到 Config 结构体实例中。

这里是一个可能对应上述代码的 config.yaml 文件的内容:

yamlserver: port: 8080database: user: admin password: secret

请确保你的 YAML 文件的结构与你的 Go 结构体定义相匹配,以便正确解析数据。如果 YAML 文件的结构比较复杂,你的 Go 结构体也需要相应地更复杂,以便能够正确映射所有的数据。

与Viper对比

Viper 是一个流行的 Go 配置管理库,它支持多种配置格式,包括 YAML、JSON、TOML 等。Viper 可以很容易地将配置文件反序列化到 Go 结构体中。

以下是使用 Viper 从 YAML 文件读取配置并反序列化到结构体的基本步骤:

安装 Viper:首先,你需要安装 Viper 库。使用以下命令安装:

go get github.com/spf13/viper

定义数据结构:创建一个 Go 结构体,它的字段与 YAML 文件中的键相对应。

读取和解析 YAML:使用 Viper 读取 YAML 文件,并将其反序列化到结构体中。

下面是一个简单的示例,展示了如何使用 Viper 来处理 YAML 配置:

package mainimport ( "fmt" "log" "github.com/spf13/viper")// Config 结构体与 YAML 文件中的键相对应type Config struct { Server struct { Port int `mapstructure:"port"` } `mapstructure:"server"` Database struct { User string `mapstructure:"user"` Password string `mapstructure:"password"` } `mapstructure:"database"`}func main() { // 设置文件名和配置类型 viper.SetConfigName("config") // 配置文件名 (无扩展名) viper.SetConfigType("yaml") // 或 viper.SetConfigType("YAML") viper.AddConfigPath(".") // 查找配置文件所在的路径 // 读取配置文件 if err := viper.ReadInConfig(); err != nil { log.Fatalf("Error reading config file, %s", err) } // 将配置反序列化到 Config 结构体 var config Config if err := viper.Unmarshal(&config); err != nil { log.Fatalf("Unable to decode into struct, %v", err) } // 使用配置 fmt.Printf("Server Port: %d ", config.Server.Port) fmt.Printf("Database User: %s ", config.Database.User)}

在这个示例中,定义了一个 Config 结构体,它包含了 Server 和 Database 两个嵌套的结构体。这些结构体的字段使用了 mapstructure 标签,这是因为 Viper 在内部使用了 Mapstructure 库来进行反序列化。

然后,草莓视频在线观看APP使用 Viper 设置了配置文件的名称、类型和查找路径,并调用 ReadInConfig 方法来读取配置文件。最后,草莓视频在线观看APP使用 Unmarshal 方法将读取到的配置反序列化到 Config 结构体中。

请确保你的 YAML 文件名为 config.yaml,并且放置在程序可以访问的路径中。如果你的配置文件名或路径不同,需要相应地调整 SetConfigName 和 AddConfigPath 方法的参数。

对比:

Viper 和 gopkg.in/yaml.v3 都是 Go 社区中非常知名的库,但它们的用途和知名度有所不同。

Viper 是一个广泛使用的配置管理库,它支持多种配置格式(包括 YAML、JSON、TOML 等),并提供了一系列功能来处理配置数据,如读取、写入、合并配置,以及环境变量绑定等。Viper 在 Go 社区中非常出名,特别是在需要处理复杂配置和多种配置源的应用程序中。它是许多知名项目的首选配置库,如 Hugo 和 Spinnaker。

gopkg.in/yaml.v3 是一个专注于 YAML 格式的解析和序列化库。它是 go-yaml 库的第三个版本,提供了对 YAML 格式的基本读写支持。如果你的项目只需要处理 YAML 数据,那么 gopkg.in/yaml.v3 是一个很好的选择。它在需要直接处理 YAML 数据的场景中非常流行。

总的来说,如果你需要一个专门处理 YAML 的库,gopkg.in/yaml.v3 是一个很好的选择。但如果你需要一个更全面的配置解决方案,支持多种格式和复杂的配置管理功能,Viper 则更受欢迎。在实际使用中,Viper 本身也使用了 go-yaml 来处理 YAML 格式的配置文件,所以你可以认为 Viper 在一定程度上依赖了 go-yaml 的功能。

在选择库时,你应该根据你的项目需求来决定。如果你需要一个功能丰富的配置管理系统,Viper 是一个很好的选择。如果你只需要解析和生成 YAML 数据,那么 gopkg.in/yaml.v3 就足够了。

网站地图