configuares

README

概要

配置工具

特性

• 开放：可根据实际情况进行额外扩展。
• 多环境支持：指定激活的配置文件，并合并进根配置。
• 多配置语言：当前支持 JSON 与 YAML 。

安装

go get github.com/aacfactory/configuares

使用

path, err := filepath.Abs("./_example/json")
if err != nil {
    // handle error
    return
}

// 构建配置存储器
store := configuares.NewFileStore(path, "app", '.')

// 构建配置读取器
retriever, retrieverErr := configuares.NewRetriever(configuares.RetrieverOption{
    Active: "dev",
    Format: "JSON",
    Store:  store,
})

if retrieverErr != nil {
    // handle error
    return
}

// 获取配置内容
config, configErr := retriever.Get()
if configErr != nil {
    // handle error
    return
}

Documentation

Index

• type Config
  • func NewJsonConfig(raw []byte) (v Config, err error)
  • func NewYamlConfig(raw []byte) (v Config, err error)
• type FileStore
  • func (store *FileStore) Read() (root []byte, subs map[string][]byte, err error)
• type Raw
  • func (r Raw) As(v interface{}) (err error)
  • func (r Raw) MarshalJSON() ([]byte, error)
  • func (r *Raw) UnmarshalJSON(data []byte) error
• type Retriever
  • func NewRetriever(option RetrieverOption) (retriever *Retriever, err error)
  • func (retriever *Retriever) Get() (v Config, err error)
• type RetrieverOption
• type Store
  • func NewFileStore(configPath string, prefix string, splitter byte) Store

Types

type Config

type Config interface {
	Raw() []byte
	As(v interface{}) (err error)
	Get(path string, v interface{}) (has bool, err error)
	Node(path string) (v Config, has bool)
}

func NewJsonConfig

func NewJsonConfig(raw []byte) (v Config, err error)

func NewYamlConfig

func NewYamlConfig(raw []byte) (v Config, err error)

type FileStore

type FileStore struct {
	// contains filtered or unexported fields
}

func (*FileStore) Read

func (store *FileStore) Read() (root []byte, subs map[string][]byte, err error)

type Raw

type Raw json.RawMessage

func (Raw) As

func (r Raw) As(v interface{}) (err error)

func (Raw) MarshalJSON

func (r Raw) MarshalJSON() ([]byte, error)

func (*Raw) UnmarshalJSON

func (r *Raw) UnmarshalJSON(data []byte) error

type Retriever

type Retriever struct {
	// contains filtered or unexported fields
}

func NewRetriever

func NewRetriever(option RetrieverOption) (retriever *Retriever, err error)

func (*Retriever) Get

func (retriever *Retriever) Get() (v Config, err error)

type RetrieverOption

type RetrieverOption struct {
	Active string
	Format string
	Store  Store
}

type Store

type Store interface {
	Read() (root []byte, subs map[string][]byte, err error)
}

func NewFileStore

func NewFileStore(configPath string, prefix string, splitter byte) Store