framework

README

A golang framework for web artisan.

Components

• enorith/http http service kernel component
• enorith/container IoC-Container
• enorith/config config
• enorith/cache cache component
• enorith/authenticate authentication (WIP)
• enorith/supports utils
• enorith/gormdb database component using gorm
• enorith/language language component

TODO

• Authentication (component incomplete)
• Message queue (component)
• Filesystem (component)
• Logging (component)
• Database (component, using gorm for now, waiting generics)
• CLI application
• Task scheduling

Documentation

Index

• Variables
• type App
  • func NewApp(configFs fs.FS, logDir string) *App
  • func (app *App) Bind(bf BindFunc)
  • func (app *App) Bootstrap() (e error)
  • func (app *App) Configure(name string, value interface{}) error
  • func (app *App) ConfigureFS(fs fs.FS, name string, value interface{}) error
  • func (app *App) Container() container.Interface
  • func (app *App) Daemon(f DaemonFn) *App
  • func (app *App) Defer(f func()) *App
  • func (app *App) GetConfig() Config
  • func (app *App) GetEnv() string
  • func (app *App) Register(service Service) *App
  • func (app *App) RegisterRoutes(rr RouterRegister) *App
  • func (app *App) Resolving(fn interface{})
  • func (app *App) Run() error
  • func (app *App) RunDaemons(wg *sync.WaitGroup, daemon ...bool)
  • func (app *App) RunDefers()
  • func (app *App) Services() []Service
• type BindFunc
• type Config
• type ConfigService
  • func (cs *ConfigService) Add(name string, config interface{}) *ConfigService
  • func (cs *ConfigService) Register(app *App) error
• type DaemonFn
• type LogChannelConfig
• type LoggingConfig
• type LoggingService
  • func NewLoggingService(baseDir string) *LoggingService
  • func (s *LoggingService) Register(app *App) error
• type RouterRegister
• type Service

Variables

var AppConfigName = "app"

AppConfigName: default app config name

var ConfigExt = ".yaml"

ConfigExt: default config extension

var (
	LabelKey = "label"
)

Types

type App

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

App: framework application

func NewApp

func NewApp(configFs fs.FS, logDir string) *App

NewApp: new application instance

func (*App) Bind

func (app *App) Bind(bf BindFunc)

Bind instance to global ioc-container

func (*App) Bootstrap

func (app *App) Bootstrap() (e error)

Bootstrap application, will call before app run

func (*App) Configure

func (app *App) Configure(name string, value interface{}) error

Configure: load config instance and add to config service

func (*App) ConfigureFS

func (app *App) ConfigureFS(fs fs.FS, name string, value interface{}) error

ConfigureFS: load config from filesystem

func (*App) Container

func (app *App) Container() container.Interface

Container get global ioc-container

func (*App) Daemon

func (app *App) Daemon(f DaemonFn) *App

Daemon run function, start daemon service before http service started

func (*App) Defer

func (app *App) Defer(f func()) *App

Defer run function, run after server shutdown

func (*App) GetConfig

func (app *App) GetConfig() Config

GetConfig: get app config instance

func (*App) GetEnv

func (app *App) GetEnv() string

GetEnv: get app env

func (*App) Register

func (app *App) Register(service Service) *App

Register application service provider service

func (*App) RegisterRoutes

func (app *App) RegisterRoutes(rr RouterRegister) *App

RegisterRoutes: register routes of http service

func (*App) Resolving

func (app *App) Resolving(fn interface{})

Resolving call fn after all services registered, fn paramters can be injected from global ioc-container

func (*App) Run

func (app *App) Run() error

Run application service

func (*App) RunDaemons

func (app *App) RunDaemons(wg *sync.WaitGroup, daemon ...bool)

RunDaemons, run background services

func (*App) RunDefers

func (app *App) RunDefers()

func (*App) Services

func (app *App) Services() []Service

type BindFunc

type BindFunc func(ioc container.Interface)

type Config

type Config struct {
	Env      string `yaml:"env" env:"APP_ENV" default:"production"`
	Debug    bool   `yaml:"debug" env:"APP_DEBUG" default:"false"`
	Locale   string `yaml:"locale" env:"APP_LOCALE" default:"en"`
	Timezone string `yaml:"timezone" env:"APP_TIMEZONE" default:"UTC"`
	Key      string `yaml:"key" env:"APP_KEY" default:"somerandomkey!!!"`
}

Config of application

var AppConfig Config

AppConfig global var

type ConfigService

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

ConfigService of application

func (*ConfigService) Add

func (cs *ConfigService) Add(name string, config interface{}) *ConfigService

Add config instance to service

func (*ConfigService) Register

func (cs *ConfigService) Register(app *App) error

Register config service when app starting

type DaemonFn

type DaemonFn func(exit chan struct{})

type LogChannelConfig

type LogChannelConfig struct {
	Outputs    []string `yaml:"outputs"`
	Errouts    []string `yaml:"errouts"`
	Encoding   string   `yaml:"encoding" default:"json"`
	TimeFormat string   `yaml:"time_format" default:"2006-01-02T15:04:05.999"`
	Label      string   `yaml:"label"`
}

type LoggingConfig

type LoggingConfig struct {
	Default  string `yaml:"default" env:"LOGGING_CHANNEL" default:"default"`
	Channels map[string]LogChannelConfig
}

type LoggingService

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

func NewLoggingService

func NewLoggingService(baseDir string) *LoggingService

func (*LoggingService) Register

func (s *LoggingService) Register(app *App) error

Register service when app starting, before http server start you can configure service, prepare global vars etc. running at main goroutine

type RouterRegister

type RouterRegister func(rw *router.Wrapper)

type Service

type Service interface {
	//Register service when app starting, before http server start
	// you can configure service, prepare global vars etc.
	// running at main goroutine
	Register(app *App) error
}