Auto Injector - Automatic Dependency injection system without build_runner.

A simple way to inject dependencies in your project.
Explore the docs »

Report Bug · Request Feature

[![Version](https://img.shields.io/github/v/release/flutterando/auto_injector?style=plastic)](https://pub.dev/packages/auto_injector) [![Pub Points](https://img.shields.io/pub/points/auto_injector?label=pub%20points&style=plastic)](https://pub.dev/packages/auto_injector/score) [![Flutterando Analysis](https://img.shields.io/badge/style-flutterando__analysis-blueviolet?style=plastic)](https://pub.dev/packages/flutterando_analysis/) [![Pub Publisher](https://img.shields.io/pub/publisher/auto_injector?style=plastic)](https://pub.dev/publishers/flutterando.com.br/packages)

Table of Contents

About The Project
Sponsors
Getting Started
How to Use

Dispose Singleton
Modularization
Param Transform

Features
Contributing
Contact
Acknowledgements

About The Project

Auto Injector is a Dart package that was created to make the developer's life easier, making the method of how to do dependency injection simpler and more practical. Just create the class that will be injected and declare it within some of the available "add" methods and that's it, you already have your dependency injection ready to use.

This project is distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Getting Started

To get Auto Injector in your project follow either of the instructions below:

a) Add your_package as a dependency in your Pubspec.yaml:

   dependencies:
     auto_injector: ^1.0.2

b) Use Dart Pub:

   dart pub add auto_injector

How to Use

final autoInjector = AutoInjector();

void main(){

    // factory
    autoInjector.add(Controller.new);
    // Singleton
    autoInjector.addSingleton(Datasource.new);
    // lazySingleton
    autoInjector.addLazySingleton(Repository.new);
    // instance
    autoInjector.instance('Instance');

    // Inform that you have finished adding instances
    autoInjector.commit();

}

class Controller {
    final Repository repository;

    Controller(this.repository);
}

class Repository {
    final Datasource datasource;

    Repository({required this.datasource});
}

class Datasource {}


autoInjector.add(Controller.new, key: 'MyCustomName');

Get instance:

  // fetch
  final controller = autoInjector.get<Controller>();
  print(controller); // Instance of 'Controller'.

  // or use calleble function (withless .get())
  final datasource = autoInjector<Datasource>();
  print(datasource); // Instance of 'Datasource'.

Get instance by key

  // fetch
  final controller = autoInjector.get<Controller>(key: 'CustomController');
  print(controller); // Instance of 'Controller'.

Try get instance:

  // use tryGet that returns null if exception.
  final datasource = autoInjector.tryGet<Datasource>() ?? Datasource();
  print(datasource); // Instance of 'Datasource'.

Get instance and transform params. This can be used for example to replace an instance with a mock in tests.

  final datasource = autoInjector.get<Datasource>(transform: changeParam(DataSourceMock()));
  print(datasource); // Instance of 'Datasource'.

Dispose Singleton

Singletons can be terminated on request using the disposeSingleton method returning the instance for executing the dispose routine.


final deadInstance = autoInjector.disposeSingleton<MyController>();
deadInstance.close();

Modularization

For projects with multiple scopes, try uniting the instances by naming them Module or Container. With this, you can register specific instances for each module.


// app_module.dart
final appModule = AutoInjector(
  tag: 'AppModule',
  on: (i) {
    i.addInjector(productModule);
    i.addInjector(userModule);
    i.commit();
  },
);

...

// product_module.dart
final productModule = AutoInjector(
  tag: 'ProductModule',
  on: (i) {
    i.addInstance(1);
  },
);

...

// user_module.dart
final userModule = AutoInjector(
  tag: 'UserModule',
  on: (i) {
    i.addInstance(true);
  },
);

...

void main() {
  print(appModule.get<int>());
  print(appModule.get<bool>());
}

It is also possible to remove all singletons from a specific tag using the method disposeSingletonsByTag which reports each instance removed via an anonymous function:

autoInjector.disposeSingletonsByTag('ProductModule', (instance){
  // individual dispose routine
});

Param Transform

There is the possibility to listen and transform all the parameters that are being analyzed when there is an instance request (AutoInject.get()). Add transformers on the main instance:

final homeModule = AutoInjector(
  paramTransforms: [
    (param) {
    if(param is NamedParam){
        return param;
    } else if(param is PositionalParam) {
        return param;
    }
  ],
);

BindConfig

If there is a need to configure the dispose and notifier of the bind, use the BindConfig<T> property. This is very useful if you want to automate class disposes like BLoC or Triple Store:

final injector = AutoInjector();

final config = BindConfig<Bloc>(
  onDispose: (bloc) => bloc.close(),
  onNotifier: (bloc) => bloc.stream,
);

injector.addSingleton(ProductBloc.new, config: config);

For more examples, please refer to the Documentation

(back to top)

Features

✅ Auto Dependency Injection
✅ Factory Injection
✅ Singleton Injection
✅ Lazy Singleton Injection
✅ Instance Injection

Right now this package has concluded all his intended features. If you have any suggestions or find something to report, see below how to contribute to it.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the appropriate tag. Don't forget to give the project a star! Thanks again!