Golang中如何让Viper从不同目录读取配置文件

一种常见的方法是使用编译时嵌入或运行时路径解析。以下是两种解决方案：

方案1：使用编译时嵌入（Go 1.16+）

使用 embed 包将配置文件嵌入到二进制文件中：

package main

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

//go:embed configurations/environment.yaml
var configFS embed.FS

func main() {
    // 从嵌入的文件系统读取配置
    data, err := configFS.ReadFile("configurations/environment.yaml")
    if err != nil {
        panic(fmt.Errorf("failed to read embedded config: %w", err))
    }
    
    viper.SetConfigType("yaml")
    if err := viper.ReadConfig(bytes.NewReader(data)); err != nil {
        panic(fmt.Errorf("failed to read config: %w", err))
    }
    
    // 使用配置
    fmt.Println("Config loaded:", viper.GetString("some.key"))
}

方案2：使用相对路径解析

在运行时确定配置文件的位置：

package main

import (
    "fmt"
    "os"
    "path/filepath"
    "github.com/spf13/viper"
)

func getConfigPath() (string, error) {
    // 方法1：从可执行文件位置计算
    exePath, err := os.Executable()
    if err != nil {
        return "", err
    }
    exeDir := filepath.Dir(exePath)
    
    // 假设配置文件在可执行文件的 ../server/configurations/ 目录
    configPath := filepath.Join(exeDir, "..", "server", "configurations", "environment.yaml")
    return filepath.Abs(configPath)
}

func main() {
    configPath, err := getConfigPath()
    if err != nil {
        panic(fmt.Errorf("failed to get config path: %w", err))
    }
    
    viper.SetConfigFile(configPath)
    if err := viper.ReadInConfig(); err != nil {
        panic(fmt.Errorf("failed to read config: %w", err))
    }
    
    // 使用配置
    fmt.Println("Config loaded from:", configPath)
}

方案3：支持多位置查找

结合环境变量和默认位置：

package main

import (
    "fmt"
    "os"
    "path/filepath"
    "github.com/spf13/viper"
)

func initConfig() {
    // 1. 首先尝试环境变量指定的路径
    if configPath := os.Getenv("APP_CONFIG_PATH"); configPath != "" {
        viper.SetConfigFile(configPath)
    } else {
        // 2. 尝试从当前工作目录查找
        viper.AddConfigPath("./server/configurations")
        viper.AddConfigPath("../server/configurations")
        
        // 3. 尝试从可执行文件目录查找
        if exePath, err := os.Executable(); err == nil {
            exeDir := filepath.Dir(exePath)
            viper.AddConfigPath(filepath.Join(exeDir, "server", "configurations"))
            viper.AddConfigPath(filepath.Join(exeDir, "..", "server", "configurations"))
        }
        
        viper.SetConfigName("environment")
        viper.SetConfigType("yaml")
    }
    
    if err := viper.ReadInConfig(); err != nil {
        panic(fmt.Errorf("failed to read config: %w", err))
    }
}

func main() {
    initConfig()
    fmt.Println("Config loaded successfully")
    fmt.Println("Database host:", viper.GetString("database.host"))
}

方案4：使用工作目录回溯

查找项目根目录：

package main

import (
    "fmt"
    "os"
    "path/filepath"
    "strings"
    "github.com/spf13/viper"
)

func findProjectRoot(startDir string) (string, error) {
    dir := startDir
    for {
        // 检查是否存在 go.mod 文件或其他项目标识文件
        goModPath := filepath.Join(dir, "go.mod")
        if _, err := os.Stat(goModPath); err == nil {
            return dir, nil
        }
        
        parent := filepath.Dir(dir)
        if parent == dir {
            break // 到达根目录
        }
        dir = parent
    }
    return "", fmt.Errorf("project root not found")
}

func main() {
    // 从当前工作目录开始
    wd, err := os.Getwd()
    if err != nil {
        panic(err)
    }
    
    projectRoot, err := findProjectRoot(wd)
    if err != nil {
        panic(err)
    }
    
    configPath := filepath.Join(projectRoot, "server", "configurations", "environment.yaml")
    viper.SetConfigFile(configPath)
    
    if err := viper.ReadInConfig(); err != nil {
        panic(fmt.Errorf("failed to read config: %w", err))
    }
    
    fmt.Println("Config loaded from project root:", configPath)
}

对于你的项目结构，推荐使用方案1（嵌入）或方案3（多位置查找）。嵌入方案确保配置文件始终可用，而多位置查找方案提供了部署灵活性。