config

Documentation

Index

• Variables
• func GetConfigName(cfg Config) string
• func Register(factory Factory)
• type Config
  • func New(opts ...Option) Config
• type Decoder
• type Factory
• type KeyValue
• type Observer
• type Option
  • func WithDecoder(d Decoder) Option
  • func WithLogger(l log.Logger) Option
  • func WithResolver(r Resolver) Option
  • func WithSource(s ...Source) Option
• type Reader
• type Resolver
• type Source
  • func GetConfig(cfg Config) (Source, error)
  • func NewStrSource(content string) Source
• type Value
• type Watcher

Variables

var ErrorUnchanged = errors.New("data not changed")

Functions

func GetConfigName

func GetConfigName(cfg Config) string

func Register

func Register(factory Factory)

Register 添加注册中心工厂对象

Types

type Config

type Config interface {
	Load() error
	Source(sources ...Source) error
	Scan(v interface{}) error
	Value(key string) Value
	Watch(key string, o Observer) error
	Close() error
	Get(key string) Config
	Root() Config
}

Config is a config interface.

func New

func New(opts ...Option) Config

New new a config with options.

type Decoder

type Decoder func(*KeyValue, map[string]interface{}) error

Decoder is config decoder.

type Factory

type Factory interface {
	Name() string
	Create(Config) (Source, error)
}

IFactory 注册中心构建器

type KeyValue

type KeyValue struct {
	Key    string
	Value  []byte
	Format string
}

KeyValue is config key value.

type Observer

type Observer func(string, Value)

Observer is config observer.

type Option

type Option func(*options)

Option is config option.

func WithDecoder

func WithDecoder(d Decoder) Option

WithDecoder with config decoder. DefaultDecoder behavior: If KeyValue.Format is non-empty, then KeyValue.Value will be deserialized into map[string]interface{} and stored in the config cache(map[string]interface{}) if KeyValue.Format is empty,{KeyValue.Key : KeyValue.Value} will be stored in config cache(map[string]interface{})

func WithLogger

func WithLogger(l log.Logger) Option

WithLogger with config logger.

func WithResolver

func WithResolver(r Resolver) Option

WithResolver with config resolver.

func WithSource

func WithSource(s ...Source) Option

WithSource with config source.

type Reader

type Reader interface {
	Merge(...*KeyValue) error
	Value(string) (Value, bool)
	Source() ([]byte, error)
	Resolve() error
}

Reader is config reader.

type Resolver

type Resolver func(map[string]interface{}) error

Resolver resolve placeholder in config.

type Source

type Source interface {
	Name() string
	Load() ([]*KeyValue, error)
	Watch() (Watcher, error)
}

Source is config source.

func GetConfig

func GetConfig(cfg Config) (Source, error)

func NewStrSource

func NewStrSource(content string) Source

NewSource new a file source.

type Value

type Value interface {
	Bool() (bool, error)
	Int() (int64, error)
	Float() (float64, error)
	String() string
	Duration() (time.Duration, error)
	Slice() ([]Value, error)
	Map() (map[string]Value, error)
	Scan(interface{}) error
	Load() interface{}
	Store(interface{})
	Exists() bool
}

Value is config value interface.

type Watcher

type Watcher interface {
	Next() ([]*KeyValue, error)
	Stop() error
}

Watcher watches a source for changes.