獲取Golang環(huán)境變量的三種方式小結(jié)

更新時(shí)間：2024年11月14日 11:55:18 作者：夢(mèng)想畫家

本文介紹了Golang中獲取環(huán)境變量的三種方式,包含使用Viper包、GoDotEnv包和os包,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

環(huán)境變量是應(yīng)用軟件參數(shù)配置的最佳方式，可以定義系統(tǒng)級(jí)，如開發(fā)、測(cè)試以及生成階段。配置參數(shù)主要有數(shù)據(jù)庫(kù)配置、第三方url等。因此環(huán)境變量對(duì)于開發(fā)和部署應(yīng)用至關(guān)重要。

環(huán)境變量和配置文件

shell 編程中從文件讀變量相對(duì)容易，只需要source包括環(huán)境變量的配置文件，就可以訪問所有這些變量。golang必須依賴一些模塊從文件中讀變量。本文內(nèi)容包括：

如何通過文件聲明環(huán)境變量
如何從文件讀取環(huán)境變量
當(dāng)變量未定義或空，如何設(shè)置缺省值
如果從系統(tǒng)讀取環(huán)境變量
如何檢查環(huán)境變量被定義或非空

當(dāng)容器化部署應(yīng)用（cloud, Kubernetes, 或Docker）至測(cè)試和生產(chǎn)環(huán)境時(shí)，環(huán)境變量角色非常重要，它可以很容易覆蓋缺省配置。golang訪問環(huán)境變量常用方法有三種：

Viper 包
godotenv 包
os 包

我們?cè)谑纠?xiàng)目中創(chuàng)建配置文件app.env文件，用于設(shè)置預(yù)定環(huán)境變量的缺省值。

創(chuàng)建環(huán)境變量配置文件必須遵守一些規(guī)則，否則golang可能不會(huì)識(shí)別變量值:

所有變量必須在單獨(dú)行中聲明
區(qū)分大小寫的變量名應(yīng)該使用大寫命名，單詞應(yīng)該用下劃線分隔，舉例：DB_HOST
變量值跟在變量名稱后面使用等號(hào)分割，舉例：DB_HOST=localhost
變量值不用雙引號(hào)，舉例： DB_HOST=”localhost”
注釋不應(yīng)該與變量在一行，舉例：

# depends with database ports mysql,mongodb,postgres etc
DB_PORT=5432

舉例，app.env 文件：

# sample app.env
# environment can be test,production,testing
APP_ENV=development
# username
DB_USER=postgres
# secure password
DB_PASS=pass
# app version not set
APP_VERSION=
#listening to any address
SERVER_ADDRESS=0.0.0.0:8080
# host value
DB_HOST=localhost
#depends with database mysql,mongodb,postgres etc
DB_PORT=5432

使用Viper包從配置文件中讀環(huán)境變量

這是一個(gè)環(huán)境變量管理工具包，可以從環(huán)境變量或配置文件中讀變量值。通過下面命令安裝包：

go get github.com/spf13/viper

示例1

首先定義結(jié)構(gòu)體，用于全局保存配置文件中的環(huán)境變量。

type Config struct {
	AppEnv        string `mapstructure:"APP_ENV"`
	DBUser        string `mapstructure:"DB_USER"`
	DBPass        string `mapstructure:"DB_PASS"`
	DBHost        string `mapstructure:"DB_HOST"`
	DBPort        string `mapstructure:"DB_PORT"`
	DBDriver      string `mapstructure:"DB_DRIVER"`
	AppVersion    string `mapstructure:"APP_VERSION"`
	ServerAddress string `mapstructure:"SERVER_ADDRESS"`
}

下面定義函數(shù)加載配置文件：

func LoadConfig(path string) (config Config, err error) {
	// Read file path
	viper.AddConfigPath(path)

	// set config file and path
	viper.SetConfigName("app")
	viper.SetConfigType("env")

	// watching changes in app.env
	viper.AutomaticEnv()

	// reading the config file
	err = viper.ReadInConfig()
	if err != nil {
		return
	}

	err = viper.Unmarshal(&config)
	return
}

完整代碼如下：

package main

import (
	"fmt"
	"log"

	"github.com/spf13/viper"
)

