config

package

v0.32.0 Latest Latest Go to latest Published: Oct 3, 2020 License: MIT Imports: 7 Imported by: 0

Details

Package config 提供了加载配置项内容的各类方法

This section is empty.

View Source

var ErrNotFound = errors.New("id 值已经存在")

ErrNotFound 未找到与 ID 相关的项

func LoadFile(path string, v interface{}) error

LoadFile 加载配置文件内容至 v

支持 yaml、xml 和 json 格式内容，以后缀名作为判断依据。

func LoadJSON(path string, v interface{}) error

LoadJSON 加载 JSON 的配置文件并转换成 v 对象的内容

func LoadXML(path string, v interface{}) error

LoadXML 加载 XML 的配置文件并转换成 v 对象的内容

func LoadYAML(path string, v interface{}) error

LoadYAML 加载 YAML 的配置文件并转换成 v 对象的内容

type Config struct {
	// contains filtered or unexported fields
}

Config 管理配置项的加载和刷新

func New(config string, v interface{}, f UnmarshalFunc, notify func()) *Config

New 注册配置项

config 表示配置项的配置内容，比如文件名、SQL 的 DSN 等； v 配置项导出对象的实例指针，最终 config 指向的数据会被解析到 v 中; f 从 config 导入到 v 的实现方法； notify 如果后期需要更新数据，则通过此函数通知用户数据已经被更新；

func (cfg *Config) Refresh() error

Refresh 刷新指定 ID 的配置项

type FieldError struct {
	Field, Message string
}

FieldError 表示配置内容字段错误

func (err *FieldError) Error() string

type UnmarshalFunc func(config string, v interface{}) error

UnmarshalFunc 定义了配置项的解码函数原型

config 为配置项的配置内容，可以是一个文件名或是数据库的 DSN 等， UnmarshalFunc 负责将其指向的内容解析并映身到 v 对象。