config

README

测试用例：

import (
	"fmt"
	"testing"
	
	"github.com/jerry-struggle/admin-core/config"
	"github.com/jerry-struggle/admin-core/config/source/file"
)

func TestApp(t *testing.T)  {
	c, err := config.NewConfig()
	if err != nil {
		t.Error(err)
	}
	err = c.Load(file.NewSource(file.WithPath("config/settings.yml")))
	if err != nil {
		t.Error(err)
	}
	fmt.Println(c.Map())
}

Documentation

Overview

Package config is an interface for dynamic configuration.

Index

• func Bytes() []byte
• func Get(path ...string) reader.Value
• func Load(source ...source.Source) error
• func LoadFile(path string) error
• func Map() map[string]interface{}
• func Scan(v interface{}) error
• func Sync() error
• type Config
  • func NewConfig(opts ...Option) (Config, error)
• type Entity
• type Option
  • func WithEntity(e Entity) Option
  • func WithLoader(l loader.Loader) Option
  • func WithReader(r reader.Reader) Option
  • func WithSource(s source.Source) Option
• type Options
• type Watcher
  • func Watch(path ...string) (Watcher, error)

Functions

func Bytes

func Bytes() []byte

Bytes Return config as raw json

func Get

func Get(path ...string) reader.Value

Get a value from the config

func Load

func Load(source ...source.Source) error

Load config sources

func LoadFile

func LoadFile(path string) error

LoadFile is short hand for creating a file source and loading it

func Map

func Map() map[string]interface{}

Map Return config as a map

func Scan

func Scan(v interface{}) error

Scan values to a go type

func Sync

func Sync() error

Sync Force a source changeset sync

Types

type Config

type Config interface {
	// Values provide the reader.Values interface
	reader.Values
	// Init the config
	Init(opts ...Option) error
	// Options in the config
	Options() Options
	// Close Stop the config loader/watcher
	Close() error
	// Load config sources
	Load(source ...source.Source) error
	// Sync Force a source changeset sync
	Sync() error
	// Watch a value for changes
	Watch(path ...string) (Watcher, error)
}

Config is an interface abstraction for dynamic configuration

var (
	// DefaultConfig Default Config Manager
	DefaultConfig Config
)

func NewConfig

func NewConfig(opts ...Option) (Config, error)

NewConfig returns new config

type Entity

type Entity interface {
	OnChange()
}

Entity 配置实体

type Option

type Option func(o *Options)

Option 调用类型

func WithEntity

func WithEntity(e Entity) Option

WithEntity sets the config Entity

func WithLoader

func WithLoader(l loader.Loader) Option

WithLoader sets the loader for manager config

func WithReader

func WithReader(r reader.Reader) Option

WithReader sets the config reader

func WithSource

func WithSource(s source.Source) Option

WithSource appends a source to list of sources

type Options

type Options struct {
	Loader loader.Loader
	Reader reader.Reader
	Source []source.Source

	// for alternative data
	Context context.Context

	Entity Entity
}

Options 配置的参数

type Watcher

type Watcher interface {
	Next() (reader.Value, error)
	Stop() error
}

Watcher is the config watcher

func Watch

func Watch(path ...string) (Watcher, error)

Watch a value for changes