Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maksimzayats/godi
🚀 GoDI: Generic based DI in Go
https://github.com/maksimzayats/godi
dependency-injection di go go-dependency-injection go-di go-generics go-library injection-dependency
Last synced: 2 months ago
JSON representation
🚀 GoDI: Generic based DI in Go
- Host: GitHub
- URL: https://github.com/maksimzayats/godi
- Owner: MaksimZayats
- Created: 2022-04-29T10:55:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-04T15:42:47.000Z (over 2 years ago)
- Last Synced: 2024-06-21T04:41:47.910Z (7 months ago)
- Topics: dependency-injection, di, go, go-dependency-injection, go-di, go-generics, go-library, injection-dependency
- Language: Go
- Homepage:
- Size: 33.2 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 GoDI: Generic based DI in Go
## Installation
`DI`:
* ```shell
go get -u github.com/MaximZayats/godi/
```
* ```go
import "github.com/MaximZayats/godi/di"
```
`CMD`:
* ```shell
go get -u github.com/MaximZayats/godi/cmd/godi
```
* ```shell
go run github.com/MaximZayats/godi/cmd/godi init ./storage/decorators
```
* ```shell
go run github.com/MaximZayats/godi/cmd/godi --help
```
## Example
* **Simple**: Getting from container
```go
package main
import (
"fmt"
"github.com/MaximZayats/godi/di"
)
func main() {
di.AddSingletonByFactory[float32](func(c *di.Container) float32 {
return 11.22
})
di.AddInstance[int](123)
di.AddByFactory[string](func(c *di.Container) string {
return "aabbcc"
})
fmt.Println(di.Get[int]()) // 123
fmt.Println(di.Get[string]()) // "aabbcc"
fmt.Println(di.Get[float32]()) // 11.22
fmt.Println(di.Get[float32]()) // 11.22
}
```
* **Injection**: Pass arguments to function (*Simple code generation is required*)
**Full code**: [godi-fiber-example](https://github.com/MaximZayats/godi-fiber-example)
**Snippet**:
```go
type H = func(*fiber.Ctx) error
// `stringFromDI` will be injected into the handler
func handler(c *fiber.Ctx, stringFromDI string) error {
return c.SendString("Hello from di: " + stringFromDI)
}
func main() {
di.AddInstance[string]("I'm string from DI!!!", c)
...
app.Get("/", injection.Inject[H](handler))
}
```
[Other examples](/examples)
## Usage
1. Getting from container:
* See examples above
2. Injection (decorating):
* Generate package for storing decorators:
* ```shell
go run github.com/MaximZayats/godi/cmd/godi init ./storage/decorators
```
* Configure `godi.injection`:
* ```go
import (
".../storage/decorators"
"github.com/MaximZayats/godi/injection"
)
injection.Configure(decorators.Config)
```
* Use injection:
* ```go
// `a` and `b` will be auto injected in the function
func Handler(c context.Context, a int, b string) int {
fmt.Println(c, a, b)
return a
}
injection.Configure(decorators.Config)
// H is the type alias for the function after injection
type H = func(context.Context) int
decoratedHandler := injection.Inject[H](Handler)
// IMPORTANT! You need to verify injection
injection.MustVerifyInjections()
decoratedHandler(context.TODO())
```
[See full example](examples/pkg/inject.go)
## Benchmarks
[Code](/benchmark/local_container_test.go)
```text
goos: windows
goarch: amd64
pkg: github.com/MaximZayats/godi/benchmark
cpu: AMD Ryzen 5 1600 Six-Core Processor
BenchmarkGetFromFactorySingleton
BenchmarkGetFromFactorySingleton-12 500488393 2.443 ns/op
BenchmarkGetInstance
BenchmarkGetInstance-12 495795447 2.403 ns/op
BenchmarkGetFromFactory
BenchmarkGetFromFactory-12 361722957 3.273 ns/op
PASS
```