Go with Viper 設定管理指南

介紹

有效管理配置是建立可擴充和可維護軟體的基石。在 Go 中，Viper 包？作為管理應用程式配置的強大解決方案而脫穎而出。透過支援多種文件格式、環境變數和無縫解組到結構，Viper 簡化了現代應用程式的配置管理。

在本部落格中，我們將介紹如何使用 Viper 載入和管理來自不同來源的配置，將它們對應到 Go 結構體，以及動態整合環境變數。

?‍?設定 Viper：

讓我們深入了解 Viper 在 Go 應用程式中的實際實作。在本指南中，我們將使用一個簡單的應用程式設定範例，其中包含 YAML 檔案和環境變數。

第 1 步：安裝 Viper 軟體套件

首先在您的專案中安裝 Viper：

go get github.com/spf13/viper

第 2 步：建立設定檔

在專案的根目錄中建立一個 config.yaml 檔案。該文件將定義您的應用程式的預設配置：

app:
  name: "MyApp"
  port: 8080
namespace: "myapp"
owner: "John Doe"

？在 Go 中實現 Viper

以下是如何在應用程式中使用 Viper。以下是 main.go 中的範例程式碼：

package main

import (
    "fmt"
    "log"
    "strings"

    "github.com/spf13/viper"
)

type AppConfig struct {
    App struct {
        Name string `mapstructure:"name"`
        Port int    `mapstructure:"port"`
    } `mapstructure:"app"`
    NS    string `mapstructure:"namespace"`
    Owner string `mapstructure:"owner"`
}

func main() {
    // Set up viper to read the config.yaml file
    viper.SetConfigName("config") // Config file name without extension
    viper.SetConfigType("yaml")   // Config file type
    viper.AddConfigPath(".")      // Look for the config file in the current directory


    /*
        AutomaticEnv will check for an environment variable any time a viper.Get request is made.
        It will apply the following rules.
            It will check for an environment variable with a name matching the key uppercased and prefixed with the EnvPrefix if set.
    */
    viper.AutomaticEnv()
    viper.SetEnvPrefix("env")                              // will be uppercased automatically
    viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_")) // this is useful e.g. want to use . in Get() calls, but environmental variables to use _ delimiters (e.g. app.port -> APP_PORT)

    // Read the config file
    err := viper.ReadInConfig()
    if err != nil {
        log.Fatalf("Error reading config file, %s", err)
    }

    // Set up environment variable mappings if necessary
    /*
        BindEnv takes one or more parameters. The first parameter is the key name, the rest are the name of the environment variables to bind to this key.
        If more than one are provided, they will take precedence in the specified order. The name of the environment variable is case sensitive.
        If the ENV variable name is not provided, then Viper will automatically assume that the ENV variable matches the following format: prefix + "_" + the key name in ALL CAPS.
        When you explicitly provide the ENV variable name (the second parameter), it does not automatically add the prefix.
            For example if the second parameter is "id", Viper will look for the ENV variable "ID".
    */
    viper.BindEnv("app.name", "APP_NAME") // Bind the app.name key to the APP_NAME environment variable

    // Get the values, using env variables if present
    appName := viper.GetString("app.name")
    namespace := viper.GetString("namespace") // AutomaticEnv will look for an environment variable called `ENV_NAMESPACE` ( prefix + "_" + key in ALL CAPS)
    appPort := viper.GetInt("app.port")       // AutomaticEnv will look for an environment variable called `ENV_APP_PORT` ( prefix + "_" + key in ALL CAPS with _ delimiters)

    // Output the configuration values
    fmt.Printf("App Name: %s\n", appName)
    fmt.Printf("Namespace: %s\n", namespace)
    fmt.Printf("App Port: %d\n", appPort)

    // Create an instance of AppConfig
    var config AppConfig
    // Unmarshal the config file into the AppConfig struct
    err = viper.Unmarshal(&config)
    if err != nil {
        log.Fatalf("Unable to decode into struct, %v", err)
    }

    // Output the configuration values
    fmt.Printf("Config: %v\n", config)
}

使用環境變數？

要動態整合環境變量，請建立一個包含以下內容的 .env 檔案：

export APP_NAME="MyCustomApp"
export ENV_NAMESPACE="go-viper"
export ENV_APP_PORT=9090

運行命令載入環境變數：

source .env

在程式碼中，Viper的AutomaticEnv和SetEnvKeyReplacer方法可讓您將巢狀配置鍵（如app.port）對應到環境變數（如APP_PORT）。其工作原理如下：

1. 帶有 SetEnvPrefix 的前綴： viper.SetEnvPrefix("env") 行確保所有環境變數搜尋都以 ENV_ 為前綴。例如：
   • app.port 變成 ENV_APP_PORT
   • 命名空間變成 ENV_NAMESPACE
2. 使用 SetEnvKeyReplacer 進行金鑰替換： SetEnvKeyReplacer(strings.NewReplacer(".", "_")) 取代 .鍵名稱中包含 _，因此像 app.port 這樣的巢狀鍵可以直接對應到環境變數。

透過結合這兩種方法，您可以使用環境變數無縫覆蓋特定的配置值。

？運行範例

使用以下命令執行應用程式：

go get github.com/spf13/viper

預期輸出：

app:
  name: "MyApp"
  port: 8080
namespace: "myapp"
owner: "John Doe"

最佳實踐？

• 對敏感資料使用環境變數：避免在設定檔中儲存機密。使用環境變數或秘密管理工具。
• 設定預設值： 使用 viper.SetDefault("key", value) 確保您的應用程式具有合理的預設值。
• 驗證設定： 載入配置後，驗證它們以防止運行時錯誤。
• 保持配置井然有序： 為了清晰起見，將相關配置分組在一起並使用巢狀結構。

？結論

透過利用 Viper，您可以簡化 Go 應用程式中的設定管理。它整合多個來源的靈活性、動態環境變數支援以及對結構的解組使其成為開發人員不可或缺的工具。

開始在您的下一個專案中使用 Viper 並體驗無憂的設定管理。快樂編碼！ ？

以上是Go with Viper 設定管理指南的詳細內容。更多資訊請關注PHP中文網其他相關文章！