config

Documentation

Index

• Constants
• Variables
• func FileNameInAppDataPath(name string) string
• func FileNameInAppDataPathV2(name string) string
• func FileNameInConfAppPath(name string) string
• func FileNameInConfPath(name string) string
• func FileNameInDataPath(name string) string
• func FileNameInEnvDataPath(name string) string
• func FileNameInEnvPath(name string) string
• func FileNameWithEnvInConfAppPath(name string) string
• func FileNameWithEnvInDataPath(name string) string
• func FileNameWithoutEnvInConfAppPath(name string) string
• func FileNameWithoutEnvInEnvPath(name string) string
• func GetAppDataPath() string
• func GetAppDataPathV2() string
• func GetConfAppPath() string
• func GetConfPath() string
• func GetDataPath() string
• func GetEnvPath() string
• func GetExecPath() string
• func IsDefaultDataPath() bool
• func IsDevEnvironment() bool
• func IsProdEnvironment() bool
• func IsTestEnvironment() bool
• func MainFileName() string
• func UseAppDataPathV2()
• func UseAppDataVersion(ver int)
• func WithEnv(name string) string
• type Config
  • func (c *Config) Init(opts ...Option)
• type HandlerFunc
• type Option
  • func WithAppConfPath(p string) Option
  • func WithAppDataPath(p string) Option
  • func WithAppDataPathV2(p string) Option
  • func WithDataPath(p string) Option
  • func WithWorkDir(dir string) Option

Constants

const (
	EProd = "prod"
	ETest = "test"
	EDev  = "dev"
)

const (
	KForever  = "forever"
	KDaemon   = "daemon"
	KPprof    = "pprof"
	KPath     = "path"
	KEnv      = "env"
	KConf     = "conf"
	KDataPath = "dataPath"
	KAppId    = "appid"
)

Variables

var (
	Version  = "1.0.0"
	AppName  = "unknown"
	AppAlias = "" //别名，example 某某公司的某某应用
	AppId    string
	SeqId    int64 = 0
	Source   string
	Env      = EDev
	WorkDir  string
	MainConf string
	DataPath string //程序存储数据
	Daemon   bool
	Forever  bool
	Pprof    bool
)

var RegisterConfig func(ty string, handler HandlerFunc)

var UnRegisterConfig func(ty string)

Functions

func FileNameInAppDataPath

func FileNameInAppDataPath(name string) string

FileNameInAppDataPath conf/ "{workdir}/name" 或 {workdir}/app/name

func FileNameInAppDataPathV2

func FileNameInAppDataPathV2(name string) string

FileNameInAppDataPathV2 conf/ "{workdir}/app/name"

func FileNameInConfAppPath

func FileNameInConfAppPath(name string) string

FileNameInConfAppPath conf/appName 不带env "conf/{appName}/name"

func FileNameInConfPath

func FileNameInConfPath(name string) string

FileNameInConfPath conf/ "confPath/name"

func FileNameInDataPath

func FileNameInDataPath(name string) string

FileNameInDataPath conf/ 目录下 "{DataPath}/name"

func FileNameInEnvDataPath

func FileNameInEnvDataPath(name string) string

FileNameInEnvDataPath conf/ 目录下 "{DataPath}/{Env}/name"

func FileNameInEnvPath

func FileNameInEnvPath(name string) string

FileNameInEnvPath env/{Env}/name

func FileNameWithEnvInConfAppPath

func FileNameWithEnvInConfAppPath(name string) string

FileNameWithEnvInConfAppPath conf/appName 带env "conf/{appName}/{Env}.name"

func FileNameWithEnvInDataPath

func FileNameWithEnvInDataPath(name string) string

FileNameWithEnvInDataPath conf/ 目录下 "{DataPath}/{Env}.name"

func FileNameWithoutEnvInConfAppPath

func FileNameWithoutEnvInConfAppPath(name string) string

FileNameWithoutEnvInConfAppPath Deprecated: this function simply calls FileNameInConfAppPath.

func FileNameWithoutEnvInEnvPath

func FileNameWithoutEnvInEnvPath(name string) string

FileNameWithoutEnvInEnvPath env/name

func GetAppDataPath

func GetAppDataPath() string

GetAppDataPath 程序运行数据目录,如views,docs

func GetAppDataPathV2

func GetAppDataPathV2() string

func GetConfAppPath

func GetConfAppPath() string

GetConfAppPath ./conf/appName

func GetConfPath

func GetConfPath() string

GetConfPath ./conf

func GetDataPath

func GetDataPath() string

GetDataPath 业务定义存储路径

func GetEnvPath

func GetEnvPath() string

func GetExecPath

func GetExecPath() string

func IsDefaultDataPath

func IsDefaultDataPath() bool

func IsDevEnvironment

func IsDevEnvironment() bool

func IsProdEnvironment

func IsProdEnvironment() bool

func IsTestEnvironment

func IsTestEnvironment() bool

func MainFileName

func MainFileName() string

MainFileName env.main.json 全路径文件名

func UseAppDataPathV2

func UseAppDataPathV2()

func UseAppDataVersion

func UseAppDataVersion(ver int)

func WithEnv

func WithEnv(name string) string

WithEnv 与env组合

Types

type Config

type Config struct {
	Mode           string `json:"mode" yaml:"mode" xml:"mode"`
	Server         string `json:"server" yaml:"server" xml:"server"`
	PubIP          string `json:"publicIp" yaml:"publicIp" xml:"publicIp"`
	AppDataVersion int    `json:"appDataVersion" yaml:"appDataVersion" xml:"appDataVersion"`
	EnabledRedis   bool   `json:"enabledRedis" yaml:"enabledRedis" xml:"enabledRedis"`
	EnabledDb      bool   `json:"enabledDb" yaml:"enabledDb" xml:"enabledDb"`
	EnabledEs      bool   `json:"enabledEs" yaml:"enabledEs" xml:"enabledEs"`
	EnabledMQ      bool   `json:"enabledMQ" yaml:"enabledMQ" xml:"enabledMQ"`
	// contains filtered or unexported fields
}

func (*Config) Init

func (c *Config) Init(opts ...Option)

type HandlerFunc

type HandlerFunc func(ctx context.Context, cmd int, configType, config string) (any, error)

type Option

type Option func(c *Config)

func WithAppConfPath

func WithAppConfPath(p string) Option

func WithAppDataPath

func WithAppDataPath(p string) Option

func WithAppDataPathV2

func WithAppDataPathV2(p string) Option

func WithDataPath

func WithDataPath(p string) Option

func WithWorkDir

func WithWorkDir(dir string) Option