gsf

README

gsf-core

web config json

{
  "ip" : "0.0.0.0",
  "port" : 9902,
  "timeout": {
    "read" : 5,
    "write" : 5,
    "idle" : 10
  }
}

命令行参数

--app-env value      env(local-本地环境, test-测试环境, preview-预发布环境, release-线上环境) (default: "local")
--app-version value  version (default: "1.0.0")
--app-log-more       log more (default: false)
--app-cmd value      cmd

Documentation

Index

• Constants
• Variables
• func SetEnvDesc(env int, key, desc string) bool
• type AppConfig
  • func (v *AppConfig) Env() int
  • func (v *AppConfig) EnvDesc() string
  • func (v *AppConfig) ExecDir() string
  • func (v *AppConfig) LogMore() bool
  • func (v *AppConfig) SetEnv(e int) bool
  • func (v *AppConfig) Version() string
• type Application
  • func (app *Application) Start(cmd *cli.App, args []string, service Service)
• type CmdFunc
• type Component
• type Service
• type TestCmdService
  • func (c *TestCmdService) AddCmdHandle(name string, handle CmdFunc) *TestCmdService
  • func (c *TestCmdService) CliFlags() []cli.Flag
  • func (c *TestCmdService) Close()
  • func (c *TestCmdService) Init(cfg *AppConfig, _ *cli.Context) (logger.Interface, error)
  • func (c *TestCmdService) Run(l logger.Interface, _ *AppConfig) error
• type TestWebService
  • func (c *TestWebService) CliFlags() []cli.Flag
  • func (c *TestWebService) Close()
  • func (c *TestWebService) Init(cfg *AppConfig, _ *cli.Context) (logger.Interface, error)
  • func (c *TestWebService) Run(l logger.Interface, _ *AppConfig) error
• type WebConfig

Constants

const (
	EnvDev  = 0 // 本地
	EnvTest = 1 // 测试
	EnvPrev = 2 // 预发布
	EnvProd = 3 // 线上

	CliAppEnv     = "app-env"
	CliAppVer     = "app-version"
	CliAppLogMore = "app-log-more"
)

const (
	CliWebIP           = "web-ip"
	CliWebPort         = "web-port"
	CliWebReadTimeout  = "web-r-timeout"
	CliWebWriteTimeout = "web-w-timeout"
	CliWebIdleTimeout  = "web-idle-timeout"
)

const (
	CliAppCmd = "app-cmd"
)

Variables

var (
	AppCmdNoFind = errors.New(" Command No Find")
)

var (
	EnvVersion = "1.0.0"
)

Functions

func SetEnvDesc

func SetEnvDesc(env int, key, desc string) bool

Types

type AppConfig

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

func (*AppConfig) Env

func (v *AppConfig) Env() int

func (*AppConfig) EnvDesc

func (v *AppConfig) EnvDesc() string

func (*AppConfig) ExecDir

func (v *AppConfig) ExecDir() string

func (*AppConfig) LogMore

func (v *AppConfig) LogMore() bool

func (*AppConfig) SetEnv

func (v *AppConfig) SetEnv(e int) bool

func (*AppConfig) Version

func (v *AppConfig) Version() string

type Application

type Application struct {
	Component map[string]Component
	Log       logger.Interface
	Cfg       AppConfig
	Ser       Service
}

func (*Application) Start

func (app *Application) Start(cmd *cli.App, args []string, service Service)

type CmdFunc

type CmdFunc func(logger.Interface) error

type Component

type Component interface {
	CliFlags() []cli.Flag
	Init(logger.Interface, *AppConfig, *cli.Context) error
	Run() error
	Close() error
}

type Service

type Service interface {
	CliFlags() []cli.Flag
	Init(*AppConfig, *cli.Context) (logger.Interface, error)
	Run(logger.Interface, *AppConfig) error
	Close()
}

type TestCmdService

type TestCmdService struct {
	Router map[string]CmdFunc
	// contains filtered or unexported fields
}

func (*TestCmdService) AddCmdHandle

func (c *TestCmdService) AddCmdHandle(name string, handle CmdFunc) *TestCmdService

func (*TestCmdService) CliFlags

func (c *TestCmdService) CliFlags() []cli.Flag

func (*TestCmdService) Close

func (c *TestCmdService) Close()

func (*TestCmdService) Init

func (c *TestCmdService) Init(cfg *AppConfig, _ *cli.Context) (logger.Interface, error)

func (*TestCmdService) Run

func (c *TestCmdService) Run(l logger.Interface, _ *AppConfig) error

type TestWebService

type TestWebService struct {
	Handle http.Handler
	// contains filtered or unexported fields
}

func (*TestWebService) CliFlags

func (c *TestWebService) CliFlags() []cli.Flag

func (*TestWebService) Close

func (c *TestWebService) Close()

func (*TestWebService) Init

func (c *TestWebService) Init(cfg *AppConfig, _ *cli.Context) (logger.Interface, error)

func (*TestWebService) Run

func (c *TestWebService) Run(l logger.Interface, _ *AppConfig) error

type WebConfig

type WebConfig struct {
	IP      string `json:"ip"   yaml:"ip"`
	Port    int    `json:"port" yaml:"port"`
	Timeout struct {
		Read  int `json:"read"  yaml:"read"`
		Write int `json:"write" yaml:"write"`
		Idle  int `json:"idle"  yaml:"idle"`
	} `json:"timeout" yaml:"timeout"`
}