service

Documentation

Index

• Variables
• func ListenAndServe(s *grpc.Server, addr string)
• func NewRedisClient(cfg config.RedisConfig) *redis.Client
• func NewXormEngine(mysql config.MysqlInstance, logWriter io.Writer, idle, open int, ...) (*xorm.Engine, error)
• type App
  • func NewApp() App
  • func (app *App) DefaultLogger() util.Logger
  • func (app *App) Get(key string) interface{}
  • func (app *App) GetConfig() *cfg.AppConfig
  • func (app *App) GetHook(ht HookType) *[]HookFunc
  • func (app *App) Initialize()
  • func (app *App) Inject(object interface{}) error
  • func (app *App) LoadConfig(mode string) *cfg.AppConfig
  • func (app *App) Logger(name string) (util.Logger, error)
  • func (app *App) RegisterHook(ht HookType, hooks ...HookFunc)
  • func (app *App) Set(key string, object interface{}, ifacePtr interface{})
  • func (app *App) SetConfig(config *cfg.AppConfig)
  • func (app *App) SetLogger(name string, logger util.Logger)
• type Application
• type GrpcApp
  • func NewGrpcApp(s *grpc.Server) *GrpcApp
  • func (app *GrpcApp) GetServer() *grpc.Server
  • func (app *GrpcApp) Initialize()
  • func (app *GrpcApp) ListenAndServe()
  • func (app *GrpcApp) SetServer(s *grpc.Server)
• type GrpcApplication
• type HookFunc
• type HookType
• type MysqlManager
  • func NewMysqlManager(app Application, config config.MysqlConfig) (*MysqlManager, error)
  • func (mm *MysqlManager) DB(name string) *xorm.Engine
  • func (mm *MysqlManager) R() *xorm.Engine
  • func (mm *MysqlManager) SetDB(name string, engine *xorm.Engine) bool
  • func (mm *MysqlManager) W() *xorm.Engine
• type WebApp
  • func NewWebApp() *WebApp
  • func (app *WebApp) GetRouter() *echo.Echo
  • func (app *WebApp) Initialize()
  • func (app *WebApp) ListenAndServe()
  • func (app *WebApp) SetRouter(r *echo.Echo)
• type WebApplication

Variables

var (
	// AppMode is App's running envirenment. Valid values are dev and prod
	AppMode string
	// ConfigFile is the absolute path of config file
	ConfigFile string
	// LogPath is where log file will be
	LogPath string
)

var (
	// MySQLMaxIdle of connection
	MySQLMaxIdle = 10
	// MySQLMaxOpen of connection
	MySQLMaxOpen = 20
)

Functions

func ListenAndServe

func ListenAndServe(s *grpc.Server, addr string)

ListenAndServe the gRPC server at addr

func NewRedisClient

func NewRedisClient(cfg config.RedisConfig) *redis.Client

NewRedisClient get a redis client

func NewXormEngine

func NewXormEngine(mysql config.MysqlInstance, logWriter io.Writer, idle, open int, debug, ping bool) (*xorm.Engine, error)

Types

type App

type App struct {
	Store    *container.Map
	Injector container.Injector

	//loggers map[string]util.Logger
	Config *cfg.AppConfig
	// contains filtered or unexported fields
}

App represents the application

func NewApp

func NewApp() App

NewApp gets a new application

func (*App) DefaultLogger

func (app *App) DefaultLogger() util.Logger

DefaultLogger gets default logger

func (*App) Get

func (app *App) Get(key string) interface{}

Get object from app.Store

func (*App) GetConfig

func (app *App) GetConfig() *cfg.AppConfig

GetConfig gets config ptr

func (*App) GetHook

func (app *App) GetHook(ht HookType) *[]HookFunc

GetHook returns hook slice by type

func (*App) Initialize

func (app *App) Initialize()

Initialize application

func (*App) Inject

func (app *App) Inject(object interface{}) error

Inject dependencies to the object. Please MAKE SURE that the dependencies should be stored at app.Injector before this method is called. Please use app.Set() to make this happen.

func (*App) LoadConfig

func (app *App) LoadConfig(mode string) *cfg.AppConfig

LoadConfig by mode from file

func (*App) Logger

func (app *App) Logger(name string) (util.Logger, error)

Logger of name

func (*App) RegisterHook

