dix

README

dix

dix是一个参考了dig设计的依赖注入工具

dix和dig的主要区别在于dix能够完成更加复杂的依赖注入管理和namespace依赖隔离

使用

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/pubgo/dix"
	"github.com/pubgo/xerror"
)

type Redis struct {
	Name string
}

type Handler struct {
	Name string
	// 如果是结构体，且tag为dix，那么，会检查结构体内部有指针或者接口属性，然后进行对象注入
	Cli  *Redis `inject:""`
	Cli1 *Redis `inject:"${.Name}"`
}

func main() {
	defer xerror.RecoverAndExit()

	dix.Register(func() *log.Logger {
		return log.New(os.Stderr, "", log.LstdFlags|log.Llongfile)
	})

	dix.Register(func(l *log.Logger) map[string]*Redis {
		l.Println("init redis")
		return map[string]*Redis{
			"default": {Name: "hello"},
		}
	})

	dix.Register(func(l *log.Logger) map[string]*Redis {
		l.Println("init redis")
		return map[string]*Redis{
			"ns": {Name: "hello1"},
		}
	})

	dix.Register(func(r *Redis, l *log.Logger, rr map[string]*Redis) {
		l.Println("invoke redis")
		fmt.Println("invoke:", r.Name)
		fmt.Println("invoke:", rr)
	})

	var h = Handler{Name: "ns"}
	dix.Inject(&h)
	xerror.Assert(h.Cli.Name != "hello", "inject error")
	xerror.Assert(h.Cli1.Name != "hello1", "inject error")
	dix.Invoke()
	fmt.Println(dix.Graph())
}

Documentation

Index

• func Graph() *graph
• func Inject[T any](data T, opts ...Option) T
• func Provide(data any)
• func Provider(data any)
• type Dix
  • func New(opts ...Option) *Dix
  • func SubDix(opts ...Option) *Dix
  • func (x *Dix) Dix(opts ...Option) *Dix
  • func (x *Dix) Graph() *graph
  • func (x *Dix) Inject(param any, opts ...Option) any
  • func (x *Dix) Option() Options
  • func (x *Dix) Provider(param any)
  • func (x *Dix) Register(param any)
• type Err
  • func (e Err) Error() string
  • func (e Err) String() string
  • func (e Err) Unwrap() error
• type Option
  • func AllowNil() Option
• type Options
  • func (o Options) Check()

Functions

func Graph

func Graph() *graph

Graph Dix graph

func Inject

func Inject[T any](data T, opts ...Option) T

Inject 注入对象

data是<*struct>或者<func>

func Provide

func Provide(data any)

Provide 注册provider

同Provider

func Provider

func Provider(data any)

Provider 注册provider

provider必须有返回值, 且返回值只能有一个, 类型为map,any,ptr,slice,func

Types

type Dix

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

func New

func New(opts ...Option) *Dix

New Dix new

func SubDix

func SubDix(opts ...Option) *Dix

SubDix 子域

func (*Dix) Dix

func (x *Dix) Dix(opts ...Option) *Dix

func (*Dix) Graph

func (x *Dix) Graph() *graph

func (*Dix) Inject

func (x *Dix) Inject(param any, opts ...Option) any

func (*Dix) Option

func (x *Dix) Option() Options

func (*Dix) Provider

func (x *Dix) Provider(param any)

func (*Dix) Register

func (x *Dix) Register(param any)

type Err

type Err struct {
	Err    error
	Msg    string
	Detail string
}

func (Err) Error

func (e Err) Error() string

func (Err) String

func (e Err) String() string

func (Err) Unwrap

func (e Err) Unwrap() error

type Option

type Option func(opts *Options)

func AllowNil

func AllowNil() Option

type Options

type Options struct {
	// 允许结果为nil
	AllowNil bool
}

func (Options) Check

func (o Options) Check()