Golang中Viper配置加载最佳实践及Logrus实例使用疑问

Viper 两种使用方式的取舍 #

你提到的两种Viper用法各有优劣，需结合项目规模和需求选择：

1. 全局实例模式 #

• 优势：无需在各包间传递配置实例，代码简洁高效，适合中小型项目或快速迭代场景。
• 劣势：全局状态耦合性高，单元测试时难以Mock配置；直接用viper.Get会丢失类型安全，易引发运行时错误。

2. 实例传递模式 #

• 优势：依赖关系清晰，解耦性强，单元测试可轻松替换配置实例；配合结构体解析能保证类型安全。
• 劣势：需在函数、结构体间传递配置，多层调用链中会显繁琐。

折中方案：封装结构化配置包 #

推荐封装专属配置包，内部用Viper全局实例完成加载，对外暴露结构化配置对象，兼顾便利性与类型安全：

示例代码（internal/config/config.go）：

package config

import (
    "fmt"
    "github.com/spf13/viper"
)

// 对应yaml配置字段的结构化定义
type AppConfig struct {
    ClientConfig string `mapstructure:"clientConfig"`
    // 按需添加其他配置字段
}

var cfg AppConfig

// Load 初始化配置，在main函数中调用
func Load() {
    viper.SetConfigType("yaml")
    viper.SetConfigName("config.local")
    viper.AddConfigPath("config")
    viper.AddConfigPath("../config")
    
    if err := viper.ReadInConfig(); err != nil {
        panic(fmt.Errorf("fatal error config file: %w", err))
    }
    
    // 将配置解析到结构体，保证类型安全
    if err := viper.Unmarshal(&cfg); err != nil {
        panic(fmt.Errorf("unmarshal config failed: %w", err))
    }
}

// Get 获取全局配置对象
func Get() AppConfig {
    return cfg
}

main.go中初始化配置：

func main() {
    config.Load()
    fmt.Printf("in main package %s", config.Get().ClientConfig)
    // ... 其他业务逻辑
}

userClient.go中直接使用配置：

package client

import "yourproject/internal/config"

func RetrieveUser(id string) (domain.User, bool) {
    fmt.Printf("in http client package %s", config.Get().ClientConfig)
    // ... 业务逻辑
}

这种方式既避免了传递配置的繁琐，解决了viper.Get的类型安全问题，测试时还可通过修改cfg变量Mock配置。

Logrus 的使用模式 #

Logrus同样支持全局实例与自定义实例两种方式，逻辑和Viper一致：

1. 全局实例模式 #

适合中小型项目，只需在main中完成初始化，其他包直接调用：

func main() {
    logrus.SetFormatter(&logrus.JSONFormatter{})
    logrus.SetLevel(logrus.InfoLevel)
    // ... 其他逻辑
}

其他包直接使用logrus.Info("xxx")即可，无需传递实例。

2. 自定义实例传递模式 #

若项目需要多套日志配置（如不同模块输出不同格式）或高可测试性，建议创建自定义实例并传递：

// main.go 中创建日志实例
logger := logrus.New()
logger.SetFormatter(&logrus.JSONFormatter{})
routes.AddUserResource(r, logger)

// userClient.go 中接收并使用实例
func RetrieveUser(logger *logrus.Logger, id string) (domain.User, bool) {
    logger.Infof("Retrieving user with ID: %s", id)
    // ... 业务逻辑
}

总结 #

• 中小型项目：优先选择「Viper封装结构化配置包 + Logrus全局实例」，兼顾开发效率与代码质量。
• 大型/高可测试性项目：选择「Viper实例传递 + Logrus实例传递」，保证代码解耦，便于单元测试与维护。

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