https://github.com/hyahm/goconfig
golang read config like ini, support ini, json, yaml using
https://github.com/hyahm/goconfig
config go ini json yaml
Last synced: 9 months ago
JSON representation
golang read config like ini, support ini, json, yaml using
- Host: GitHub
- URL: https://github.com/hyahm/goconfig
- Owner: hyahm
- Created: 2019-07-09T03:00:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-16T01:34:34.000Z (about 4 years ago)
- Last Synced: 2024-06-19T10:15:35.764Z (about 2 years ago)
- Topics: config, go, ini, json, yaml
- Language: Go
- Homepage:
- Size: 160 KB
- Stars: 8
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# goconfig
read go config from key value ini file
### 安装
```
go get github.com/hyahm/goconfig
```
### 注意
- 支持读取任何单行配置文件
- 自定义符号
- 支持写入配置文件
- 支持变量
# 使用
### 自定义符号, 加载配置文件之前定义, 只对ini文件的kv值有效
```ini
SEP = "=" // key 和 value 分隔符
NOTE = "#;" // #开头的为注释
MODEL_START = "[" // 模块开头符号
MODEL_END = "]" // 模块结尾符号
WELL = "#" // 写入的注释，
Deep // 默认值有效个数， 默认为3
```
### 读取配置
> test.ini
```vim
$var="I am a variable value"
[mysql]
host=192.168.80.2
port=name${var}
name=name${var}
```
> 第一个参数后面表示默认值，默认支持长度为3， 如果不存在key， 或者读取的值不符合读取类型的默认值
```
goconfig.InitConf("test.ini")
goconfig.ReadString("mysql.host", "127.0.0.1") // return 192.168.80.2
goconfig.ReadInt("mysql.port", 3306) // return 3306
goconfig.ReadString("mysql.db", "name") // return name
goconfig.ReadString("mysql.deep", "one", "two", "three") // return one
goconfig.ReadString("mysql.deep", "", "two", "three") // return two
goconfig.ReadString("mysql.deep", "", "", "three") // return three
goconfig.ReadString("mysql.name", "") // return nameI am a variable value
goconfig.ReadString("var", "") // return I am a variable value
```
> 从[]byte 读取
```vim
```go
x := `[mysql]
host=192.168.80.2
port=name
`
当然也可以是传过来的数据进行解析
goconfig.InitFromBytes([]byte(x))
goconfig.ReadString("mysql.host", "127.0.0.1") // return 192.168.80.2
goconfig.ReadInt("mysql.port", 3306) // return 3306
goconfig.ReadString("mysql.db", "name") // return name
```
### 写入配置文件
```
goconfig.InitWriteConf("write.conf") // 与InitConf的区别是， 这个会清空里面原有数据
goconfig.InitConf("test.conf") // 原有配置文件添加
goconfig.WriteString("mysql.host", "127.0.0.1","mysql数据库host")
goconfig.WriteInt("mysql.port", 3306)
goconfig.WriteString("mysql.db", "name")
goconfig.FlushWrite() // 缓存一次写入文件， 写入别忘了这行
```
> test.conf
```
[mysql]
# mysql数据库host
host = 127.0.0.1
port = 3306
db = name
```
### 配置文件软加载方法
err = Reload(), 仅限InitConf(file) 从文件读取的软加载， 自己写接口调用此方法， 配置文件会刷新， 如果配置文件有错则不会更新
# 辅助方法， 方便调试
PrintLines() // 打印读取的配置文件
PrintKeyValue() // 打印kv数据