twelve-factor應用提倡將配置存儲在環境變量中。任何從開發環境切換到生產環境時須要修改的東西都從代碼抽取到環境變量裏。
可是在實際開發中,若是同一臺機器運行多個項目,設置環境變量容易衝突,不實用。godotenv庫從.env
文件中讀取配置,
而後存儲到程序的環境變量中。在代碼中可使用讀取很是方便。godotenv
源於一個 Ruby 的開源項目dotenv。mysql
第三方庫須要先安裝:git
$ 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
文件:github
name = dj age = 18
運行程序,輸出:golang
name: dj age: 18
可見,使用很是方便。默認狀況下,godotenv
讀取項目根目錄下的.env
文件,文件中使用key = value
的格式,每行一個鍵值對。
調用godotenv.Load()
便可加載,可直接調用os.Getenv("key")
讀取。os.Getenv
是用來讀取環境變量的:web
package main import ( "fmt" "os" ) func main() { fmt.Println(os.Getenv("GOPATH")) }
若是你有程序員的優良傳統——懶,你可能連Load
方法都不想本身調用。不要緊,godotenv
給你懶的權力!sql
導入github.com/joho/godotenv/autoload
,配置會自動讀取:segmentfault
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
.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) } } return nil }
由於godotenv
調用os.Setenv
將鍵值對設置到環境變量中了。
本文介紹了godotenv
庫的基礎和高級用法。godotenv
的源碼也比較好讀,有時間,有興趣的童鞋建議一看~
歡迎關注個人微信公衆號【GoUpUp】,共同窗習,一塊兒進步~
本文由博客一文多發平臺 OpenWrite 發佈!