標準庫：Go 如何獲取和設置環(huán)境變量

大家好，我是 polarisxu。

今天的文章比較基礎，但卻是必須掌握的，而且本文有些內(nèi)容，也許你之前沒想過。希望這篇文章能夠讓你理解環(huán)境變量并掌握 Go 環(huán)境變量相關操作。

01 從安裝 Go 說起

其實不止是安裝 Go，其他語言一本也會有類似的問題。一般來說，安裝完 Go 后，會建議將 go 可執(zhí)行程序配置到 PATH 環(huán)境變量中。

比如我本地的 PATH 環(huán)境變量的值：

$?echo?$PATH
/Users/xuxinhua/.go/bin:/usr/local/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Applications/Wireshark.app/Contents/MacOS:/Users/xuxinhua/.cargo/bin:/Users/xuxinhua/bin:/usr/local/git/bin:/Users/xuxinhua/.composer/vendor/bin:/Users/xuxinhua/go/bin

那么 PATH 環(huán)境變量的作用是什么呢？

簡單一句話就是，讓你在終端執(zhí)行命令時，不需要輸入絕對路徑。比如 Go 安裝在了 ~/.go/bin 目錄下，如果我們要執(zhí)行 Go 命令，得類似這樣：

$?~/.go/bin/go?version

是不是很麻煩？！但將 ~/.go/bin 目錄加入到 PATH 環(huán)境變量后，可以直接這樣執(zhí)行 Go 命令：

$?go?version

這就是 PATH 環(huán)境變量的作用：告知去哪里查找要執(zhí)行的命令。

那么環(huán)境變量的作用是什么呢？百科上關于環(huán)境變量的解釋：

環(huán)境變量（environment variables）一般是指在操作系統(tǒng)中用來指定操作系統(tǒng)運行環(huán)境的一些參數(shù)，如：臨時文件夾位置和系統(tǒng)文件夾位置等。

進程也會有自己的環(huán)境變量，一般從父進程繼承，也可以人為指定。比如在終端運行某個程序時，可以給它傳遞環(huán)境變量：

$?NAME=polarisxu?./xxx

進程中就可以通過 NAME 獲取到 polarisxu 這個值。

環(huán)境變量可以說無處不在，很多時候只是我們沒有細想而已。

注：因為 PATH 環(huán)境變量的作用機制，在 Shell、Dockerfile 等中，你需要時刻意識到，PATH 環(huán)境變量的值是什么，有沒有包含你的命令路徑，對于這樣的場景，可能更好的辦法是寫絕對路徑，而不是依賴 PATH。

02 Go 如何使用環(huán)境變量

很多大型應用程序，會使用環(huán)境變量進行配置（當然也支持其他方式配置，比如 flag）。作為配置選項的環(huán)境變量大大簡化了應用程序的部署。這些在云基礎設施中也很常見。

通常，基于環(huán)境變量的配置，如果環(huán)境變量沒設置，程序會有一個默認值。

在 Go 語言中，和環(huán)境變量相關的 API 主要在 os 包中。下面的 API 都加上了注釋。

// Environ 以 key=value 的形式返回所有環(huán)境變量。
func?Environ()?[]string
// ExpandEnv 根據(jù)當前環(huán)境變量的值替換字符串中的?${var}?或?$var。
//?對未定義變量的引用將被空字符串替換。
func?ExpandEnv(s?string)?string
// Getenv 檢索 key 這個鍵對應的環(huán)境變量的值。
//?如果該環(huán)境變量不存在，返回空字符串。
//?要區(qū)分空值和未設置值，請使用 LookupEnv。
func?Getenv(key?string)?string
// LookupEnv 檢索 key 這個鍵對應的環(huán)境變量的值。
//?如果該環(huán)境變量存在，則返回對應的值(可能為空)，并且布爾值為?true。
//?否則，返回值將為空，布爾值將為 false。
func?LookupEnv(key?string)?(string,?bool)
// Setenv 設置 key 這個鍵對應的環(huán)境變量的值。
//?如果出錯會返回錯誤。
func?Setenv(key,?value?string)?error
// Unsetenv 取消設置單個環(huán)境變量。
func?Unsetenv(key?string)?error
// Clearenv 將刪除所有環(huán)境變量。
func?Clearenv()

此外，os/exec 中有一個 LookPath 函數(shù)，和 PATH 環(huán)境變量有關：

//?在 PATH 環(huán)境變量對應的目錄中搜索名為 file 的可執(zhí)行文件。
//?如果文件包含?/，則不會搜索 PATH，而是正常路徑查找。
//?返回的結果可能是絕對路徑或相對于當前目錄的相對路徑。
func?LookPath(file?string)?(string,?error)

現(xiàn)在，通過一個例子看看這些 API 如何使用。

//?main.go
package?main

import?(
?"fmt"
??"os"
)

func?main()?{
??name?:=?os.Getenv("NAME")
??fmt.Println("name?is:",?name)
}

然后運行：

$?NAME=polarisxu?go?run?main.go
name?is:?polarisxu

如果前面的 NAME=polarisxu 沒有，則返回的 name 是空字符串。如果希望有默認值，該怎么做？

package?main

import?(
????"fmt"
????"os"
)

func?main()?{
????name?:=?GetenvDefault("NAME",?"xuxinhua")
????fmt.Println("name?is:",?name)
}

func?GetenvDefault(key,?defVal?string)?string?{
????val,?ok?:=?os.LookupEnv(key)
????if?ok?{
????????return?val
????}
????return?defVal
}

通過 os.LookupEnv 可以得到是否設置了環(huán)境變量。這時運行 go run main.go 的結果會是：name is: xuxinhua。

以上就是 Go 中會常用到獲取環(huán)境變量的 API。

其他 API，用到的可能性不大。有兩個 API 值得提一下：Environ() 和 ExpandEnv()。

前面提到過，進程會從父進程繼承環(huán)境變量。這里最重要的就是 PATH 環(huán)境變量。有時候，我們通過 os/exec 包執(zhí)行外部程序時，可能會提示找不到命令，這時需要確認 PATH 是否正確。可能 Shell 下 PATH 包含了命令所在目錄，但進程可能沒包含，我們可以在程序中輸出所有環(huán)境變量：

envs?:=?os.Environ()
for?_,?env?:=?range?envs?{
??fmt.Println(env)
}

一行是一個完整的環(huán)境變量，比如 LANG=zh_CN.UTF-8。

再看下 ExpandEnv() 函數(shù)。有以下代碼：（省略 main 相關其他代碼）

host?:=?os.ExpandEnv("127.0.0.1:$PORT")
fmt.Println(host)

IP:PORT 的形式是常見的，通常，我們會做字符串拼接：host + ":" + port，有了 os.ExpandEnv，不需要進行拼接了，它會將 $PORT 替換為 os.Getenv("PORT") 的值。

03 小結

環(huán)境變量你會用了嗎？

本文沒有通過代碼試驗的其他函數(shù)，建議你可以寫代碼試試，比如看看 os.Clearenv、os.Unsetenv 能不能刪除環(huán)境變量。