env

Documentation

Index

• Constants
• Variables
• func AppName() string
• func ConfigDirPath() string
• func LocalIPV4() string
• func RootPath() string
• func RunMode() string
• func TimeLocation() *time.Location
• type AppEnv
  • func New(opt Option) AppEnv
• type AppNameEnv
• type Option
• type RunModeEnv

Constants

const (
	// RunModeDebug 调试
	RunModeDebug = "debug"

	// RunModeTest 测试
	RunModeTest = "test"

	// RunModeRelease 线上发布
	RunModeRelease = "release"
)

可以依据不同的运行等级来开启不同的调试功能、接口

Variables

var Default = New(Option{})

Default (全局)默认的环境信息

全局的 RootDir() 、DataDir() 等方法均使用该环境信息

Functions

func AppName

func AppName() string

AppName (全局)应用的名称

func ConfigDirPath

func ConfigDirPath() string

func LocalIPV4

func LocalIPV4() string

func RootPath

func RootPath() string

func RunMode

func RunMode() string

RunMode (全局) 程序运行等级 返回值 release 、test 、debug 之一 只能设置 'debug'、'test'、'release' 之一, 若是其他值，默认值会是 'debug'

func TimeLocation

func TimeLocation() *time.Location

Types

type AppEnv

type AppEnv interface {
	// AppNameEnv 应用名称
	AppNameEnv

	// RunModeEnv 应用运行情况
	RunModeEnv

	RootPath() string

	LocalIPV4() string

	TimeLocation() *time.Location

	ConfigDirPath() string
}

AppEnv 应用环境信息完整的接口定义

func New

func New(opt Option) AppEnv

type AppNameEnv

type AppNameEnv interface {
	AppName() string
}

AppNameEnv 应用名称

type Option

type Option struct {
	// AppName 应用名称
	AppName string

	// RunMode 运行模式
	RunMode string

	TimeLocation string

	ConfigDirName string
}

Option 具体的环境信息

所有的选项都是可选的

type RunModeEnv

type RunModeEnv interface {
	RunMode() string
}

RunModeEnv 运行模式/等级