config

README

wgs.ths.config.go

介绍

go实现环境通用的配置加载聚合组件.

软件架构

软件架构说明

安装教程

1. xxxx
2. xxxx
3. xxxx

使用说明

1. xxxx
2. xxxx
3. xxxx

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/

Documentation

Index

• Variables
• type Config
• type ConfigDesc
  • func NewConfigDesc() *ConfigDesc
• type Context
  • func NewContext() *Context
  • func (ctx *Context) GetRender(name string) Renderer
  • func (ctx *Context) RegisterConfig(path string, c Config) *ConfigDesc
  • func (ctx *Context) RegisterRenderer(r Renderer)
  • func (ctx *Context) RegisterRootConfig(c Config) *ConfigDesc
  • func (ctx *Context) Render(r Renderer) error
  • func (ctx *Context) RenderConfig() error
  • func (ctx *Context) Root() *ConfigDesc
• type FlagLookupFunc
• type IConfigDefault
• type Renderer
• type RendererDefault
  • func NewRendererDefault(sort int) *RendererDefault
  • func (r *RendererDefault) Name() string
  • func (r *RendererDefault) Render(body reflect.Value, desc *ConfigDesc) error
  • func (r *RendererDefault) Sort() int
• type RendererEnv
  • func NewRendererEnv(sort int) *RendererEnv
  • func (r *RendererEnv) BindEnv(path string, env string)
  • func (r *RendererEnv) Name() string
  • func (r *RendererEnv) Render(body reflect.Value, desc *ConfigDesc) error
  • func (r *RendererEnv) Sort() int
• type RendererFile
  • func NewRendererFile(sort int) *RendererFile
  • func (r *RendererFile) ConfigFilepath(fp string)
  • func (r *RendererFile) ConfigFilepaths(arr []string)
  • func (r *RendererFile) Filepaths() []string
  • func (r *RendererFile) Name() string
  • func (r *RendererFile) Render(body reflect.Value, desc *ConfigDesc) error
  • func (r *RendererFile) Sort() int
• type RendererFlag
  • func NewRendererFlag(sort int) *RendererFlag
  • func (r *RendererFlag) BindFlag(cfgPath, cmdPath, flagName string)
  • func (r *RendererFlag) Name() string
  • func (r *RendererFlag) Render(body reflect.Value, desc *ConfigDesc) error
  • func (r *RendererFlag) SetLookupFunc(lookup FlagLookupFunc)
  • func (r *RendererFlag) Sort() int

Variables

var (
	GlobalRendererDefault = NewRendererDefault(0)
	GlobalRendererFile    = NewRendererFile(1)
	GlobalRendererEnv     = NewRendererEnv(2)
	GlobalRendererFlag    = NewRendererFlag(3)
)

var DefaultContext = NewContext()

var (
	ValueTypeOfConfig = reflect.TypeOf((*Config)(nil)).Elem()
)

Types

type Config

type Config interface {
	Name() string
}

type ConfigDesc

type ConfigDesc struct {
	Type reflect.Type

	Children    map[string]*ConfigDesc
	ChildrenMap map[string]map[string]*ConfigDesc
}

func NewConfigDesc

func NewConfigDesc() *ConfigDesc

type Context

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

func NewContext

func NewContext() *Context

func (*Context) GetRender

func (ctx *Context) GetRender(name string) Renderer

func (*Context) RegisterConfig

func (ctx *Context) RegisterConfig(path string, c Config) *ConfigDesc

func (*Context) RegisterRenderer

func (ctx *Context) RegisterRenderer(r Renderer)

func (*Context) RegisterRootConfig

func (ctx *Context) RegisterRootConfig(c Config) *ConfigDesc

func (*Context) Render

func (ctx *Context) Render(r Renderer) error

func (*Context) RenderConfig

func (ctx *Context) RenderConfig() error

func (*Context) Root

func (ctx *Context) Root() *ConfigDesc

type FlagLookupFunc

type FlagLookupFunc func(cmdPath string, flagName string) (string, bool)

type IConfigDefault

type IConfigDefault interface {
	ToDefault(body IConfigDefault)
}

type Renderer

type Renderer interface {
	Name() string
	Sort() int
	Render(body reflect.Value, desc *ConfigDesc) error
}

type RendererDefault

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

func NewRendererDefault

func NewRendererDefault(sort int) *RendererDefault

func (*RendererDefault) Name

func (r *RendererDefault) Name() string

func (*RendererDefault) Render

func (r *RendererDefault) Render(body reflect.Value, desc *ConfigDesc) error

func (*RendererDefault) Sort

func (r *RendererDefault) Sort() int

type RendererEnv

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

func NewRendererEnv

func NewRendererEnv(sort int) *RendererEnv

func (*RendererEnv) BindEnv

func (r *RendererEnv) BindEnv(path string, env string)

func (*RendererEnv) Name

func (r *RendererEnv) Name() string

func (*RendererEnv) Render

func (r *RendererEnv) Render(body reflect.Value, desc *ConfigDesc) error

func (*RendererEnv) Sort

func (r *RendererEnv) Sort() int

type RendererFile

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

func NewRendererFile

func NewRendererFile(sort int) *RendererFile

func (*RendererFile) ConfigFilepath

func (r *RendererFile) ConfigFilepath(fp string)

func (*RendererFile) ConfigFilepaths

func (r *RendererFile) ConfigFilepaths(arr []string)

func (*RendererFile) Filepaths

func (r *RendererFile) Filepaths() []string

func (*RendererFile) Name

func (r *RendererFile) Name() string

func (*RendererFile) Render

func (r *RendererFile) Render(body reflect.Value, desc *ConfigDesc) error

func (*RendererFile) Sort

func (r *RendererFile) Sort() int

type RendererFlag

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

func NewRendererFlag

func NewRendererFlag(sort int) *RendererFlag

func (*RendererFlag) BindFlag

func (r *RendererFlag) BindFlag(cfgPath, cmdPath, flagName string)

func (*RendererFlag) Name

func (r *RendererFlag) Name() string

func (*RendererFlag) Render

func (r *RendererFlag) Render(body reflect.Value, desc *ConfigDesc) error

func (*RendererFlag) SetLookupFunc

func (r *RendererFlag) SetLookupFunc(lookup FlagLookupFunc)

func (*RendererFlag) Sort

func (r *RendererFlag) Sort() int