Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/magic003/alice
An additive dependency injection container for Golang.
https://github.com/magic003/alice
dependency-injection golang ioc-container
Last synced: about 2 months ago
JSON representation
An additive dependency injection container for Golang.
- Host: GitHub
- URL: https://github.com/magic003/alice
- Owner: magic003
- License: mit
- Created: 2017-04-08T16:25:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-04-26T06:08:23.000Z (over 7 years ago)
- Last Synced: 2024-07-31T20:52:20.727Z (4 months ago)
- Topics: dependency-injection, golang, ioc-container
- Language: Go
- Homepage: https://godoc.org/github.com/magic003/alice
- Size: 40 KB
- Stars: 50
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - alice - Additive dependency injection container for Golang. (Miscellaneous / Dependency Injection)
- zero-alloc-awesome-go - alice - Additive dependency injection container for Golang. (Miscellaneous / Dependency Injection)
- awesome-go - alice - An additive dependency injection container for Golang. - ★ 29 (Miscellaneous)
- awesome-go-extra - alice - 04-08T16:25:21Z|2017-04-26T06:08:23Z| (Microsoft Office / Dependency Injection)
- awesome-go-zh - alice
README
# Alice
[](https://github.com/magic003/alice/releases/latest)
[](https://godoc.org/github.com/magic003/alice)
[](https://travis-ci.org/magic003/alice)
[](https://coveralls.io/github/magic003/alice?branch=master)
[](https://goreportcard.com/report/github.com/magic003/alice)
Alice is an additive dependency injection container for Golang.
## Philosophy
Design philosophy behind Alice:
* The application components should **not** be aware of the existence of a DI container.
* Use static Go files to define the object graph.
* Developer has the freedom to choose the way to initialize objects.
## Install
```
$ go get github.com/magic003/alice
```
## Usage
Alice is inspired by the design of [Spring JavaConfig](http://docs.spring.io/spring-javaconfig/docs/1.0.0.M4/reference/html/).
It usually takes 3 steps to use Alice.
### Define modules
The instances to be managed by the container are defined in modules. There could be multiple modules organized by the functionality of the instances. Modules are usually placed in a separate package.
A typical module looks like this:
```go
type ExampleModule struct {
alice.BaseModule
Foo Foo `alice:""`
Bar Bar `alice:"Bar"`
Baz Baz
}
func (m *ExampleModule) InstanceX() X {
return X{m.Foo}
}
func (m *ExampleModule) InstanceY() Y {
return Y{m.Baz}
}
```
A module struct must embed the `alice.BaseModule` struct. It allows 3 types of fields:
* Field tagged by `alice:""`. It will be associated with the same or assignable type of instance defined in other modules.
* Field tagged by `alice:"Bar"`. It will be associated with the instance named `Bar` defined in other modules.
* Field without `alice` tag. It will **not** be associated with any instance defined in other modules. It is expected to be provided when initializing the module. It is not managed by the container and could not be retrieved.
It is also common that no field is defined in a module struct.
Any public method of the module struct defines one instance to be intialized and maintained by the container. It is required to use a pointer receiver. The method name will be used as the instance name. The return type will be used as the instance type. Inside the method, it could use any field of the module struct to create new instances.
### Create container
During the bootstrap of the application, create a container by providing instances of modules.
```go
m1 := &ExampleModule1{}
m2 := &ExampleModule2{...}
container := alice.CreateContainer(m1, m2)
```
It will panic if any module is invalid.
### Retreive instances
The container provides 2 ways to retrieve instances: by name and by type.
```go
instanceX := container.InstanceByName("InstanceX")
instanceY := container.Instance(reflect.TypeOf((Y)(nil)))
```
It will panic either if no instance is found or if multiple matched types are found.
## Example
A dummy [example](https://github.com/magic003/alice/tree/master/example) using Alice.