Viper在配置文件不存在时无法创建默认配置的问题

问题原因 #

你遇到的错误核心在于调用SafeWriteConfigAs时，Viper中没有可写入的配置内容——该方法需要Viper持有至少一项配置，才能生成有效的配置文件；否则即使目录已创建，也无法完成文件写入。

修复方案 #

只需在写入配置文件前，添加默认配置项即可，同时可以补充规范的Viper配置路径设置：

func main() {
    viper.SetConfigName("config")
    viper.SetConfigType("yaml")

    // 关键步骤：设置至少一个默认配置项
    viper.Set("server.port", 8080)
    viper.Set("storage.path", "./data")

    homeDir, err := os.UserHomeDir()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error getting home directory: %v\n", err)
        os.Exit(1)
    }

    configPath := filepath.Join(homeDir, ".appname")
    configFilePath := filepath.Join(configPath, "config.yaml")

    if err := os.MkdirAll(configPath, 0755); err != nil {
        fmt.Fprintf(os.Stderr, "Unable to create config directory: %v\n", err)
        os.Exit(1)
    }

    // 可选：添加配置路径，让Viper更规范地识别配置位置
    viper.AddConfigPath(configPath)

    if _, err := os.Stat(configFilePath); os.IsNotExist(err) {
        if err := viper.SafeWriteConfigAs(configFilePath); err != nil {
            fmt.Fprintf(os.Stderr, "Error writing config file: %v\n", err)
            os.Exit(1)
        }
    }
}

额外说明 #

• SafeWriteConfigAs的作用是仅当目标文件不存在时写入，如果文件已存在会直接返回错误，完全匹配你“创建默认配置”的需求；
• 若需要覆盖已存在的配置文件，可改用WriteConfigAs，但会丢失原有配置内容，需谨慎使用；
• 确保设置的默认配置符合YAML格式规范，避免生成无效的配置文件。

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