di

README

di

This is a minimalistic idiomatic dependency injection framework for Golang. It is inspired by new opportunities of Go 1.7.

Advantages:

• Tiny
• No reflection
• No code generation
• No type assertions

Who needs it?

• People who want to use DI in their projects
• People who want to write tests for their code

How to use it? See tests for examples.

Documentation

Index

• Variables
• func Check(s interface{})
• func Execute(ctx context.Context, constructor Constructor[Application], ...)
• func Resolve(container, environment interface{})
• type App
  • func GetAppFromContext(ctx context.Context) *App
  • func (a *App) Done(ctx context.Context)
  • func (a *App) Init(ctx context.Context)
  • func (a *App) Run(ctx context.Context)
  • func (a *App) Variables() Variables
• type AppOption
  • func WithConfigurator(configurators ...func(ctx context.Context)) AppOption
  • func WithDaemon(daemons ...func(ctx context.Context)) AppOption
  • func WithService[T any](constructor ...Constructor[T]) AppOption
• type AppOptions
• type Application
  • func Build(ctx context.Context, constructor Constructor[Application], ...) (a Application, c context.Context, err error)
• type ApplicationContextType
• type Builder
• type Constructor
  • func NewComponent[T any](name string, builder Builder[T], options ...Option[T]) Constructor[T]
• type Finalizer
• type Initializer
• type LogLevel
• type Option
  • func UseDone[T Finalizer]() Option[T]
  • func UseInit[T Initializer]() Option[T]
  • func WithDone[T any](finalizer ...func(ctx context.Context, instance T)) Option[T]
  • func WithInit[T any](initializer ...func(ctx context.Context, instance T) error) Option[T]
  • func WithPriority[T any](priority int) Option[T]
• type Options
• type State
• type Variables
  • func GetVariables(ctx context.Context) Variables
  • func NewVariables(values map[string]interface{}) Variables

Variables

var Logger interface {
	Log(level LogLevel, component, msg string)
} = new(logger)

Functions

func Check

func Check(s interface{})

Check checks all fields of structure c for nil. It used reflection for this. If field is nil, then panic.

func Execute

func Execute(
	ctx context.Context,
	constructor Constructor[Application],
	options ...AppOption,
)

func Resolve

func Resolve(container, environment interface{})

Resolve iterate by fields of structure environment and for each field search in the container constructor of component. If constructor found, then it calls and return value of constructor writes to the field of structure environment.

Types

type App

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

func GetAppFromContext

func GetAppFromContext(ctx context.Context) *App

func (*App) Done

func (a *App) Done(ctx context.Context)

func (*App) Init

func (a *App) Init(ctx context.Context)

func (*App) Run

func (a *App) Run(ctx context.Context)

func (*App) Variables

func (a *App) Variables() Variables

type AppOption

type AppOption func(opts *AppOptions)

func WithConfigurator

func WithConfigurator(configurators ...func(ctx context.Context)) AppOption

func WithDaemon

func WithDaemon(daemons ...func(ctx context.Context)) AppOption

func WithService

func WithService[T any](constructor ...Constructor[T]) AppOption

type AppOptions

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

type Application

type Application interface {
	Init(ctx context.Context)
	Done(ctx context.Context)
	Run(ctx context.Context)
}

func Build

func Build(
	ctx context.Context,
	constructor Constructor[Application],
	options ...AppOption,
) (a Application, c context.Context, err error)

type ApplicationContextType

type ApplicationContextType int

var ApplicationContextKey ApplicationContextType = 0

type Builder

type Builder[T any] func(ctx context.Context) (T, error)

type Constructor

type Constructor[T any] func(ctx context.Context) T

func NewComponent

func NewComponent[T any](
	name string,
	builder Builder[T],
	options ...Option[T],
) Constructor[T]

type Finalizer

type Finalizer interface {
	Done()
}

type Initializer

type Initializer interface {
	Init() error
}

type LogLevel

type LogLevel int

const (
	LogLevelDebug LogLevel = iota
	LogLevelInfo
	LogLevelWarning
	LogLevelError
)

type Option

type Option[T any] func(options *Options[T])

func UseDone

func UseDone[T Finalizer]() Option[T]

func UseInit

func UseInit[T Initializer]() Option[T]

func WithDone

func WithDone[T any](finalizer ...func(ctx context.Context, instance T)) Option[T]

func WithInit

func WithInit[T any](initializer ...func(ctx context.Context, instance T) error) Option[T]

func WithPriority

func WithPriority[T any](priority int) Option[T]

type Options

type Options[T any] struct {
	// contains filtered or unexported fields
}

type State

type State int

const (
	StateBuild State = iota
	StateInit
	StateDone
)

type Variables

type Variables interface {
	Get(key string) interface{}
	GetInt(key string) int
	GetString(key string) string
	GetBool(key string) bool
	GetFloat(key string) float64

	TryGet(key string, defVal interface{}) interface{}
	TryGetInt(key string, defVal int) int
	TryGetString(key string, defVal string) string
	TryGetBool(key string, defVal bool) bool
	TryGetFloat(key string, defVal float64) float64

	Set(key string, val interface{})
	SetInt(key string, val int)
	SetString(key string, val string)
	SetBool(key string, val bool)
	SetFloat(key string, val float64)
}

func GetVariables

func GetVariables(ctx context.Context) Variables

func NewVariables

func NewVariables(values map[string]interface{}) Variables