使用Viper Go读取环境变量

时间:2018-04-13 14:39:08

标签: go viper-go

我试图让Viper读取我的环境变量,但它不起作用。这是我的配置:

# app.yaml
dsn: RESTFUL_APP_DSN
jwt_verification_key: RESTFUL_APP_JWT_VERIFICATION_KEY
jwt_signing_key: RESTFUL_APP_JWT_SIGNING_KEY
jwt_signing_method: "HS256"

我的config.go文件:

package config

import (
    "fmt"
    "strings"

    "github.com/go-ozzo/ozzo-validation"
    "github.com/spf13/viper"
)

// Config stores the application-wide configurations
var Config appConfig

type appConfig struct {
    // the path to the error message file. Defaults to "config/errors.yaml"
    ErrorFile string `mapstructure:"error_file"`
    // the server port. Defaults to 8080
    ServerPort int `mapstructure:"server_port"`
    // the data source name (DSN) for connecting to the database. required.
    DSN string `mapstructure:"dsn"`
    // the signing method for JWT. Defaults to "HS256"
    JWTSigningMethod string `mapstructure:"jwt_signing_method"`
    // JWT signing key. required.
    JWTSigningKey string `mapstructure:"jwt_signing_key"`
    // JWT verification key. required.
    JWTVerificationKey string `mapstructure:"jwt_verification_key"`
}

func (config appConfig) Validate() error {
    return validation.ValidateStruct(&config,
        validation.Field(&config.DSN, validation.Required),
        validation.Field(&config.JWTSigningKey, validation.Required),
        validation.Field(&config.JWTVerificationKey, validation.Required),
    )
}

func LoadConfig(configpaths ...string) error {
    v := viper.New()
    v.SetConfigName("app")
    v.SetConfigType("yaml")
    v.SetEnvPrefix("restful")
    v.AutomaticEnv()
    v.SetDefault("error_file", "config/errors.yaml")
    v.SetDefault("server_port", 1530)
    v.SetDefault("jwt_signing_method", "HS256")
    v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))

    for _, path := range configpaths {
        v.AddConfigPath(path)
    }

    if err := v.ReadInConfig(); err != nil {
        return fmt.Errorf("Failed to read the configuration file: %s", err)
    }

    if err := v.Unmarshal(&Config); err != nil {
        return err
    }

    // Checking with this line. This is what I get:
    // RESTFUL_JWT_SIGNING_KEY
    fmt.Println("Sign Key: ", v.GetString("jwt_signing_key"))

    return Config.Validate()
}

这一行fmt.Println("Sign Key: ", v.GetString("jwt_signing_key"))只给出了yaml文件RESTFUL_JWT_SIGNING_KEY中传递的密钥。我不知道自己做错了什么。

根据文件:

  

AutomaticEnv是一个强大的助手,特别是与...结合使用时   SetEnvPrefix。调用时,Viper将检查环境   任何时候viper.Get请求变量。它将适用于   遵守规则。它将检查具有名称的环境变量   匹配上层密钥并在EnvPrefix前缀(如果已设置)。

那么,为什么不读环境变量?

使用JSON

{
  "dsn": "RESTFUL_APP_DSN",
  "jwt_verification_key": "RESTFUL_APP_JWT_VERIFICATION_KEY",
  "jwt_signing_key": "RESTFUL_APP_JWT_SIGNING_KEY",
  "jwt_signing_method": "HS256"
}

我的解析器看起来像这样:

// LoadConfigEnv loads configuration from the given list of paths and populates it into the Config variable.
// Environment variables with the prefix "RESTFUL_" in their names are also read automatically.
func LoadConfigEnv(environment string, configpaths ...string) error {
  v := viper.New()
  v.SetConfigName(environment)
  v.SetConfigType("json")
  v.SetEnvPrefix("restful")
  v.AutomaticEnv()
  v.SetDefault("jwt_signing_method", "HS256")
  v.SetDefault("error_file", "config/errors.yaml")
  v.SetDefault("server_port", 1530)
  v.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))

  for _, path := range configpaths {
    v.AddConfigPath(path)
  }

  if err := v.ReadInConfig(); err != nil {
    return fmt.Errorf("Failed to read the configuration file: %s", err)
  }

  if err := v.Unmarshal(&Config); err != nil {
    return err
  }

  return Config.Validate()
}

Validate函数中,我决定检查Config结构,这就是我得到的结果:

Config: {config/errors.yaml 1530 RESTFUL_APP_DSN HS256 RESTFUL_APP_JWT_SIGNING_KEY RESTFUL_APP_JWT_VERIFICATION_KEY}

1 个答案:

答案 0 :(得分:7)

我的问题中的代码实际上没有显示我想要解决的问题。我相信,在了解了什么是错误之后,这里的代码将在我的开发环境中本地运行。

根据Viper文档:

  

AutomaticEnv是一个强大的帮手,特别是与SetEnvPrefix结合使用时。调用时,Viper将在每次viper.Get请求时检查环境变量。它将适用以下规则。它将检查一个环境变量,其名称与大写的键匹配,如果设置则以EnvPrefix为前缀。

这一行说明了一切:

它将检查一个环境变量,其名称与上面的键匹配,如果设置了

,则前缀为EnvPrefix

使用v.SetEnvPrefix("restful")设置的前缀可能需要.yaml,其键值为:

示例app.yaml:

dsn: RESTFUL_DSN

请注意,DSN是小写键,它被用作Suffix的{​​{1}}

在我的情况下,我这样做了:

示例app.yaml:

RESTFUL_DSN

因此,我在我的环境中检查dsn: RESTFUL_APP_DSN 而不是RESTFUL_DSN