msa

README

msa

Go microservice architecture main component, responsible for application startup, 
dependency injection,configuration reading, life cycle management.

go dip tools

https://github.com/go-god/gdi

providers

You can pass the provider into the msa.Start method as an Option through the 
msa.WithProviders or msa.WithConfigProviders method to start the service.

Documentation

Index

• Variables
• func IsSet(key string) bool
• func LoadConf(key string, obj interface{}) error
• func Start(opts ...Option)
• func Stop()
• type Engine
  • func New(opts ...Option) *Engine
  • func (e *Engine) IsSet(key string) bool
  • func (e *Engine) LoadConf(key string, obj interface{}) error
  • func (e *Engine) Start()
  • func (e *Engine) Stop()
• type Option
  • func WithConfigInterface(c config.ConfigInterface) Option
  • func WithConfigProvider(configProvider provides.ConfigProvider) Option
  • func WithGracefulWait(t time.Duration) Option
  • func WithInjectValues(objects ...*gdi.Object) Option
  • func WithInjector(injectType factory.InjectType) Option
  • func WithInterruptSignals(signals ...os.Signal) Option
  • func WithLogger(opts ...logger.Option) Option
  • func WithProviders(provides ...provides.Provider) Option

Variables

var InterruptSignals = []os.Signal{
	syscall.SIGINT, syscall.SIGTERM, os.Interrupt, syscall.SIGHUP,
	syscall.SIGSTOP, syscall.SIGQUIT,
}

InterruptSignals interrupt signals.

Functions

func IsSet

func IsSet(key string) bool

IsSet check configInterface is set key

func LoadConf

func LoadConf(key string, obj interface{}) error

LoadConf get key from configInterface,obj must be a pointer

func Start

func Start(opts ...Option)

Start create an engine and run application.

func Stop

func Stop()

Stop if receive active exit signal,the application will exit

Types

type Engine

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

Engine application engine

func New

func New(opts ...Option) *Engine

New create an application for msa engine

func (*Engine) IsSet

func (e *Engine) IsSet(key string) bool

IsSet configInterface is set key

func (*Engine) LoadConf

func (e *Engine) LoadConf(key string, obj interface{}) error

LoadConf get key from configInterface,obj must be a pointer

func (*Engine) Start

func (e *Engine) Start()

Start run app

func (*Engine) Stop

func (e *Engine) Stop()

Stop if receive active exit signal,the application will exit

type Option

type Option func(e *Engine)

Option engine option

func WithConfigInterface

func WithConfigInterface(c config.ConfigInterface) Option

WithConfigInterface set config read interface

func WithConfigProvider

func WithConfigProvider(configProvider provides.ConfigProvider) Option

WithConfigProvider add config providers

func WithGracefulWait

func WithGracefulWait(t time.Duration) Option

WithGracefulWait set engine gracefulWait.

func WithInjectValues

func WithInjectValues(objects ...*gdi.Object) Option

WithInjectValues set inject object

func WithInjector

func WithInjector(injectType factory.InjectType) Option

WithInjector set injector inject type as: factory.FbInject or factory.DigInject

func WithInterruptSignals

func WithInterruptSignals(signals ...os.Signal) Option

WithInterruptSignals set engine interruptSignals

func WithLogger

func WithLogger(opts ...logger.Option) Option

WithLogger logger config

func WithProviders

func WithProviders(provides ...provides.Provider) Option

WithProviders add providers