simply_injector 0.1.4

Simply Injector #

Simply Injector is a dart package inspired and based on Simple Injector library.

It is an easy-to-use dependency injection (DI) library and is easily integrated with Flutter.

It’s easy to implement the dependency injection pattern with loosely coupled components using Simply Injector Dart Package.

Configuration #

Add simply_injector to pubspec.yaml under the dependencies field.

dependencies:
  simply_injector: ^latest_version

Import #

Add the following import in your library :

import 'package:simply_injector/simply_injector.dart';

Usage #

Simply Injector's main type is the Container. An instance of Container is used to register mappings between each abstraction (service) and its corresponding implementation (component).

Tip: You should typically create a single Container instance for the whole application (one instance per app domain).

It's possible create an instance of Container by some ways:

var container = new SimplyInjector.Container();

or

var container = new Container();

or using a library prefix to avoid conflict with Flutter's *Container' class:

import 'package:simply_injector/simply_injector.dart' as si;
...
si.Container container = new si.Container();

The first way it's so much elegantly ;)

Example #

This is the main source of complete example project at Simply Injector GitHub repository:

import 'package:simply_injector/simply_injector.dart';

import 'CancelOrder.dart';
import 'CancelOrderHandler.dart';
import 'EventPublisher.dart';
import 'FileLogger.dart';
import 'Guid.dart';
import 'IEventPublisher.dart';
import 'ILogger.dart';
import 'IOrderRepository.dart';
import 'SqlOrderRepository.dart';

main()
{
  // 1. Create a new Simple Injector container
  var container = new SimplyInjector.Container();

  // 2. Configure the container (register)
  container.register<IOrderRepository, SqlOrderRepository>( () => new SqlOrderRepository(container.get<ILogger>()));
  container.register<ILogger, FileLogger>( () => new FileLogger(), Lifestyle.Singleton );
  container.register<IEventPublisher, EventPublisher>( () => new EventPublisher(), Lifestyle.Singleton );

  container.register<CancelOrderHandler, CancelOrderHandler>(()
    => new CancelOrderHandler(
      container.get<IOrderRepository>(),
      container.get<ILogger>(),
      container.get<IEventPublisher>() 
    )
  );

  // 3. Verify your configuration
  container.verify();

  // 4. Use the container
  var handler = container.getInstance<CancelOrderHandler>();

  var args = ['0123456789'];
  var orderId = Guid.Parse(args[0]);
  var command = new CancelOrder(orderId);

  handler.Handle(command);
}

0.1.4 #

  • Dartfmt. Cleaned code.

0.1.3 #

  • Documented classes. Changed repository owner to flutuate.

0.1.2 #

  • License changed. Format sources.

0.1.1 #

  • Health issues and suggestions changes.

0.1.0 #

  • Initial version, created by Luciano Rodrigues

example/main.dart

import 'package:simply_injector/simply_injector.dart';

import 'CancelOrder.dart';
import 'CancelOrderHandler.dart';
import 'EventPublisher.dart';
import 'FileLogger.dart';
import 'Guid.dart';
import 'IEventPublisher.dart';
import 'ILogger.dart';
import 'IOrderRepository.dart';
import 'SqlOrderRepository.dart';

main() {
  // 1. Create a new Simple Injector container
  var container = new SimplyInjector.Container();

  // 2. Configure the container (register)
  container.register<IOrderRepository, SqlOrderRepository>(
      () => new SqlOrderRepository(container.get<ILogger>()));
  container.register<ILogger, FileLogger>(
      () => new FileLogger(), Lifestyle.Singleton);
  container.register<IEventPublisher, EventPublisher>(
      () => new EventPublisher(), Lifestyle.Singleton);

  container.register<CancelOrderHandler, CancelOrderHandler>(() =>
      new CancelOrderHandler(container.get<IOrderRepository>(),
          container.get<ILogger>(), container.get<IEventPublisher>()));

  // 3. Verify your configuration
  container.verify();

  // 4. Use the container
  var handler = container.getInstance<CancelOrderHandler>();

  var args = ['0123456789'];
  var orderId = Guid.Parse(args[0]);
  var command = new CancelOrder(orderId);

  handler.Handle(command);
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  simply_injector: ^0.1.4

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:simply_injector/simply_injector.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
40
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
70
Learn more about scoring.

We analyzed this package on Aug 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:simply_injector/simply_injector.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
meta ^1.1.6 1.1.7
Dev dependencies
test ^1.0.0