基本介绍
GoFrame
的配置管理由 gcfg
组件实现, gcfg
组件的所有方法是并发安全的。 gcfg
组件采用接口化设计,默认提供的是基于文件系统的接口实现。
使用方式:
import "github.com/gogf/gf/v2/os/gcfg"
接口文档:
https://pkg.go.dev/github.com/gogf/gf/v2/os/gcfg
组件特性
gcfg
组件具有以下显著特性:
- 接口化设计,很高的灵活性及扩展性,默认提供文件系统接口实现
- 支持多种常见配置文件格式:
yaml/toml/json/xml/ini/properties
- 支持配置项不存在时读取指定环境变量或命令行参数
- 支持检索读取资源管理组件中的配置文件
- 支持配置文件自动检测热更新特性
- 支持层级访问配置项
- 支持单例管理模式
注意事项
框架配置组件支持多种常用的数据格式,但在后续的示例代码中均使用 yaml
数据格式来做演示说明。在使用中,请随意使用习惯的数据格式 不用局限于官网示例使用的 yaml
数据格式。例如,在业务项目模板中提供的是 config.yaml
配置文件模板(因为默认模板只能提供一种啊),您也可以直接修改为 config.toml
或者 config.ini
等支持的数据格式, 配置组件也能自动根据文件名后缀识别读取。
相关文档
📄️ 配置管理-配置对象
我们推荐使用单例模式获取配置管理对象。我们可以方便地通过 g.Cfg() 获取默认的全局配置管理对象。同时,我们也可以通过 gcfg.Instance 包方法获取配置管理对象单例。
📄️ 配置管理-文件配置
gcfg 组件采用接口化设计,默认提供的是基于文件系统的接口实现。支持的数据文件格式包括: JSON/XML/YAML(YML)/TOML/INI/PROPERTIES,项目中开发者可以灵活地选择自己熟悉的配置文件格式来进行配置管理。
📄️ 配置管理-常用方法
以下常 用方法列表,文档更新可能滞后于代码新特性,更多的方法及示例请参考代码文档: https://pkg.go.dev/github.com/gogf/gf/v2/os/gcfg
🗃️ 配置管理-接口化设计
2 items
📄️ 配置管理-YAML格式
一、简介
📄️ 配置管理-TOML格式
基本介绍