使用Viper读取环境变量

Question

我试图让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}

Answer 1

我问题中的代码并没有显示出我想要解决的问题。在理解了错误之后，我相信这里的代码会在我的开发环境.中本地运行。

根据Viper文档

AutomaticEnv是一个强大的助手，特别是当它与SetEnvPrefix相结合时。当调用时，Viper将在发出viper.Get请求时检查环境变量。它将适用以下规则。它将检查一个环境变量，如果设置的话，该变量的名称将与带有EnvPrefix前缀的键匹配。

这里的这句话说的都是：

它将检查一个环境变量，该变量的名称与EnvPrefix (如果设置为)中的键和前缀相匹配。

使用v.SetEnvPrefix("restful")设置的前缀将期望键值为：

示例app.yaml：

dsn: RESTFUL_DSN

请注意，DSN是低强制键，它用作Suffix of RESTFUL_DSN。

在我的情况下，我是这样做的：

示例app.yaml：

dsn: RESTFUL_APP_DSN

所以，它是在我的环境中检查RESTFUL_DSN，而不是RESTFUL_APP_DSN。