Golang读取配置文件与环境变量结合-Golang-PHP中文网

Golang读取配置文件与环境变量结合

P粉602998670

发布： 2025-09-06 09:17:02

原创

648人浏览过

使用 viper 实现 Go 项目配置管理，支持配置文件与环境变量融合。1. 创建 config.yaml 定义默认配置；2. 使用 viper.SetConfigFile 指定配置文件；3. 调用 viper.AutomaticEnv() 启用环境变量覆盖；4. 通过 viper.ReadInConfig() 读取配置；5. 支持结构体绑定提升类型安全；6. 可设置 viper.SetEnvPrefix 统一环境变量前缀；7. 使用 viper.BindEnv 手动映射环境变量名。viper 自动将下划线分隔的环境变量转为层级键名，优先级高于配置文件，便于多环境部署。

golang读取配置文件与环境变量结合

在Go项目中，配置管理是必不可少的一环。通常我们会使用配置文件（如JSON、YAML、TOML）定义默认参数，同时允许通过环境变量覆盖，以适应不同环境（开发、测试、生产）的部署需求。Golang本身没有内置的配置管理库，但结合第三方库和标准库可以轻松实现配置文件与环境变量的融合读取。

使用 viper 读取配置文件并结合环境变量

viper 是 Go 中最流行的配置管理库之一，支持多种格式的配置文件，并能自动读取环境变量，优先级高于配置文件。

安装 viper：

go get github.com/spf13/viper

示例：使用 YAML 配置文件，并允许环境变量覆盖。

立即学习“go语言免费学习笔记（深入）”；

创建配置文件 config.yaml：

server:
  host: 127.0.0.1
  port: 8080
database:
  dsn: "user:pass@tcp(localhost:3306)/mydb"

Go 代码中读取配置：

package main

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

func main() {
  viper.SetConfigFile("config.yaml")
  viper.AutomaticEnv() // 允许环境变量覆盖

  err := viper.ReadInConfig()
  if err != nil {
    log.Fatalf("读取配置失败: %v", err)
  }

  host := viper.GetString("server.host")
  port := viper.GetInt("server.port")
  dsn := viper.GetString("database.dsn")

  fmt.Printf("Server: %s:%d\n", host, port)
  fmt.Printf("DSN: %s\n", dsn)
}

运行程序时，可通过环境变量覆盖配置：

export SERVER_PORT=9000
export DATABASE_DSN="root:123@tcp(db:3306)/prod_db"
go run main.go

viper 会自动将环境变量名转为层级结构（如 SERVER_PORT → server.port），前提是使用 AutomaticEnv() 并设置分隔符（默认为 '_'）。

Media.io AI Image Upscaler

Media.io推出的AI图片放大工具

查看详情

自定义结构体绑定配置

更推荐的方式是将配置绑定到结构体，提升类型安全和可维护性。

type Config struct {
  Server struct {
    Host string `mapstructure:"host"`
    Port int `mapstructure:"port"`
  } `mapstructure:"server"`
  Database struct {
    DSN string `mapstructure:"dsn"`
  } `mapstructure:"database"`
}

绑定结构体：

var cfg Config
if err := viper.Unmarshal(&cfg); err != nil {
log.Fatalf("解析配置失败: %v", err)
}

这样可以更清晰地管理配置项，也便于单元测试。