相信每个开发者都遇到过这样的困扰：开发环境、测试环境、生产环境的配置要如何管理？如何在不同环境之间优雅地切换？今天，我们就来聊聊如何使用 Viper 解决这个问题。
从配置结构说起
在实际项目中，我们通常会遇到不同环境下的配置需求。比如说：
- 开发环境连接本地数据库
- 测试环境连接测试服务器
- 生产环境连接线上服务器
要解决这个问题，首先得规划好配置文件的组织结构：
config/
├── config.yaml # 基础配置
├── config.dev.yaml # 开发环境配置
├── config.test.yaml # 测试环境配置
├── config.staging.yaml # 预发布环境配置
└── config.prod.yaml # 生产环境配置
配置结构定义
按照惯例，我们先定义配置的数据结构：
type Config struct {
App struct {
Name string `mapstructure:"name"`
Version string `mapstructure:"version"`
Mode string `mapstructure:"mode"`
} `mapstructure:"app"`
MySQL struct {
Host string `mapstructure:"host"`
Port int `mapstructure:"port"`
Username string `mapstructure:"username"`
Password string `mapstructure:"password"`
Database string `mapstructure:"database"`
} `mapstructure:"mysql"`
Redis struct {
Host string `mapstructure:"host"`
Port int `mapstructure:"port"`
Password string `mapstructure:"password"`
DB int `mapstructure:"db"`
} `mapstructure:"redis"`
}
优雅实现多环境配置
为了更好地管理配置，我们创建一个配置管理器：
type ConfigManager struct {
config *Config
viper *viper.Viper
}
func NewConfigManager() *ConfigManager {
return &ConfigManager{
config: &Config{},
viper: viper.New(),
}
}
核心的配置加载逻辑如下：
func (cm *ConfigManager) LoadConfig() (*Config, error) {
// 获取当前环境
env := os.Getenv("APP_ENV")
if env == "" {
env = "dev" // 默认为开发环境
}
// 加载基础配置
cm.viper.SetConfigName("config")
cm.viper.SetConfigType("yaml")
cm.viper.AddConfigPath("./config")
if err := cm.viper.ReadInConfig(); err != nil {
return nil, fmt.Errorf("读取基础配置失败: %v", err)
}
// 加载环境配置
cm.viper.SetConfigName(fmt.Sprintf("config.%s", env))
if err := cm.viper.MergeInConfig(); err != nil {
log.Printf("未找到环境配置文件: config.%s.yaml", env)
}
// 支持环境变量覆盖
cm.viper.SetEnvPrefix("APP")
cm.viper.AutomaticEnv()
// 解析到结构体
if err := cm.viper.Unmarshal(cm.config); err != nil {
return nil, fmt.Errorf("解析配置失败: %v", err)
}
return cm.config, nil
}
配置文件实例
让我们看看实际的配置文件是什么样的。
基础配置（config.yaml）：
app:
name: "awesome-app"
version: "1.0.0"
mode: "dev"
mysql:
port: 3306
database: "myapp"
redis:
port: 6379
db: 0
开发环境配置（config.dev.yaml）：
mysql:
host: "localhost"
username: "dev_user"
password: "dev_pass"
redis:
host: "localhost"
password: ""
生产环境配置（config.prod.yaml）：
app:
mode: "prod"
mysql:
host: "prod-mysql.example.com"
username: "prod_user"
password: "${MYSQL_PASSWORD}" # 从环境变量读取
redis:
host: "prod-redis.example.com"
password: "${REDIS_PASSWORD}"
如何使用
实际使用起来非常简单：
func main() {
os.Setenv("APP_ENV", "dev") // 设置环境
cm := config.NewConfigManager()
cfg, err := cm.LoadConfig()
if err != nil {
log.Fatalf("加载配置失败: %v", err)
}
// 使用配置
log.Printf("应用名称: %s", cfg.App.Name)
log.Printf("运行模式: %s", cfg.App.Mode)
}
实用技巧
1. 环境切换
可以通过多种方式切换环境：
# Linux/macOS
export APP_ENV=prod
# Windows
set APP_ENV=prod
# 或者通过命令行参数
./your-app -env prod
2. 敏感信息处理
生产环境的敏感信息应该通过环境变量注入，而不是写在配置文件中：
export APP_MYSQL_PASSWORD="your-secret-password"
export APP_REDIS_PASSWORD="another-secret"
3. 配置验证
别忘了对加载的配置进行验证：
func (cm *ConfigManager) validateConfig() error {
if cm.config.App.Name == "" {
return fmt.Errorf("应用名称不能为空")
}
if cm.config.MySQL.Host == "" {
return fmt.Errorf("MySQL主机地址不能为空")
}
return nil
}
小贴士
- 配置文件不要包含敏感信息
- 生产环境配置文件不要提交到代码仓库
- 使用环境变量来注入敏感信息
- 保持配置结构的清晰和统一
- 记得做好配置验证
- 合理使用日志记录配置加载过程
总结
通过以上方案，我们实现了一个灵活、安全且易于维护的多环境配置管理系统。它不仅可以优雅地处理不同环境的配置需求，还能确保敏感信息的安全性。
你的项目中是如何管理多环境配置的呢？欢迎在评论区分享你的经验！
如果这篇文章对你有帮助，别忘了点赞转发，让更多人看到～
