代码拉取完成,页面将自动刷新
简洁、功能完善的Golang应用程序配置管理工具库
JSON
(默认), INI
, YAML
, TOML
, HCL
, ENV
, Flags
JSON
内容支持注释,可以设置解析时清除注释flags
)设置配置数据config.BindStruct("key", &s)
.
分隔符来按路径获取子级值,也支持自定义分隔符。 e.g map.key
arr.2
shell: ${SHELL}
-> shell: /bin/zsh
Get
Int
Uint
Int64
String
Bool
Ints
IntMap
Strings
StringMap
...提供一个子包
dotenv
,支持从文件(eg.env
)中导入数据到ENV
如果你仅仅想用INI来做简单配置管理,推荐使用 gookit/ini
这里使用yaml格式作为示例(testdata/yml_other.yml
):
name: app2
debug: false
baseKey: value2
shell: ${SHELL}
envKey1: ${NotExist|defValue}
map1:
key: val2
key2: val20
arr1:
- val1
- val21
示例代码请看 _examples/yaml.go:
package main
import (
"github.com/gookit/config/v2"
"github.com/gookit/config/v2/yaml"
)
// go run ./examples/yaml.go
func main() {
// 设置选项支持 ENV 解析
config.WithOptions(config.ParseEnv)
// 添加驱动程序以支持yaml内容解析(除了JSON是默认支持,其他的则是按需使用)
config.AddDriver(yaml.Driver)
// 加载配置,可以同时传入多个文件
err := config.LoadFiles("testdata/yml_base.yml")
if err != nil {
panic(err)
}
// fmt.Printf("config data: \n %#v\n", config.Data())
// 加载更多文件
err = config.LoadFiles("testdata/yml_other.yml")
// can also load multi at once
// err := config.LoadFiles("testdata/yml_base.yml", "testdata/yml_other.yml")
if err != nil {
panic(err)
}
}
// 获取整型
age := config.Int("age")
fmt.Print(age) // 100
// 获取布尔值
val := config.Bool("debug")
fmt.Print(val) // true
// 获取字符串
name := config.String("name")
fmt.Print(name) // inhere
// 获取字符串数组
arr1 := config.Strings("arr1")
fmt.Printf("%v %#v", arr1) // []string{"val1", "val21"}
// 获取字符串KV映射
val := config.StringMap("map1")
fmt.Printf("%v %#v",val) // map[string]string{"key":"val2", "key2":"val20"}
// 值包含ENV变量
value := config.String("shell")
fmt.Print(value) // /bin/zsh
// 通过key路径获取值
// from array
value := config.String("arr1.0")
fmt.Print(value) // "val1"
// from map
value := config.String("map1.key")
fmt.Print(value) // "val2"
// set value
config.Set("name", "new name")
// get
name = config.String("name")
fmt.Print(name) // new name
user := struct {
Age int
Kye string
Tags []int
}{}
err = config.BindStruct("user", &user)
// os env: APP_NAME=config APP_DEBUG=true
// load ENV info
config.LoadOSEnv([]string{"APP_NAME", "APP_NAME"}, true)
// read
config.Bool("app_debug") // true
config.String("app_name") // "config"
支持简单的命令行
flag
参数解析,加载数据
// flags like: --name inhere --env dev --age 99 --debug
// load flag info
keys := []string{"name", "env", "age:int" "debug:bool"}
err := config.LoadFlags(keys)
// read
config.String("name") // "inhere"
config.String("env") // "dev"
config.Int("age") // 99
config.Bool("debug") // true
// Options config options
type Options struct {
// parse env value. like: "${EnvName}" "${EnvName|default}"
ParseEnv bool
// config is readonly. default is False
Readonly bool
// enable config data cache. default is False
EnableCache bool
// parse key, allow find value by key path. default is True eg: 'key.sub' will find `map[key]sub`
ParseKey bool
// the delimiter char for split key, when `FindByPath=true`. default is '.'
Delimiter byte
// default write format. default is JSON
DumpFormat string
// default input format. default is JSON
ReadFormat string
}
LoadOSEnv(keys []string)
从ENV载入数据LoadData(dataSource ...interface{}) (err error)
从struct或map加载数据LoadFlags(keys []string) (err error)
从命令行参数载入数据LoadExists(sourceFiles ...string) (err error)
从存在的配置文件里加载数据,会忽略不存在的文件LoadFiles(sourceFiles ...string) (err error)
从给定的配置文件里加载数据,有文件不存在则会panicLoadRemote(format, url string) (err error)
从远程 URL 加载配置数据LoadSources(format string, src []byte, more ...[]byte) (err error)
从给定格式的字节数据加载配置LoadStrings(format string, str string, more ...string) (err error)
从给定格式的字符串配置里加载配置数据Bool(key string, defVal ...bool) bool
Int(key string, defVal ...int) int
Uint(key string, defVal ...uint) uint
Int64(key string, defVal ...int64) int64
Ints(key string) (arr []int)
IntMap(key string) (mp map[string]int)
Float(key string, defVal ...float64) float64
String(key string, defVal ...string) string
Strings(key string) (arr []string)
StringMap(key string) (mp map[string]string)
Get(key string, findByPath ...bool) (value interface{})
Set(key string, val interface{}, setByPath ...bool) (err error)
Getenv(name string, defVal ...string) (val string)
AddDriver(driver Driver)
Data() map[string]interface{}
Exists(key string, findByPath ...bool) bool
DumpTo(out io.Writer, format string) (n int64, err error)
BindStruct(key string, dst interface{}) error
go test -cover
// contains all sub-folder
go test -cover ./...
MIT
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型