簡介
twelve-factor應用提倡將配置存儲在環境變量中。任何從開發環境切換到生產環境時需要修改的東西都從代碼抽取到環境變量里。但是在實際開發中，如果同一台機器運行多個項目，設置環境變量容易沖突，不實用。godotenv庫從.env文件中讀取配置， 然后存儲到程序的環境變量中。在代碼中可以使用讀取非常方便。godotenv源於一個 Ruby 的開源項目dotenv。
快速使用
第三方庫需要先安裝：
$ go get github.com/joho/godotenv
后使用：
package main
import (
"fmt"
"log"
"os"
"github.com/joho/godotenv"
)
func main() {
err := godotenv.Load()
if err != nil {
log.Fatal(err)
}
fmt.Println("name: ", os.Getenv("name"))
fmt.Println("age: ", os.Getenv("age"))
}
然后在可執行程序相同目錄下，添加一個.env文件：
name = dj age = 18
運行程序，輸出：
name: dj age: 18
可見，使用非常方便。默認情況下，godotenv讀取項目根目錄下的.env文件，文件中使用key = value的格式，每行一個鍵值對。調用godotenv.Load()即可加載，可直接調用os.Getenv("key")讀取。os.Getenv是用來讀取環境變量的：
package main
import (
"fmt"
"os"
)
func main() {
fmt.Println(os.Getenv("GOPATH"))
}
高級特性
自動加載
如果你有程序員的優良傳統——懶，你可能連Load方法都不想自己調用。沒關系，godotenv給你懶的權力！
導入github.com/joho/godotenv/autoload，配置會自動讀取：
package main
import (
"fmt"
"os"
_ "github.com/joho/godotenv/autoload"
)
func main() {
fmt.Println("name: ", os.Getenv("name"))
fmt.Println("age: ", os.Getenv("age"))
}
注意，由於代碼中沒有顯式用到godotenv庫，需要使用空導入，即導入時包名前添加一個_。
看autoload包的源碼，其實就是庫幫你調用了Load方法：
// src/github.com/joho/godotenv/autoload/autoload.go
package autoload
/*
You can just read the .env file on import just by doing
import _ "github.com/joho/godotenv/autoload"
And bob's your mother's brother
*/
import"github.com/joho/godotenv"
func init() {
godotenv.Load()
}
仔細看注釋，程序員的惡趣味😂！
加載自定義文件
默認情況下，加載的是項目根目錄下的.env文件。當然我們可以加載任意名稱的文件，文件也不必以.env為后綴：
package main
import (
"fmt"
"log"
"os"
"github.com/joho/godotenv"
)
func main() {
err := godotenv.Load("common", "dev.env")
if err != nil {
log.Fatal(err)
}
fmt.Println("name: ", os.Getenv("name"))
fmt.Println("version: ", os.Getenv("version"))
fmt.Println("database: ", os.Getenv("database"))
}
common文件內容：
name = awesome web version = 0.0.1
dev.env：
database = sqlite
production.env：
database = mysql
自己運行看看結果吧！
注意：Load接收多個文件名作為參數，如果不傳入文件名，默認讀取.env文件的內容。如果多個文件中存在同一個鍵，那么先出現的優先，后出現的不生效。所以，上面輸出的database是什么？
注釋
.env文件中可以添加注釋，注釋以#開始，直到該行結束。
# app name name = awesome web # current version version = 0.0.1
YAML
.env文件還可以使用 YAML 格式：
name: awesome web
version: 0.0.1
package main
import (
"fmt"
"os"
_ "github.com/joho/godotenv/autoload"
)
func main() {
fmt.Println("name: ", os.Getenv("name"))
fmt.Println("version: ", os.Getenv("version"))
}
不存入環境變量
godotenv允許不將.env文件內容存入環境變量，使用godotenv.Read()返回一個map[string]string，可直接使用：
package main
import (
"fmt"
"log"
"github.com/joho/godotenv"
)
func main() {
var myEnv map[string]string
myEnv, err := godotenv.Read()
if err != nil {
log.Fatal(err)
}
fmt.Println("name: ", myEnv["name"])
fmt.Println("version: ", myEnv["version"])
}
直接操作map，簡單直接！
數據源
除了讀取文件，還可以從io.Reader，從string中讀取配置：
package main
import (
"fmt"
"log"
"github.com/joho/godotenv"
)
func main() {
content := `
name: awesome web
version: 0.0.1
`
myEnv, err := godotenv.Unmarshal(content)
if err != nil {
log.Fatal(err)
}
fmt.Println("name: ", myEnv["name"])
fmt.Println("version: ", myEnv["version"])
}
只要實現了io.Reader接口，就能作為數據源。可以從文件（os.File），網絡（net.Conn），bytes.Buffer等多種來源讀取：
package main
import (
"bytes"
"fmt"
"log"
"os"
"github.com/joho/godotenv"
)
func main() {
file, _ := os.OpenFile(".env", os.O_RDONLY, 0666)
myEnv, err := godotenv.Parse(file)
if err != nil {
log.Fatal(err)
}
fmt.Println("name: ", myEnv["name"])
fmt.Println("version: ", myEnv["version"])
buf := &bytes.Buffer{}
buf.WriteString("name: awesome web @buffer")
buf.Write([]byte{'\n'})
buf.WriteString("version: 0.0.1")
myEnv, err = godotenv.Parse(buf)
if err != nil {
log.Fatal(err)
}
fmt.Println("name: ", myEnv["name"])
fmt.Println("version: ", myEnv["version"])
}
注意，從字符串讀取和從io.Reader讀取使用的方法是不同的。前者為Unmarshal，后者是Parse。
生成.env文件
可以通過程序生成一個.env文件的內容，可以直接寫入到文件中：
package main
import (
"bytes"
"log"
"github.com/joho/godotenv"
)
func main() {
buf := &bytes.Buffer{}
buf.WriteString("name = awesome web")
buf.WriteByte('\n')
buf.WriteString("version = 0.0.1")
env, err := godotenv.Parse(buf)
if err != nil {
log.Fatal(err)
}
err = godotenv.Write(env, "./.env")
if err != nil {
log.Fatal(err)
}
}
查看生成的.env文件：
name="awesome web" version="0.0.1"
還可以返回一個字符串，怎么揉捏隨你：
package main
import (
"bytes"
"fmt"
"log"
"github.com/joho/godotenv"
)
func main() {
buf := &bytes.Buffer{}
buf.WriteString("name = awesome web")
buf.WriteByte('\n')
buf.WriteString("version = 0.0.1")
env, err := godotenv.Parse(buf)
if err != nil {
log.Fatal(err)
}
content, err := godotenv.Marshal(env)
if err != nil {
log.Fatal(err)
}
fmt.Println(content)
}
命令行模式
godotenv還提供了一個命令行的模式：
$ godotenv -f ./.env command args
前面在go get安裝godotenv時，godotenv就已經安裝在$GOPATH/bin目錄下了，我習慣把$GOPATH/bin加入系統PATH，所以godotenv命令可以直接使用。
命令行模式就是讀取指定文件（如果不通過-f指定，則使用.env文件），設置環境變量，然后運行后面的程序。
我們簡單寫一個程序驗證一下：
package main
import (
"fmt"
"os"
)
func main() {
fmt.Println(os.Getenv("name"))
fmt.Println(os.Getenv("version"))
}
使用godotenv運行一下：
$ godotenv -f ./.env go run main.go
輸出：
awesome web 0.0.1
多個環境
實踐中，一般會根據APP_ENV環境變量的值加載不同的文件：
package main
import (
"fmt"
"log"
"os"
"github.com/joho/godotenv"
)
func main() {
env := os.Getenv("GODAILYLIB_ENV")
if env == "" {
env = "development"
}
err := godotenv.Load(".env." + env)
if err != nil {
log.Fatal(err)
}
err = godotenv.Load()
if err != nil {
log.Fatal(err)
}
fmt.Println("name: ", os.Getenv("name"))
fmt.Println("version: ", os.Getenv("version"))
fmt.Println("database: ", os.Getenv("database"))
}
我們先讀取環境變量GODAILYLIB_ENV，然后讀取對應的.env. + env，最后讀取默認的.env文件。
前面也提到過，先讀取到的優先。我們可以在默認的.env文件中配置基礎信息和一些默認的值， 如果在開發/測試/生產環境需要修改，那么在對應的.env.development/.env.test/.env.production文件中再配置一次即可。
.env文件內容：
name = awesome web version = 0.0.1 database = file
.env.development：
database = sqlite3
.env.production：
database = mysql
運行程序：
# 默認是開發環境 $ go run main.go name: awesome web version: 0.0.1 database: sqlite3 # 設置為生成環境 $ GODAILYLIB_ENV=production go run main.go name: awesome web version: 0.0.1 database: mysql
一點源碼
godotenv讀取文件內容，為什么可以使用os.Getenv訪問：
// src/github.com/joho/godotenv/godotenv.go
func loadFile(filename string, overload bool) error {
envMap, err := readFile(filename)
if err != nil {
return err
}
currentEnv := map[string]bool{}
rawEnv := os.Environ()
for _, rawEnvLine := range rawEnv {
key := strings.Split(rawEnvLine, "=")[0]
currentEnv[key] = true
}
for key, value := range envMap {
if !currentEnv[key] || overload {
os.Setenv(key, value)
}
}
returnnil
}
因為godotenv調用os.Setenv將鍵值對設置到環境變量中了。
總結
本文介紹了godotenv庫的基礎和高級用法。godotenv的源碼也比較好讀，有時間，有興趣的童鞋建議一看~
參考
- godotenv GitHub 倉庫：https://github.com/joho/godotenv