ioc

README

IOC

Package ioc provides a reflection-based dependency injection toolkit.

Feature

• Support shared services and scoped services.
• Support setting services to the scope.
• Automatic cleanup.
• Support concurrency.

Dependencies

• go 1.20+

Usage

import "gitee.com/erdian718/ioc"

func main() {
	provider, err := ioc.New().
		Add(..., true).
		Add(..., false).
		Build()
	if err != nil {
		panic(err)
	}
	defer provider.Release()

	scope := provider.Create()
	defer scope.Release()

	s, err := ioc.Resolve[ServiceType](scope)
	if err != nil {
		panic(err)
	}
	// ...
}

Note

• Only Provider.Create method is goroutine safe.

Documentation

Overview

Package ioc provides a reflection-based dependency injection toolkit.

Example

package main

import (
	"fmt"
	"io"
	"strconv"
	"strings"

	"gitee.com/erdian718/ioc"
)

func main() {
	provider, err := ioc.New().
		Add(func() io.Reader {
			return nil
		}, false).
		Add(func() int {
			return 718
		}, true).
		Add(func(c int, r io.Reader) (string, error) {
			bs, err := io.ReadAll(r)
			if err != nil {
				return "", err
			}
			return string(bs) + strconv.Itoa(c), nil
		}, false).
		Build()
	if err != nil {
		panic(err)
	}
	defer provider.Release()

	scope := provider.Create()
	defer scope.Release()

	if err := ioc.Set[io.Reader](scope, strings.NewReader("erdian")); err != nil {
		panic(err)
	}
	result, err := ioc.Resolve[string](scope)
	if err != nil {
		panic(err)
	}
	fmt.Println(result)
}

Output:

erdian718

Index

• Variables
• func Resolve[T any](scope *Scope) (T, error)
• func Set[T any](scope *Scope, value any) error
• type Builder
  • func New() *Builder
  • func (b *Builder) Add(creator any, shared bool) *Builder
  • func (b *Builder) Build() (*Provider, error)
• type Provider
  • func (p *Provider) Create() *Scope
  • func (p *Provider) Release() error
• type Scope
  • func (s *Scope) Release() error
  • func (s *Scope) Resolve(values ...any) error

Examples

• Package

Variables

var (
	ErrInvalidCreator   = errors.New("ioc: invalid creator")
	ErrServiceNotFound  = errors.New("ioc: service not found")
	ErrDuplicateService = errors.New("ioc: duplicate service")
	ErrCyclicDependence = errors.New("ioc: cyclic dependence")
)

Errors.

Functions

func Resolve

func Resolve[T any](scope *Scope) (T, error)

Resolve resolves the dependencies.

func Set

func Set[T any](scope *Scope, value any) error

Set sets a value to the scope.

Types

type Builder

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

Builder represents the builder for building a provider.

func New

func New() *Builder

New creates a new builder.

func (*Builder) Add

func (b *Builder) Add(creator any, shared bool) *Builder

Add adds a service to the builder. If shared is true, all scopes share the same service.

func (*Builder) Build

func (b *Builder) Build() (*Provider, error)

Build builds a provider.

type Provider

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

Provider defines a mechanism for retrieving a service object.

func (*Provider) Create

func (p *Provider) Create() *Scope

Create creates a new scope. The method is goroutine safe.

func (*Provider) Release

func (p *Provider) Release() error

Release frees up resources allocated for the provider.

type Scope

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

Scope represents a scope for retrieving a service object.

func (*Scope) Release

func (s *Scope) Release() error

Release frees up resources allocated for the scope.

func (*Scope) Resolve

func (s *Scope) Resolve(values ...any) error

Resolve resolves the dependencies.