下面是我的toml格式的配置文件。
[[hosts]]
name = "host1"
username = "user1"
password = "password1"
[[hosts]]
name = "host2"
username = "user2"
password = "password2"
...这是我加载它的代码:
import (
"fmt"
"github.com/spf13/viper"
"strings"
)
type Config struct {
Hosts []Host
}
type Host struct {
Name string `mapstructure:"name"`
Username string `mapstructure:"username"`
Password string `mapstructure:"password"`
}
func main() {
viper.AddConfigPath(".")
viper.AddConfigPath("./config")
viper.SetConfigName("app")
if err := viper.ReadInConfig(); err != nil {
return nil, fmt.Errorf("error reading config file, %v", err)
}
config := new(Config)
if err := viper.Unmarshal(config); err != nil {
return nil, fmt.Errorf("error parsing config file, %v", err)
}
var username, password string
for i, h := range config.Hosts {
if len(h.Name) == 0 {
return nil, fmt.Errorf("name not defined for host %d", i)
}
if username = os.Getenv(strings.ToUpper(h.Name) + "_" + "USERNAME"); len(username) > 0 {
config.Hosts[i].Username = username
} else if len(h.Username) == 0 {
return nil, fmt.Errorf("username not defined for %s", e.Name)
}
if password = os.Getenv(strings.ToUpper(e.Name) + "_" + "PASSWORD"); len(password) > 0 {
config.Hosts[i].Password = password
} else if len(h.Password) == 0 {
return nil, fmt.Errorf("password not defined for %s", e.Name)
}
fmt.Printf("Hostname: %s", h.name)
fmt.Printf("Username: %s", h.Username)
fmt.Printf("Password: %s", h.Password)
}
}
例如,我首先检查环境变量HOST1_USERNAME1
、HOST1_PASSWORD1
、HOST2_USERNAME2
和HOST2_PASSWORD2
是否存在。 .. 如果他们这样做,那么我将配置项设置为其值,否则我尝试从配置文件中获取值。
我知道 viper 提供方法 AutomaticEnv
来做类似的事情......但是它是否适用于像我这样的集合(AutomaticEnv
应该在之后 环境变量绑定(bind))?
根据我上面的代码,是否可以使用 viper 提供的机制并删除 os.GetEnv
?
谢谢。
更新
下面是我更新的代码。在我定义了环境变量 HOST1_USERNAME
和 HOST1_PASSWORD
并将我的配置文件中的相应设置设置为空字符串。
这是我的新配置文件:
[host1]
username = ""
password = ""
[host2]
username = "user2"
password = "password2"
这是我的代码:
package config
import (
"fmt"
"github.com/spf13/viper"
"strings"
"sync"
)
type Config struct {
Hosts []Host
}
type Host struct {
Name string
Username string
Password string
}
var config *Config
func (c *Config) Load() (*Config, error) {
if config == nil {
viper.AddConfigPath(".")
viper.AddConfigPath("./config")
viper.SetConfigName("myapp")
viper.AutomaticEnv()
viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
if err := viper.ReadInConfig(); err != nil {
return nil, fmt.Errorf("error reading config file, %v", err)
}
allSettings := viper.AllSettings()
hosts := make([]Host, 0, len(allSettings))
for key, value := range allSettings {
val := value.(map[string]interface{})
if val["username"] == nil {
return nil, fmt.Errorf("username not defined for host %s", key)
}
if val["password"] == nil {
return nil, fmt.Errorf("password not defined for host %s", key)
}
hosts = append(hosts, Host{
Name: key,
Unsername: val["username"].(string),
Password: val["password"].(string),
})
}
config = &Config{hosts}
}
return config, nil
}
我现在工作(感谢 Chrono Kitsune),我希望它能有所帮助, j3d
最佳答案
来自 viper.Viper
:
The priority of the sources is the following:
- overrides
- flags
- env. variables
- config file
- key/value store
- defaults
您可能会在确定环境变量的名称时遇到问题。您基本上需要一种方法将 hosts[0].Username
绑定(bind)到环境变量 HOST1_USERNAME
。但是,目前无法在 viper 中执行此操作。事实上,viper.Get("hosts[0].username")
返回 nil
,这意味着数组索引显然不能与 viper.BindEnv
。您还需要对尽可能多的主机使用此函数,这意味着如果您列出了 20 个主机,则需要调用 viper.BindEnv
40 或 60 次,具体取决于主机名可以被环境变量覆盖。要解决此限制,您需要动态地将主机作为独立表而不是表数组使用:
[host1]
username = "user1"
password = "password1"
[host2]
username = "user2"
password = "password2"
然后您可以使用 viper.SetEnvKeyReplacer
使用 strings.Replacer
来处理环境变量问题:
// host1.username => HOST1_USERNAME
// host2.password => HOST2_PASSWORD
// etc.
viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
请注意,在撰写本文时 some bugs exist when it comes to the resolution order .此问题影响 viper.Unmarshal
和 viper.Get
:环境变量应覆盖配置文件值,但目前仍使用配置文件值。奇怪的是,viper.AllSettings
工作正常。如果没有,您将无法执行以下操作以使用上述格式的主机:
// Manually collect hosts for storing in config.
func collectHosts() []Host {
hosts := make([]Host, 0, 10)
for key, value := range viper.AllSettings() {
// viper.GetStringMapString(key)
// won't work properly with environment vars, etc. until
// https://github.com/spf13/viper/issues/309
// is resolved.
v := value.(map[string]interface{})
hosts = append(hosts, Host{
Name: key,
Username: v["username"].(string),
Password: v["password"].(string),
})
}
return hosts
}
总结一下:
- 值应该取自第一个提供的:覆盖、标志、环境变量、配置文件、键/值存储、默认值。不幸的是,这并不总是遵循的顺序(因为存在错误)。
- 您需要更改配置格式并使用字符串替换器来利用
viper.AutomaticEnv
的便利性.
关于go - 如何将数组中的配置项绑定(bind)到环境变量,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/46008299/