cfg

README

一个简单的 toml/yaml 配置读取包

这是一个非常简单的配置读取包，功能非常单一，使用非常简单；

安装

gitee.com/zhucheer/cfg

使用

cfgHandler, _ := cfg.New("./config.toml") //设置配置文件地址
value := cfgHandler.GetInt("database.connection_max") //读取toml配置节点

Nacos 支持

1.首先，我们需要在项目中初始化 Nacos Client。

clientConfig := *constant.NewClientConfig(
		constant.WithNotLoadCacheAtStart(true),
		constant.WithLogDir("./nacos/log"),
		constant.WithCacheDir("./nacos/cache"),
		constant.WithRotateTime("1h"),
		constant.WithMaxAge(6),
		constant.WithLogLevel("info"),
		constant.WithNamespaceId(""),
		constant.WithUsername(),
		constant.WithPassword()
	)
	configClient, _ := clients.NewConfigClient(
		vo.NacosClientParam{
			ClientConfig: &clientConfig,
			ServerConfigs: []constant.ServerConfig{
				{
					IpAddr:      "106.55.145.120",
					ContextPath: "/nacos",
					Port:        8848,
					Scheme:      "http",
				},
			},
		},
	)

// clientConfig，configClient可以配置成全局变量，在需要使用nacos的地方直接调用

2.将nacos配置实例化到cfg包的handler

    handler := NewNacos(&NacosBase{
		ConfigClient: configClient,
		GroupId:      "orange10",
		DataId:       "config.toml",
	})

	key := handler2.GetString("app.name")

Documentation

Index

• type Handler
  • func New(filePath string) *Handler
  • func NewFile(filePath string, dynamic bool) *Handler
  • func NewNacos(baseInfo *NacosBase) *Handler
  • func NewTomlData(content string) *Handler
  • func NewYamlData(content string) *Handler
  • func ReloadTomlData(content string) (*Handler, error)
  • func ReloadYamlData(content string) (*Handler, error)
  • func (c *Handler) Exists(parse string) bool
  • func (c *Handler) GetBool(key string) bool
  • func (c *Handler) GetDuration(key string) time.Duration
  • func (c *Handler) GetInt(key string) int
  • func (c *Handler) GetInt64(key string) int64
  • func (c *Handler) GetMap(parse string) map[string]interface{}
  • func (c *Handler) GetSliceInt(key string) []int
  • func (c *Handler) GetSliceInt64(key string) []int64
  • func (c *Handler) GetSliceString(key string) []string
  • func (c *Handler) GetString(key string) string
  • func (c *Handler) ParseNode(parse string) (ret interface{})
  • func (c *Handler) ReloadFile() *Handler
  • func (c *Handler) StartDynamic() *Handler
  • func (c *Handler) UnmarshalKey(key string, rawVal interface{}) error
• type NacosBase

Types

type Handler

type Handler struct {
	Source   string
	ConfType string
	// contains filtered or unexported fields
}

配置对象

func New

func New(filePath string) *Handler

New default get a cfg handler by file path and not open dynamic

func NewFile

func NewFile(filePath string, dynamic bool) *Handler

NewFile get a cfg handler by file path

func NewNacos

func NewNacos(baseInfo *NacosBase) *Handler

NewNacosData get a cfg handler by toml string content nacos目前没有toml支持，暂时统一使用yaml格式

func NewTomlData

func NewTomlData(content string) *Handler

NewTomlData get a cfg handler by toml string content

func NewYamlData

func NewYamlData(content string) *Handler

NewTomlData get a cfg handler by toml string content

func ReloadTomlData

func ReloadTomlData(content string) (*Handler, error)

ReloadTomlData get a cfg handler by toml string content

func ReloadYamlData

func ReloadYamlData(content string) (*Handler, error)

ReloadYamlData get a cfg handler by toml string content

func (*Handler) Exists

func (c *Handler) Exists(parse string) bool

Exists find config node exists

func (*Handler) GetBool

func (c *Handler) GetBool(key string) bool

GetBool get config bool type

func (*Handler) GetDuration

func (c *Handler) GetDuration(key string) time.Duration

GetDuration get config time.Duration type

func (*Handler) GetInt

func (c *Handler) GetInt(key string) int

GetInt get config int type

func (*Handler) GetInt64

func (c *Handler) GetInt64(key string) int64

GetInt64 get config int64 type

func (*Handler) GetMap

func (c *Handler) GetMap(parse string) map[string]interface{}

GetMap parse config node to map

func (*Handler) GetSliceInt

func (c *Handler) GetSliceInt(key string) []int

GetSliceInt get slice int type

func (*Handler) GetSliceInt64

func (c *Handler) GetSliceInt64(key string) []int64

GetSliceInt64 get slice int64 type

func (*Handler) GetSliceString

func (c *Handler) GetSliceString(key string) []string

GetSliceString get slice string type

func (*Handler) GetString

func (c *Handler) GetString(key string) string

GetString get config string type

func (*Handler) ParseNode

func (c *Handler) ParseNode(parse string) (ret interface{})

ParseNode parse config node

func (*Handler) ReloadFile

func (c *Handler) ReloadFile() *Handler

ReloadFile get a cfg handler by file path reload config

func (*Handler) StartDynamic

func (c *Handler) StartDynamic() *Handler

StartDynamic after start listen config file change

func (*Handler) UnmarshalKey

func (c *Handler) UnmarshalKey(key string, rawVal interface{}) error

UnmarshalKey Unmarshal config to struct

type NacosBase

type NacosBase struct {
	ConfigClient config_client.IConfigClient
	GroupId      string
	DataId       string
}