xxversion

README

    APP_NAME=xxx
    APP_DOMAIN=googx.top
    BUILDTIME= `date +%s` 
    AUTHOR= ${USER}
    HOST= `uname -a` 
    # 需要判断git命令是否存在
    VERSION= `git tag --points-at HEAD`
    COMMITID= `git rev-parse HEAD`
    
    go build -ldflags=" \
    			-X 'github.com/googx/fcommons/app.appName=$(APP_NAME)' \
    			-X 'github.com/googx/fcommons/app.domain=$(APP_DOMAIN)' \
    			-X 'github.com/googx/fcommons/app.host=$(HOST)' \
    			-X 'github.com/googx/fcommons/app.version=$(VERSION)' \
    			-X 'github.com/googx/fcommons/app.commitId=${COMMITID}' \
    			-X 'github.com/googx/fcommons/app.buildTime=$(BUILDTIME)' \
        		-X 'github.com/googx/fcommons/app.author=${USER}' " \
    			-o $(APP_NAME) .
    

Documentation

Index

• func IsDebug() (ok bool)
• func IsDevelopment() (ok bool)
• func WithAppName(appname string) defaultAppEnv
• func WithAuthor(author string) defaultAppEnv
• func WithDescribe(desc string) defaultAppEnv
• func WithDomain(domain string) defaultAppEnv
• func WithEmail(email string) defaultAppEnv
• func WithRunMode(mode RunModel) defaultAppEnv
• func WithVersion(version string) defaultAppEnv
• type AppEnv
  • func AppInfo(defval ...defaultAppEnv) *AppEnv
  • func (ae AppEnv) FullAppName() string
  • func (ae AppEnv) IsDebug() bool
  • func (ae AppEnv) IsRelease() (envNote Environment, ok bool)
  • func (ae *AppEnv) SetRunModel(rm RunModel) error
  • func (ae *AppEnv) String() string
  • func (ae *AppEnv) VersionInfo() string
• type EnvType
• type Environment
  • func IsRelease() (envNote Environment, ok bool)
  • func ParseEnvironment(raw string) (env Environment)
  • func (e Environment) RawString() string
  • func (e Environment) String() string
• type RunModel

Functions

func IsDebug

func IsDebug() (ok bool)

是否是debug模式

func IsDevelopment

func IsDevelopment() (ok bool)

func WithAppName

func WithAppName(appname string) defaultAppEnv

func WithAuthor

func WithAuthor(author string) defaultAppEnv

func WithDescribe

func WithDescribe(desc string) defaultAppEnv

func WithDomain

func WithDomain(domain string) defaultAppEnv

func WithEmail

func WithEmail(email string) defaultAppEnv

func WithRunMode

func WithRunMode(mode RunModel) defaultAppEnv

func WithVersion

func WithVersion(version string) defaultAppEnv

Types

type AppEnv

type AppEnv struct {
	Version     string
	BuildTime   time.Time
	CommitId    string
	AppName     string
	Email       string
	Host        string
	HostUser    string
	Description string
	Author      string
	Domain      string
	Environment Environment // 环境备注信息
	BootTime    time.Time
	//
	RuntimeEnv appruntime.Env
	// contains filtered or unexported fields
}

func AppInfo

func AppInfo(defval ...defaultAppEnv) *AppEnv

当环境值为空时,自动使用的默认值

func (AppEnv) FullAppName

func (ae AppEnv) FullAppName() string

func (AppEnv) IsDebug

func (ae AppEnv) IsDebug() bool

func (AppEnv) IsRelease

func (ae AppEnv) IsRelease() (envNote Environment, ok bool)

根据编译参数判定是否是生产环境

func (*AppEnv) SetRunModel

func (ae *AppEnv) SetRunModel(rm RunModel) error

func (*AppEnv) String

func (ae *AppEnv) String() string

func (*AppEnv) VersionInfo

func (ae *AppEnv) VersionInfo() string

type EnvType

type EnvType byte

const (
	Unknow  EnvType = iota // 未初始化
	Develop                // 开发版本
	Test                   // 测试版本
	Release                // 正式版本
)

type Environment

type Environment struct {
	EnvType EnvType
	// contains filtered or unexported fields
}

func IsRelease

func IsRelease() (envNote Environment, ok bool)

是否是生产环境 如果production信息非空就判定为生产环境 如果为空,但是相关的编译参数为非空也判定为生产环境

func ParseEnvironment

func ParseEnvironment(raw string) (env Environment)

func (Environment) RawString

func (e Environment) RawString() string

func (Environment) String

func (e Environment) String() string

type RunModel

type RunModel uint8

const (
	Normal RunModel = iota
	Debug
)