使用 godotenv 在 Golang 中加载 .env 文件

godotenv 是一个流行的 Golang 库，用于从 .env 文件加载环境变量到应用程序中。它模仿了 Ruby 的 dotenv 库的功能，非常适合在开发环境中管理配置。

安装 godotenv

首先，使用 go get 安装 godotenv：

go get github.com/joho/godotenv

基本用法

1. 最简单的加载方式

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/joho/godotenv"
)

func main() {
	// 加载 .env 文件
	err := godotenv.Load()
	if err != nil {
		log.Fatal("Error loading .env file")
	}

	// 获取环境变量
	dbUser := os.Getenv("DB_USER")
	dbPass := os.Getenv("DB_PASS")

	fmt.Printf("DB User: %s, DB Pass: %s\n", dbUser, dbPass)
}

2. 指定自定义 .env 文件路径

err := godotenv.Load("custom.env")
if err != nil {
	log.Fatal("Error loading custom.env file")
}

3. 加载多个 .env 文件

err := godotenv.Load(".env", ".env.local")
if err != nil {
	log.Fatal("Error loading .env files")
}

高级用法

1. 预加载环境变量（不覆盖已存在的变量）

godotenv.Overload()     // 会覆盖已存在的变量
godotenv.Load()         // 不会覆盖已存在的变量

2. 读取 .env 文件内容但不设置到环境变量

envMap, err := godotenv.Read()
if err != nil {
	log.Fatal("Error reading .env file")
}

fmt.Println(envMap["DB_HOST"]) // 直接访问解析后的map

3. 将字符串解析为环境变量映射

envString := `DB_HOST=localhost
DB_PORT=5432`

envMap, err := godotenv.Unmarshal(envString)
if err != nil {
	log.Fatal("Error parsing env string")
}

fmt.Println(envMap["DB_PORT"])

4. 将环境变量映射写入文件

envMap := map[string]string{
	"DB_HOST": "localhost",
	"DB_PORT": "5432",
}

err := godotenv.Write(envMap, "./.env.new")
if err != nil {
	log.Fatal("Error writing .env file")
}

实际应用示例

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/joho/godotenv"
)

type Config struct {
	DBHost     string
	DBPort     string
	DBUser     string
	DBPassword string
	DebugMode  bool
}

func LoadConfig() (*Config, error) {
	// 尝试加载.env文件，如果不存在也不报错
	_ = godotenv.Load(".env.local") // 本地覆盖配置
	_ = godotenv.Load()             // 默认.env文件

	config := &Config{
		DBHost:     getEnv("DB_HOST", "localhost"),
		DBPort:     getEnv("DB_PORT", "5432"),
		DBUser:     getEnv("DB_USER", ""),
		DBPassword: getEnv("DB_PASSWORD", ""),
		DebugMode:  getEnv("DEBUG", "false") == "true",
	}

	if config.DBUser == "" || config.DBPassword == "" {
		return nil, fmt.Errorf("database credentials not set")
	}

	return config, nil
}

func getEnv(key, defaultValue string) string {
	value := os.Getenv(key)
	if value == "" {
		return defaultValue
	}
	return value
}

func main() {
	config, err := LoadConfig()
	if err != nil {
		log.Fatalf("Failed to load config: %v", err)
	}

	fmt.Printf("Database Config:\nHost: %s\nPort: %s\nUser: %s\nDebug Mode: %v\n",
		config.DBHost, config.DBPort, config.DBUser, config.DebugMode)
}

最佳实践

1. 不要将 .env 文件提交到版本控制 - 确保将 .env 添加到 .gitignore
2. 提供示例文件 - 可以提交一个 .env.example 文件，包含所有需要的键但不包含敏感值
3. 分层配置 - 可以有一个基础 .env 文件和本地开发用的 .env.local 文件
4. 生产环境不使用 .env - 生产环境应该直接设置环境变量，而不是依赖 .env 文件

godotenv 是一个简单但功能强大的工具，可以大大简化开发环境中的配置管理。