如何让Golang中Viper的Unmarshal在环境变量未设置时返回错误？

问题描述 #

我在Golang中使用Viper加载环境变量配置，但希望当必填环境变量未设置时，viper.Unmarshal能返回错误。默认情况下，若环境变量缺失，viper.Unmarshal不会报错，仅会为结构体字段赋零值。

我的代码如下：

package main

import (
    "fmt"
    "log"

    "github.com/spf13/viper"
)

type Config struct {
    DatabaseURL string `mapstructure:"DATABASE_URL"`
}

func main() {
    viper.AutomaticEnv()

    var config Config
    if err := viper.Unmarshal(&config); err != nil {
        log.Fatalf("Error unmarshaling config: %v", err)
    }

    fmt.Println("Config:", config)
}

当DATABASE_URL未设置时，config.DatabaseURL仅为空字符串，不会触发错误。我尝试过使用viper.BindEnv("DATABASE_URL")，但Unmarshal在DATABASE_URL缺失时仍不报错。

我发现Viper的Unmarshal函数可通过DecoderConfigOption传入钩子，DecoderConfig结构体包含ErrorUnset字段：

// If ErrorUnset is true, then it is an error for there to exist  
// fields in the result that were not set in the decoding process  
// (extra fields). This only applies to decoding to a struct. This  
// will affect all nested structs as well.  
ErrorUnset bool 

但我不清楚如何通过DecoderConfigOption正确配置该选项以启用ErrorUnset，求教如何实现让viper.Unmarshal在必填环境变量未设置时返回错误？

解决方案 #

方法一：启用ErrorUnset全局校验 #

你可以通过viper.Unmarshal的第二个参数传入自定义的DecoderConfigOption，将ErrorUnset设为true，这样当结构体中存在未被环境变量赋值的字段时，Unmarshal会直接返回错误。

修改后的代码示例：

package main

import (
    "fmt"
    "log"

    "github.com/spf13/viper"
    "github.com/mitchellh/mapstructure"
)

type Config struct {
    DatabaseURL string `mapstructure:"DATABASE_URL"`
}

func main() {
    viper.AutomaticEnv()

    var config Config
    // 自定义Decoder配置，开启未赋值字段报错
    err := viper.Unmarshal(&config, func(cfg *mapstructure.DecoderConfig) {
        cfg.ErrorUnset = true
    })
    if err != nil {
        log.Fatalf("Error unmarshaling config: %v", err)
    }

    fmt.Println("Config:", config)
}

说明

• 需要引入github.com/mitchellh/mapstructure包，Viper底层依赖该包完成结构体解析，DecoderConfig就来自这个包。
• 匿名函数作为DecoderConfigOption，直接修改配置项ErrorUnset为true。
• 当DATABASE_URL未设置时，config.DatabaseURL属于未被解码流程赋值的字段，此时Unmarshal会返回类似error decoding '': field not found的错误，触发终止逻辑。

方法二：手动校验特定必填字段 #

如果你的结构体包含可选字段，仅需校验部分必填项，ErrorUnset的全局校验会对所有未赋值字段报错，这种情况可以在Unmarshal后手动校验必填字段：

package main

import (
    "fmt"
    "log"

    "github.com/spf13/viper"
)

type Config struct {
    DatabaseURL string `mapstructure:"DATABASE_URL"`
    Port        int    `mapstructure:"PORT"` // 可选字段，默认值0
}

func main() {
    viper.AutomaticEnv()

    var config Config
    if err := viper.Unmarshal(&config); err != nil {
        log.Fatalf("Error unmarshaling config: %v", err)
    }

    // 手动校验必填字段
    if config.DatabaseURL == "" {
        log.Fatal("DATABASE_URL is required but not set")
    }

    fmt.Println("Config:", config)
}

内容的提问来源于stack exchange，提问作者Yossich