// Config stores all configuration of the application.
// The values are read by viper from a config file or environment variable.
type Config struct {
	AppEnv        string `mapstructure:"APP_ENV"`
	DBUser        string `mapstructure:"DB_USER"`
	DBPass        string `mapstructure:"DB_PASS"`
	DBHost        string `mapstructure:"DB_HOST"`
	DBPort        string `mapstructure:"DB_PORT"`
	DBDriver      string `mapstructure:"DB_DRIVER"`
	AppVersion    string `mapstructure:"APP_VERSION"`
	ServerAddress string `mapstructure:"SERVER_ADDRESS"`
}

// LoadConfig reads configuration from file or environment variables.
func LoadConfig(path string) (config Config, err error) {
	// Read file path
	viper.AddConfigPath(path)
	// set config file and path
	viper.SetConfigName("app")
	viper.SetConfigType("env")
	// watching changes in app.env
	viper.AutomaticEnv()
	// reading the config file
	err = viper.ReadInConfig()
	if err != nil {
		return
	}

	err = viper.Unmarshal(&config)
	return
}

func main() {
	// load app.env file data to struct
	config, err := LoadConfig(".")

	// handle errors
	if err != nil {
		log.Fatalf("can't load environment app.env: %v", err)
	}

	fmt.Printf(" -----%s----\n", "Reading Environment variables Using Viper package")
	fmt.Printf(" %s = %v \n", "Application_Environment", config.AppEnv)
	// not defined
	fmt.Printf(" %s = %s \n", "DB_DRIVE", dbDrive)
	fmt.Printf(" %s = %s \n", "Server_Listening_Address", config.ServerAddress)
	fmt.Printf(" %s = %s \n", "Database_User_Name", config.DBUser)
	fmt.Printf(" %s = %s \n", "Database_User_Password", config.DBPass)

}

輸出結(jié)果：

$ go run main.go
 ------Reading Environment variables Using Viper package----------
 Application_Environment = development 
 Server_Listening_Address = 0.0.0.0:8080 
 Database_User_Name = postgres 
 Database_User_Password = pass

示例2

有時(shí)環(huán)境變量可能未設(shè)置，這樣代碼可能會(huì)出錯(cuò)，我們可以使用下面方法定義缺省值：

viper.SetDefault:

下面示例代碼定義函數(shù)，如果變量未空或未定義，則返回缺省值：

package main

import (
	"fmt"

	"github.com/spf13/viper"
)

//Function to read an environment or return a default value
func getEnvValue(key string, defaultValue string) string {

	// Get file path
	viper.SetConfigFile("app.env")
	//read configs and handle errors
	err := viper.ReadInConfig()
	if err != nil {
		fmt.Println(err)
	}
	value := viper.GetString(key)
	if value != "" {
		return value
	}
	return defaultValue
}
func main() {
	// reading environments variable using the viper
	appEnv := getEnvValue("APP_ENV", "defaultEnvtesting")
	// not set in our app.env
	appVersion := getEnvValue("APP_VERSION", "1")
	dbPass := getEnvValue("DB_PASS", "1234")
	dbUser := getEnvValue("DB_USER", "goLinux_DB")
	serverAddress := getEnvValue("SERVER_ADDRESS", "127.0.0.1:8080")

	fmt.Printf(" ------%s-----\n", "Reading Environment variables Using Viper package")
	fmt.Printf(" %s = %s \n", "Application_Environment", appEnv)
	fmt.Printf(" %s = %s \n", "Application_Version", appVersion)
	fmt.Printf(" %s = %s \n", "Server_Listening_Address", serverAddress)
	fmt.Printf(" %s = %s \n", "Database_User_Name", dbUser)
	fmt.Printf(" %s = %s \n", "Database_User_Password", dbPass)
}

輸出結(jié)果：

$ go run main.go
 ---Reading Environment variables Using Viper package--------
 Application_Environment = development 
 Application_Version = 1 
 Server_Listening_Address = 0.0.0.0:8080 
 Database_User_Name = postgres 
 Database_User_Password = pass

使用GoDotEnv包從配置文件中讀環(huán)境變量

GoDotEnv包功能與viper包類似，但使用godotenv.Load()函數(shù)加載app.env文件，它接收文件名作為輸入，返回應(yīng)用上下文中的值。實(shí)現(xiàn)下面命令安裝包：

 go get github.com/joho/godotenv

