https://github.com/marcguilera/dependencies.dart

Simple and flexible dependency injection container for dart.
https://github.com/marcguilera/dependencies.dart

Last synced: 10 days ago
JSON representation

Simple and flexible dependency injection container for dart.

• Host: GitHub
• URL: https://github.com/marcguilera/dependencies.dart
• Owner: marcguilera
• License: other
• Created: 2018-10-28T13:43:22.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-11-05T12:36:40.000Z (about 3 years ago)
• Last Synced: 2024-08-01T16:27:26.715Z (3 months ago)
• Language: Dart
• Homepage:
• Size: 44.9 KB
• Stars: 30
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-dart - Dependencies - A simple and modular dependency injection system which doesn't use mirrors. (Dependency Injection)

README

        
[![Mentioned in Awesome Dart](https://awesome.re/mentioned-badge.svg)](https://github.com/yissachar/awesome-dart)

[![CircleCI](https://circleci.com/gh/marcguilera/dependencies.dart.svg?style=svg)](https://circleci.com/gh/marcguilera/dependencies.dart)

[![pub package](https://img.shields.io/pub/v/dependencies.svg)](https://pub.dartlang.org/packages/dependencies)

This is a simple and flexible dependency injection container for dart. 

If you are using Flutter consider the [dependencies_flutter](https://pub.dartlang.org/packages/dependencies_flutter) package.

## Features

- **Immutability:** The injector is created via a builder so it won't be modified after being created.

- **Modules:** Separate dependencies into logical pars. Useful to separate by environments.

- **Singletons:** Bind singletons and lazy singletons.

- **Factories:** Bind factories.

- **Named dependencies:** Give your dependencies custom names.

- **Extra arguments:** Pass arguments to your factory methods.

- **Works with Flutter:** Since it doesn't use reflexion it works with Flutter. 

## Usage

### Set up

Optionally create a module.

```dart

class PlayerModule implements Module {

  @override

  void configure(Binder binder) {

    binder

      ..bindSingleton("playerkey", name: "api_key")

      ..bindFactory((injector, params) => Player(params["playerId"]))

      ..bindLazySingleton((injector, params) => Rest(injector));

  }

}

```

Create a builder and use it to instantiate an injector.

```dart

final builder = Injector.builder()

    ..bind(instance: "abc123", isSingleton: true, name: "api_key")

    ..bindSingleton("abc123", name: "api_key_2")

    ..bindFactory((injector, params) => User(params["userId"]))

    ..bindLazySingleton((injector, params) => RestController(params["path"]))

    ..install(PlayerModule());

final injector = builder.build();

```

### Usage

Get instances from the container.

```dart

final Player player = injector.get(params: {"playerId":1});

final Rest rest = injector.get();

final String apiKey = injector.get(name: "api_key");

```

Optionally you can manage injectors with the registry. Feel free to create your own or use the singleton.

```dart

InjectorRegistry.instance.register(injector);

```

Injectors can be fetched from the registry.

```dart

final injector = InjectorRegistry.instance.get();

final namedInjector = InjectorRegistry.instance.get(name: "named_injector");

```