Go 每日一庫之 godotenv

darjun發表於2020-02-12

簡介

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)
		}
	}

	return nil
}
複製程式碼

因為godotenv呼叫os.Setenv將鍵值對設定到環境變數中了。

總結

本文介紹了godotenv庫的基礎和高階用法。godotenv的原始碼也比較好讀，有時間，有興趣的童鞋建議一看~

參考

godotenv GitHub 倉庫：github.com/joho/godote…

我

我的部落格

歡迎關注我的微信公眾號【GoUpUp】，共同學習，一起進步~

本文由部落格一文多發平臺 OpenWrite 釋出！

Go 每日一庫之 jj
2020-03-26
Go
Go 每日一庫之 cobra
2020-01-18
Go
Go 每日一庫之 bitset
2022-07-17
Go
Go 每日一庫之 go-flags
2020-01-13
Go
Go 每日一庫之 validator
2020-04-05
Go
Go 每日一庫之 gopsutil
2020-04-06
Go
（轉）Go 每日一庫之 cast
2024-05-22
GoAST
Go 每日一庫之 go-carbon，優雅的 golang 日期時間處理庫
2021-02-03
Golang
go每日一庫 [go-rate] 速率限制器
2021-04-06
Go
Golang每日一庫之bcrypt
2023-04-27
Golang
Golang每日一庫之regex
2023-05-10
Golang
Golang 一日一庫之jwt-go
2023-04-11
GolangJWT
go每日一庫 [home-dir] 獲取使用者主目錄
2021-04-01
Go
go開源庫之jwt-go使用
2021-04-14
GoJWT
Go之資料庫操作
2020-12-31
Go資料庫
Go語言庫系列之email
2020-04-06
GoAI
go開源庫之cron使用
2021-04-14
Go
go測試庫之apitest
2023-05-05
GoAPI
Go Web 程式設計之資料庫
2020-01-21
GoWeb程式設計資料庫
Go 之基礎速學 (一)
2020-04-23
Go
【GO語言學習】每日一題：根據身高重建佇列
2020-11-17
Go每日一題佇列
每日一題（開開森森學前端之REM）
2019-05-02
每日一題前端REM
Go 錯誤堆疊資訊之 CockroachDB errors 庫
2020-12-31
GoError
go-zero之支付服務一
2021-10-27
Go
每日一題(開開森森學前端之Object系列)
2019-04-27
每日一題前端Object
Go 正規表示式庫之 commonregex
2021-05-31
Go
Go 標準庫之 GoRequests 介紹與基本使用
2024-04-15
Go
Go語言中mysql資料庫操作（一）
2021-09-09
GoMySql資料庫
每日一題
2020-12-13
每日一題
Go 常用標準庫之 fmt 介紹與基本使用
2023-10-25
Go
LeetCode 每日一題，用 Go 實現兩數之和的非暴力解法
2024-11-04
LeetCode每日一題Go
『Go 內建庫第一季：time』
2019-02-26
Go
『Go 內建庫第一季：error』
2018-11-08
GoError
『Go 內建庫第一季：reflect』
2018-11-04
Go
Golang一日一庫之日誌庫 zap
2023-04-12
Golang
每日一詞-remain
2018-09-25
REMAI
每日一題2
2020-11-04
每日一題
JAVA每日一記
2016-10-29
Java