xenv

Documentation

Index

• Constants
• Variables
• func GetApolloCluster(cluster string) string
• func GetApolloNamespace(namespace string) string
• func GetApolloSecret() string
• func GetEnv(envName string) string
• func Init(userConf map[string]string)
• func IsDebug(v string) bool
• func IsDev() bool
• func IsLocal() bool
• func IsProd() bool
• func IsTest() bool
• func Parse(v interface{}, opts ...Options) error
• func ParseWithFuncs(v interface{}, funcMap map[reflect.Type]ParserFunc, opts ...Options) error
• type OnSetFn
• type Options
• type ParserFunc

Constants

const (
	AppEnv       = "APP_ENV"
	AppName      = "APP_NAME"
	AppVersion   = "APP_VERSION"
	TraceName    = "TRACE_NAME"
	ApolloUrl    = "APOLLO_URL"
	ApolloAppID  = "APOLLO_APPID"
	ApolloSecret = "APOLLO_ACCESS_KEY_SECRET"

	GrpcPort  = "GRPC_PORT"
	HttpPort  = "HTTP_PORT"
	PprofPort = "PPROF_PORT"
)

Variables

var (
	// ErrNotAStructPtr is returned if you pass something that is not a pointer to a
	// Struct to Parse.
	ErrNotAStructPtr = errors.New("env: expected a pointer to a Struct")
)

nolint: gochecknoglobals

Functions

func GetApolloCluster

func GetApolloCluster(cluster string) string

func GetApolloNamespace

func GetApolloNamespace(namespace string) string

func GetApolloSecret

func GetApolloSecret() string

func GetEnv

func GetEnv(envName string) string

func Init

func Init(userConf map[string]string)

Init 初始化环境配置 ENV > userConf > default

func IsDebug

func IsDebug(v string) bool

IsDebug 是否为debug模式

func IsDev

func IsDev() bool

func IsLocal

func IsLocal() bool

IsLocal 判断当前环境（环境主要用户切换配置，不可过度依赖）

func IsProd

func IsProd() bool

func IsTest

func IsTest() bool

func Parse

func Parse(v interface{}, opts ...Options) error

Parse parses a struct containing `env` tags and loads its values from environment variables.

func ParseWithFuncs

func ParseWithFuncs(v interface{}, funcMap map[reflect.Type]ParserFunc, opts ...Options) error

ParseWithFuncs is the same as `Parse` except it also allows the user to pass in custom parsers.

Types

type OnSetFn

type OnSetFn func(tag string, value interface{}, isDefault bool)

OnSetFn is a hook that can be run when a value is set.

type Options

type Options struct {
	// Environment keys and values that will be accessible for the service.
	Environment map[string]string

	// TagName specifies another tagname to use rather than the default env.
	TagName string

	// RequiredIfNoDef automatically sets all env as required if they do not declare 'envDefault'
	RequiredIfNoDef bool

	// OnSet allows to run a function when a value is set
	OnSet OnSetFn

	// Prefix define a prefix for each key
	Prefix string
	// contains filtered or unexported fields
}

Options for the parser.

type ParserFunc

type ParserFunc func(v string) (interface{}, error)

ParserFunc defines the signature of a function that can be used within `CustomParsers`.