func (app *App) RegisterHook(ht HookType, hooks ...HookFunc)

RegisterHook in application's starting process

func (*App) Set

func (app *App) Set(key string, object interface{}, ifacePtr interface{})

Set object into app.Store and Map it into app.Injector

func (*App) SetConfig

func (app *App) SetConfig(config *cfg.AppConfig)

SetConfig sets config ptr

func (*App) SetLogger

func (app *App) SetLogger(name string, logger util.Logger)

SetLogger set logger

type Application

type Application interface {
	// Container
	Set(key string, object interface{}, ifacePtr interface{})
	Get(key string) interface{}
	Inject(object interface{}) error
	// hook
	GetHook(HookType) *[]HookFunc
	// load from file
	LoadConfig(mode string) *cfg.AppConfig
	SetConfig(*cfg.AppConfig)
	GetConfig() *cfg.AppConfig
	// logger
	DefaultLogger() util.Logger
	Logger(name string) (util.Logger, error)
	SetLogger(string, util.Logger)
	// init
	Initialize()

	RegisterHook(HookType, ...HookFunc)
}

Application interface represents a service application

type GrpcApp

type GrpcApp struct {
	App
	// contains filtered or unexported fields
}

GrpcApp is the concrete type of GrpcApplication

func NewGrpcApp

func NewGrpcApp(s *grpc.Server) *GrpcApp

NewGrpcApp returns a new GrpcApp

func (*GrpcApp) GetServer

func (app *GrpcApp) GetServer() *grpc.Server

GetServer implements the GrpcApplication interface

func (*GrpcApp) Initialize

func (app *GrpcApp) Initialize()

Initialize web application

func (*GrpcApp) ListenAndServe

func (app *GrpcApp) ListenAndServe()

ListenAndServe implements the GrpcApplication interface

func (*GrpcApp) SetServer

func (app *GrpcApp) SetServer(s *grpc.Server)

SetServer implements the GrpcApplication interface

type GrpcApplication

type GrpcApplication interface {
	Application
	SetServer(*grpc.Server)
	GetServer() *grpc.Server
	ListenAndServe()
}

GrpcApplication represents a gRPC Application

type HookFunc

type HookFunc func(Application) error

HookFunc when app starting and tearing down

type HookType

type HookType byte

HookType for hook

const (
	// ConfigHook is a hook type for config
	ConfigHook HookType = iota
	// LoggerHook is a hook type for logger
	LoggerHook
	// ServiceHook is a hook type for service
	ServiceHook
	// RouterHook is a hook type for router
	RouterHook
	// ShutdownHook is a hook type for shutting down
	ShutdownHook
)

type MysqlManager

type MysqlManager struct {
	App    Application `inject:"app"`
	Config config.MysqlConfig
	// contains filtered or unexported fields
}

MysqlManager for mysql connection

func NewMysqlManager

func NewMysqlManager(app Application, config config.MysqlConfig) (*MysqlManager, error)

NewMysqlManager returns a new MysqlManager

func (*MysqlManager) DB

func (mm *MysqlManager) DB(name string) *xorm.Engine

DB gets databases by name

func (*MysqlManager) R

func (mm *MysqlManager) R() *xorm.Engine

R get read-only mysql Engine

func (*MysqlManager) SetDB

func (mm *MysqlManager) SetDB(name string, engine *xorm.Engine) bool

SetDB sets database by name

func (*MysqlManager) W

func (mm *MysqlManager) W() *xorm.Engine

W gets master mysql Engine

type WebApp

type WebApp struct {
	App
	Router *echo.Echo
}

WebApp is the concrete type of WebApplication

func NewWebApp

func NewWebApp() *WebApp

NewWebApp returns a new web app

func (*WebApp) GetRouter

func (app *WebApp) GetRouter() *echo.Echo

GetRouter gets router

func (*WebApp) Initialize

func (app *WebApp) Initialize()

Initialize web application

func (*WebApp) ListenAndServe

func (app *WebApp) ListenAndServe()

ListenAndServe the web application

func (*WebApp) SetRouter

func (app *WebApp) SetRouter(r *echo.Echo)

SetRouter sets router

type WebApplication

type WebApplication interface {
	Application
	GetRouter() *echo.Echo
	SetRouter(*echo.Echo)
	ListenAndServe()
}

WebApplication interface represents a web application