configure

README

Getting Started with configure

Configuration file path

In the root of your executable
./farseer.yaml

Get Configuration

configure.GetString("Database.default")

Get child nodes

config := configure.GetSubNodes("Database")  // return map[string]string

Set default configuration

// When the Database.test node, is not set, the default configuration is used
configure.SetDefault("Database.test", "DataType=MySql,PoolMaxSize=50,PoolMinSize=1,ConnectionString=root:xxxx@123456@tcp(mysql:3306)/test?charset=utf8&parseTime=True&loc=Local")

Documentation

Index

• func GetBool(key string) bool
• func GetFopsServer() string
• func GetInt(key string) int
• func GetInt64(key string) int64
• func GetSlice(key string) []string
• func GetSliceNodes(key string) []map[string]any
• func GetString(key string) string
• func GetStrings(key string) []string
• func GetSubNodes(key string) map[string]any
• func InitConfig()
• func NewEnvConfig() *envConfig
• func NewYamlConfig(configFile string) *yamlConfig
• func ParseConfig[TConfig any](key string) TConfig
• func ParseConfigs[TConfig any](key string) []TConfig
• func ParseString[TConfig any](configString string) TConfig
• func SetDefault(key string, value any)
• type IConfigProvider

Functions

func GetBool

func GetBool(key string) bool

GetBool 获取配置

func GetFopsServer

func GetFopsServer() string

GetFopsServer 获取FOPS地址

func GetInt

func GetInt(key string) int

GetInt 获取配置

func GetInt64

func GetInt64(key string) int64

GetInt64 获取配置

func GetSlice

func GetSlice(key string) []string

GetSlice 获取数组

func GetSliceNodes

func GetSliceNodes(key string) []map[string]any

GetSliceNodes 获取数组节点

func GetString

func GetString(key string) string

GetString 获取配置

func GetStrings

func GetStrings(key string) []string

GetStrings 获取配置

func GetSubNodes

func GetSubNodes(key string) map[string]any

GetSubNodes 获取所有子节点

func InitConfig

func InitConfig()

InitConfig 初始化配置文件

func NewEnvConfig

func NewEnvConfig() *envConfig

func NewYamlConfig

func NewYamlConfig(configFile string) *yamlConfig

func ParseConfig

func ParseConfig[TConfig any](key string) TConfig

ParseConfig 将配置转换成对象

func ParseConfigs

func ParseConfigs[TConfig any](key string) []TConfig

ParseConfigs 将配置转换成数组对象

func ParseString

func ParseString[TConfig any](configString string) TConfig

ParseString 解析字符串，转成配置对象

func SetDefault

func SetDefault(key string, value any)

SetDefault 设置配置的默认值

Types

type IConfigProvider

type IConfigProvider interface {
	// LoadConfigure 加载配置
	LoadConfigure() error
	// Get 读取配置
	Get(key string) (any, bool)
	// GetSubNodes 获取所有子节点
	GetSubNodes(key string) (map[string]any, bool)
	// GetArray 读取切片
	GetArray(key string) ([]any, bool)
	// Name 提供者名称
	Name() string
}