Load方法可以傳入文件名稱，舉例：godotenv.Load("app.env")。
有時(shí).env文件位于項(xiàng)目根目錄，則可以直接載入，無需傳入?yún)?shù)：godotenv.Load("app.env)godotenv還支持一次加載多個(gè)配置文件：

_ = godotenv.Load("app.env", "k8s_app.env")

并且還支持YAML文件作為輸入：

// app.YAML
APP_ENV: Development
SERVER_ADDRESS: 0.0.0.0:8080

下面看一個(gè)完整實(shí)例：

// main.go
package main

import (
	"fmt"
	"log"
	"os"

	"github.com/joho/godotenv"
)

// Function to read an environment or return a default value
func getEnvValue(key string, defaultValue string) string {
	if value, ok := os.LookupEnv(key); ok && value != "" {
		return value
	}
	return defaultValue
}

func main() {
	// load app.env file
	err := godotenv.Load("app.env")
	//handle errors
	if err != nil {
		log.Fatalf("can't load environment app.env: %v", err)
	}

	// reading environments variable from the app context
	appEnv := getEnvValue("APP_ENV", "defaultEnvtesting")

	// not defined in our app.env
	appVersion := getEnvValue("APP_VERSION", "1")
	dbPass := getEnvValue("DB_PASS", "1234")

	// DB_NAME not defined in app env
	dbName := getEnvValue("DB_NAME", "goLinux_DB")
	dbUser := getEnvValue("DB_USER", "goLinux_DB")
	serverAddress := getEnvValue("SERVER_ADDRESS", "127.0.0.1:8080")

	fmt.Printf(" ----%s---\n", "Reading Environment variables Using GoDotEnv package ")
	fmt.Printf(" %s = %s \n", "Application_Environment", appEnv)
	fmt.Printf(" %s = %s \n", "Application_Version", appVersion)
	fmt.Printf(" %s = %s \n", "Server_Listening_Address", serverAddress)
	fmt.Printf(" %s = %s \n", "Database_User_Name", dbUser)
	fmt.Printf(" %s = %s \n", "Database_User_Password", dbPass)
	fmt.Printf(" %s = %s \n", "Database_Name", dbName)

}

輸出結(jié)果：

$ go run main.go   
              
 -----Reading Environment variables Using GoDotEnv package-----
 Application_Environment = development 
 Application_Version = 1 
 Server_Listening_Address = 0.0.0.0:8080 
 Database_User_Name = postgres 
 Database_User_Password = pass 
 Database_Name = goLinux_DB

使用os包從配置文件中讀環(huán)境變量

使用os.Setenv()設(shè)置環(huán)境變量

os.Setenv(key,value) 接收兩個(gè)輸入?yún)?shù)，一個(gè)為key，另一個(gè)是環(huán)境變量值。
語(yǔ)法如下：

err := os.Setenv(key, value)
if err != nil {
	fmt.Printf("error will setting the environment value: %s", err)
}

舉例,設(shè)置COLOUR=BLUE：

err := os.Setenv(COLOUR, BLUE)
if err != nil {
	fmt.Printf("error will setting the environment value: %s", err)
}

使用os.Getenv()讀系統(tǒng)環(huán)境變量

os.Getenv接收key，舉例，下面代碼獲取環(huán)境變量PATH的值：

// main.go
package main

import (
	"fmt"
	"os"
)

func main() {
	fmt.Println("supported paths in my shell: ", os.Getenv("PATH"))
}

使用os.LookupEnv()讀系統(tǒng)環(huán)境變量

os.Getenv()的缺點(diǎn)是無錯(cuò)誤返回key。對(duì)于需要增加額外檢查是否存在，則需要使用os.LookupEnv()，其返回值中包括布爾變量用于表示key是否存在。舉例：

// main.go
package main

import (
	"fmt"
	"log"
	"os"
)

func main() {

	path, ok := os.LookupEnv("PATH123")
	if !ok {
		log.Fatalln(path + " variable is not defined")
	}
	fmt.Println(path)
}

使用os.UnsetEvn()取消設(shè)置環(huán)境變量

os.UnsetEvn() 刪除或取消定義任何系統(tǒng)環(huán)境變量。注意，這只會(huì)暫時(shí)取消當(dāng)前終端的變量設(shè)置。舉例：

// main.go
package main

import (
	"fmt"
	"os"
)

func main() {
	
	os.Setenv("MYUSER", "TestUser")
	// Before unsetting the variable
	out, _ := os.LookupEnv("MYUSER")
	fmt.Println("BEFORE: " + out)

	// Unset the variable
	os.Unsetenv("MYUSER")

	// After unsetting the variable
	out, _ = os.LookupEnv("MYUSER")
	fmt.Println("AFTER: " + out)
}