application

package
v1.6.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 25, 2022 License: BSD-3-Clause Imports: 8 Imported by: 4

README

Application as service

Base config file

config.yaml

env: dev
level: 3 
log: /var/log/simple.log
pig: /var/run/simple.pid

level:

  • 0 - error only
  • 1 - + warning
  • 2 - + info
  • 3 - + debug

Example

package main

import (
	"fmt"

	"github.com/deweppro/go-app/application"
	"github.com/deweppro/go-app/application/ctx"
	"github.com/deweppro/go-logger"
)

type (
	//Simple model
	Simple struct{}
	//Config model
	Config struct {
		Env string `yaml:"env"`
	}
)

//NewSimple init Simple
func NewSimple(_ Config) *Simple {
	fmt.Println("--> call NewSimple")
	return &Simple{}
}

//Up  method for start Simple in DI container
func (s *Simple) Up(_ ctx.Context) error {
	fmt.Println("--> call *Simple.Up")
	return nil
}

//Down  method for stop Simple in DI container
func (s *Simple) Down(_ ctx.Context) error {
	fmt.Println("--> call *Simple.Down")
	return nil
}

func main() {
	application.New().
		Logger(logger.Default()).
		ConfigFile(
			"./config.yaml",
			Config{},
		).
		Modules(
			NewSimple,
		).
		Run()
}

HowTo

Run the app

app.New()
    .ConfigFile(<path to config file: string>, <config objects separate by comma: ...interface{}>)
    .Modules(<config objects separate by comma: ...interface{}>)
    .Run()

Supported types for initialization

  • Function that returns an object or interface

All incoming dependencies will be injected automatically

type Simple1 struct{}
func NewSimple1(_ *logger.Logger) *Simple1 { return &Simple1{} }

Returns the interface

type Simple2 struct{}
type Simple2Interface interface{
    Get() string
}
func NewSimple2() Simple2Interface { return &Simple2{} }
func (s2 *Simple2) Get() string { 
    return "Hello world"
}

If the object has the Up(ctx.Context) error and Down(ctx.Context) error methods, they will be called Up(ctx.Context) error when the app starts, and Down(ctx.Context) error when it finishes. This allows you to automatically start and stop routine processes inside the module

var _ service.IServiceCtx = (*Simple3)(nil)
type Simple3 struct{}
func NewSimple3(_ *Simple4) *Simple3 { return &Simple3{} }
func (s3 *Simple3) Up(_ ctx.Context) error { return nil }
func (s3 *Simple3) Down(_ ctx.Context) error { return nil }
  • Named type
type HelloWorld string
  • Object structure
type Simple4 struct{
    S1 *Simple1
    S2 Simple2Interface
    HW HelloWorld
}
  • Object reference or type
s1 := &Simple1{}
hw := HelloWorld("Hello!!")

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App

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

App application model

func New

func New() *App

New create application

func (*App) ConfigFile

func (a *App) ConfigFile(filename string, configs ...interface{}) *App

ConfigFile set config file path and configs models

func (*App) Logger

func (a *App) Logger(log logger.Logger) *App

Logger setup logger

func (*App) Modules

func (a *App) Modules(modules ...interface{}) *App

Modules append object to modules list

func (*App) Run

func (a *App) Run()

Run run application

type BaseConfig

type BaseConfig struct {
	Env     string `yaml:"env"`
	PidFile string `yaml:"pid"`
	//logger
	Level   uint32 `yaml:"level"`
	LogFile string `yaml:"log"`
}

BaseConfig config model

type ENV

type ENV string

ENV type for enviremants (prod, dev, stage, etc)

type Log

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

Log model

func NewLogger

func NewLogger(conf *BaseConfig) *Log

NewLogger init logger

func (*Log) Close

func (l *Log) Close() error

Close log file

func (*Log) Handler

func (l *Log) Handler(log logger.Logger)

Handler set custom logger for application

type Modules

type Modules []interface{}

Modules DI container

func (Modules) Add

func (m Modules) Add(v ...interface{}) Modules

Add object to container

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL