介紹

一個支持 yaml、json、toml、shell 的配置文件工具

安裝

go get github.com/jinzhu/configor

or

gopm get -v github.com/jinzhu/configor

使用示例

創(chuàng)建一個 yaml 配置文件，config.yml

appname: test
db:
  name:     test
  user:     root
  password: 123
  port:     3306
contacts:
  - name:  jack
    email: jack@test.com
  - name:  tom
    email: tom@test.com

編寫代碼：

package main
import (
    "fmt"
    "github.com/jinzhu/configor"
)
type Config struct {
    APPName string `default:"app name"`
    DB struct{
        Name     string
        User     string `default:"root"`
        Password string `required:"true" env:"DBPassword"`
        Port     uint   `default:"3306"`
    }
    Contacts []struct{
        Name  string
        Email string `required:"true"`
    }
}
func main()  {
    var conf = Config{}
    err := configor.Load(&conf, "config.yml")
    if err != nil {
        panic(err)
    }
    fmt.Printf("%v \n", conf)
}

測試模式

Usage:

// 上面的代碼 下面這這句
err := configor.Load(&conf, "config.yml")
// 修改為
err := configor.New(&configor.Config{Debug: true}).Load(&conf, "config.yml")

# 使用環(huán)境變量開啟測試模式，無需修改代碼
CONFIGOR_DEBUG_MODE=true go run config.go 

Output:

Current environment: 'development'
Loading configurations from file 'config.yml'...
Configuration:
  &main.Config{APPName:"test", DB:struct { Name string; User string "default:\"root\""; Password string "required:\"true\" env:\"DBPassword\""; Port uint "default:\"3306\"" }{Name:"test", User:"root", Password:"123", Port:0xcea}, Contacts:[]struct { Name string; Email string "required:\"true\"" }{struct { Name string; Email string "required:\"true\"" }{Name:"jack", Email:"jack@test.com"}, struct { Name string; Email string "required:\"true\"" }{Name:"tom", Email:"tom@test.com"}}}
{test {test root 123 3306} [{jack jack@test.com} {tom tom@test.com}]} 

詳細模式

Usage:

// 上面的代碼 下面這這句
err := configor.Load(&conf, "config.yml")
// 修改為
err := configor.New(&configor.Config{Verbose: true}).Load(&conf, "config.yml")

# 使用環(huán)境變量開啟詳細模式，無需修改代碼
CONFIGOR_VERBOSE_MODE=true go run config.go 

Output:

Current environment: 'development'
Loading configurations from file 'config.yml'...
Trying to load struct `Config`'s field `APPName` from env Configor_APPName, CONFIGOR_APPNAME
Trying to load struct `Config`'s field `DB` from env Configor_DB, CONFIGOR_DB
Trying to load struct ``'s field `Name` from env Configor_DB_Name, CONFIGOR_DB_NAME
Trying to load struct ``'s field `User` from env Configor_DB_User, CONFIGOR_DB_USER
Trying to load struct ``'s field `Password` from env DBPassword
Trying to load struct ``'s field `Port` from env Configor_DB_Port, CONFIGOR_DB_PORT
Trying to load struct `Config`'s field `Contacts` from env Configor_Contacts, CONFIGOR_CONTACTS
Trying to load struct ``'s field `Name` from env Configor_Contacts_0_Name, CONFIGOR_CONTACTS_0_NAME
Trying to load struct ``'s field `Email` from env Configor_Contacts_0_Email, CONFIGOR_CONTACTS_0_EMAIL
Trying to load struct ``'s field `Name` from env Configor_Contacts_1_Name, CONFIGOR_CONTACTS_1_NAME
Trying to load struct ``'s field `Email` from env Configor_Contacts_1_Email, CONFIGOR_CONTACTS_1_EMAIL
Configuration:
  &main.Config{APPName:"test", DB:struct { Name string; User string "default:\"root\""; Password string "required:\"true\" env:\"DBPassword\""; Port uint "default:\"3306\"" }{Name:"test", User:"root", Password:"123", Port:0xcea}, Contacts:[]struct { Name string; Email string "required:\"true\"" }{struct { Name string; Email string "required:\"true\"" }{Name:"jack", Email:"jack@test.com"}, struct { Name string; Email string "required:\"true\"" }{Name:"tom", Email:"tom@test.com"}}}
{test {test root 123 3306} [{jack jack@test.com} {tom tom@test.com}]}

高級用法

加載多個配置文件

// application.yml 的優(yōu)先級 大于 database.json, 排在前面的配置文件優(yōu)先級大于排在后的的配置
configor.Load(&Config, "application.yml", "database.json")

根據(jù)環(huán)境變量加載配置文件

使用CONFIGOR_ENV 設置環(huán)境變量，如果 CONFIGOR_ENV 沒有設置，框架將會使用 development 作為默認環(huán)境變量。

// config.go
configor.Load(&Config, "config.json")
$ go run config.go
// 將會加載 `config.json`，如果存在 `config.development.json` 將會自動加載
// `config.development.json` 將會覆蓋 `config.json` 的配置
$ CONFIGOR_ENV=production go run config.go
// 將會加載 `config.json`，如果存在 `config.production.json` 將會自動加載
// `config.production.json` 將會覆蓋 `config.json` 的配置
$ go test
// 將會加載 `config.json`，如果存在 `config.test.json` 將會自動加載
// `config.test.json` 將會覆蓋 `config.json` 的配置
$ CONFIGOR_ENV=production go test
// 將會加載 `config.json`，如果存在 `config.production.json` 將會自動加載
// `config.production.json` 將會覆蓋 `config.json` 的配置

// 在代碼里面設置 環(huán)境變量
configor.New(&configor.Config{Environment: "production"}).Load(&Config, "config.json")

示例配置

configor.Load(&Config, "config.yml")
$ go run config.go
# 將會自動加載 `config.example.yml` 如果 `config.yml` 不存在將會輸出警告信息

Output:

Failed to find configuration config.yml, using example file config.example.yml
{test {dodododo root 123 3306 } [{jack jack@test.com} {tom tom@test.com}]} 

從shell加載配置項

CONFIGOR_APPNAME="hello world" go run config.go
# 格式為 {{prefix}}_FieldName

# 覆蓋 prefix shell 操作
$ CONFIGOR_ENV_PREFIX="WEB" WEB_APPNAME="hello, prefix" go run config.go
# 在代碼的書寫方式為
configor.New(&configor.Config{ENVPrefix: "WEB"}).Load(&Config, "config.json")

匿名結構 - Anonymous Struct

type Details Struct {
    Description string
}
type Config struct {
    Details `anonymous:"true"`
}

如果使用 anonymous:"true" 標簽，那么 Description 參數(shù)的環(huán)境變量將會變?yōu)?CONFIGOR_DESCRIPTION，否則環(huán)境變量將會是 CONFIGOR_DETAILS_DESCRIPTION

到此這篇關于Golang Configor配置文件工具的使用詳解的文章就介紹到這了,更多相關go configor內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！