README
Documentation
¶
Overview ¶
Package config 提供了对多种格式配置文件的支持
Index ¶
- type Config
- func AppDir(s Serializer, dir string) (*Config, error)
- func BuildDir(s Serializer, dir string) (*Config, error)
- func Dir(s Serializer, dir string) *Config
- func New(s Serializer, dir string, parent func() (string, error)) (*Config, error)
- func SystemDir(s Serializer, dir string) (*Config, error)
- func WDDir(s Serializer, dir string) (*Config, error)
- func (f *Config) Dir() string
- func (f *Config) Exists(name string) bool
- func (f *Config) Load(name string, v any) error
- func (f *Config) Open(name string) (fs.File, error)
- func (f *Config) Read(name string) ([]byte, error)
- func (f *Config) Save(name string, v any, mode fs.FileMode) error
- func (f *Config) Serializer() Serializer
- type FieldError
- type MarshalFunc
- type Sanitizer
- type Serializer
- func (s Serializer) Add(m MarshalFunc, u UnmarshalFunc, ext ...string) Serializer
- func (s Serializer) Delete(ext ...string)
- func (s Serializer) Exists(ext string) bool
- func (s Serializer) Get(ext string) (MarshalFunc, UnmarshalFunc)
- func (s Serializer) GetByFilename(name string) (MarshalFunc, UnmarshalFunc)
- func (s Serializer) Len() int
- func (s Serializer) Marshal(path string, v any, mode fs.FileMode) error
- func (s Serializer) Unmarshal(path string, v any) error
- func (s Serializer) UnmarshalFS(fsys fs.FS, name string, v any) error
- type UnmarshalFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v0.2.0
type Config struct {
// contains filtered or unexported fields
}
Config 项目的配置文件管理
func AppDir ¶ added in v0.2.0
func AppDir(s Serializer, dir string) (*Config, error)
AppDir 将应用程序下的 dir 作为配置文件的保存目录
dir 相对 os.Executable 的目录名称；
func BuildDir ¶ added in v0.2.0
func BuildDir(s Serializer, dir string) (*Config, error)
BuildDir 根据 dir 生成不同的 Config
dir 为项目的配置文件目录，后续通过 Config 操作的文件都是基于此目录的。可以带以下的特殊前缀：
- ~ 表示系统提供的配置文件目录，比如 Linux 的 XDG_CONFIG、Window 的 AppData 等；
- @ 表示当前程序的主目录；
- ^ 表示绝对路径；
- # 表示工作路径，这是一个随着工作目录变化的值，使用时需要小心；
- 其它则是直接采用 Dir 初始化。
func New ¶ added in v0.2.0
New 声明 Config 对象
dir 表示当前项目的配置文件存放的目录名称； parent 表示获取系统中用于存放配置文件的目录，比如 Linux 中的 XDG_CONFIG 等目录。 用户可以根据自己的需求自行实现该方法，如果为 nil，表示直接将 dir 作为全路径进行处理。
func SystemDir ¶ added in v0.2.0
func SystemDir(s Serializer, dir string) (*Config, error)
SystemDir 将系统提供的配置目录下的 dir 作为配置目录
dir 相对的 os.UserConfigDir 目录名称；
func WDDir ¶ added in v0.2.0
func WDDir(s Serializer, dir string) (*Config, error)
WDDir 将工作目录作为配置文件的保存目录
dir 相对 os.Getwd 的目录名称；
func (*Config) Load ¶ added in v0.2.0
Load 加载指定名称的文件内容至 v
name 为文件名，相对于 Config.Dir，根据文件扩展名决定采用什么编码方法； 如果 v 实现了 Sanitizer，在加载之后会调用该接口对数据进行处理；
func (*Config) Save ¶ added in v0.2.0
Save 将 v 解码并保存至 name 中
根据文件扩展名决定采用什么编码方法； mode 表示文件的权限，仅对新建文件时有效； 如果 v 实现了 Sanitizer，在保存之前会调用该接口对数据进行处理；
func (*Config) Serializer ¶ added in v0.2.0
func (f *Config) Serializer() Serializer
Serializer 返回管理配置文件序列化的对象
type FieldError ¶ added in v0.3.0
type FieldError struct {
Path string // 配置文件的路径
Field string // 字段名
Message any // 错误信息
Value any // 字段的原始值
}
FieldError 表示配置内容字段错误
func NewFieldError ¶ added in v0.3.0
func NewFieldError(field string, msg any) *FieldError
NewFieldError 返回表示配置文件错误的对象
field 表示错误的字段名； msg 表示错误信息，可以是任意类型，如果类型为 FieldError，那么将调用 msg.AddFieldParent(field)；
func (*FieldError) AddFieldParent ¶ added in v0.3.0
func (err *FieldError) AddFieldParent(prefix string) *FieldError
AddFieldParent 为字段名加上一个前缀
当字段名存在层级关系时，外层在处理错误时，需要为其加上当前层的字段名作为前缀。
func (*FieldError) Error ¶ added in v0.3.0
func (err *FieldError) Error() string
func (*FieldError) LocaleString ¶ added in v0.3.0
func (err *FieldError) LocaleString(p *localeutil.Printer) string
type MarshalFunc ¶ added in v0.2.0
type Serializer ¶ added in v0.2.0
type Serializer map[string]*serializer
Serializer 管理配置文件序列化的方法
根据配置文件的扩展查找相应的序列化方法， 扩展名必须以 . 开头，如果未带 .，则会自动加上。
func (Serializer) Add ¶ added in v0.2.0
func (s Serializer) Add(m MarshalFunc, u UnmarshalFunc, ext ...string) Serializer
Add 添加新的序列方法
ext 为文件扩展名，需要带 . 符号；
func (Serializer) Exists ¶ added in v0.2.0
func (s Serializer) Exists(ext string) bool
Exists 是否存在对指定扩展名的序列化方法
func (Serializer) Get ¶ added in v0.2.0
func (s Serializer) Get(ext string) (MarshalFunc, UnmarshalFunc)
Get 获取指定扩展名对应的序列化方法
如果不存在，则返回 nil。
func (Serializer) GetByFilename ¶ added in v0.2.0
func (s Serializer) GetByFilename(name string) (MarshalFunc, UnmarshalFunc)
GetByFilename 通过文件查找对应的序列化方法
func (Serializer) Len ¶ added in v0.2.0
func (s Serializer) Len() int
func (Serializer) Unmarshal ¶ added in v0.2.0
func (s Serializer) Unmarshal(path string, v any) error
Unmarshal 根据 path 后缀名序列化其内容至 v
func (Serializer) UnmarshalFS ¶ added in v0.2.0
UnmarshalFS 根据 name 后缀名序列化其内容至 v
Source Files
Directories