1. 程式人生 > 其它 >Golang獲取系統環境變數及godotenv庫使用

Golang獲取系統環境變數及godotenv庫使用

1、Golang 獲取系統環境變數

Golang 要獲取系統的環境變數需要匯入"os"包,通過os包中的Getenv方法來獲取。

func Getenv(key string) string {

}

示例程式碼:

package main
 
import (
  "fmt"
  "os"
)
 
func main() {
  fmt.Println(os.Getenv("GOPATH"))
} 

2、通過godotenv庫配置環境變數

2.1 簡介

微服務應用提倡將配置儲存在環境變數中。任何從開發環境切換到生產環境時需要修改的東西都從程式碼抽取到環境變數裡。但是在實際開發中,如果同一臺機器執行多個專案,設定環境變數容易衝突,不實用。godotenv庫從.env

檔案中讀取配置, 然後儲存到程式的環境變數中。在程式碼中可以使用讀取非常方便。godotenv源於一個 Ruby 的開源專案dotenv。

2.2 快速使用

第三方庫需要先安裝:

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 = zmc
age = 20

執行程式,輸出:

name:  zmc
age:  20

可見,使用非常方便。預設情況下,godotenv讀取專案根目錄下的.env檔案,檔案中使用key = value的格式,每行一個鍵值對。呼叫godotenv.Load()即可載入,可直接呼叫os.Getenv("key")讀取。

2.3 高階特性

自動載入

如果連Load方法都不想自己呼叫,可以匯入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", "production.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

執行結果:

name:  awesome web
version:  0.0.1
database:  sqlite

注意:Load接收多個檔名作為引數,如果不傳入檔名,預設讀取.env檔案的內容。如果多個檔案中存在同一個鍵,那麼先出現的優先,後出現的不生效。所以,上面輸出的database是sqlite。

註釋

.env檔案中可以添加註釋,註釋以#開始,直到該行結束。

# app name
name = awesome web
# current version
version = 0.0.1

YAML

.env檔案還可以使用 YAML 格式:

name: awesome web
version: 0.0.1

不存入環境變數(重要)

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

輸出:

name:  awesome web
version:  0.0.1

直接操作map,簡單直接!

資料來源

除了讀取檔案,還可以從string、io.Reader中讀取配置:

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

輸出:

name:  awesome web
version:  0.0.1

只要實現了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"])
}

輸出:

name:  awesome web
version:  0.0.1
name:  awesome web @buffer
version:  0.0.1  

注意,從字串讀取和從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)
}

輸出:

name="awesome web"
version="0.0.1"

命令列模式

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

2.4 一點原始碼

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將鍵值對設定到環境變數中了。

參考:https://www.cnblogs.com/-wenli/p/12332436.html