Skip to content

Simplify.DI

Jump to bottom
Alexanderius edited this page Dec 15, 2022 · 10 revisions

Simplify.DI Documentation

Decouples users and frameworks (that are based on Simplify.DI) from dependency on IOC containers. Instead of that, they will only depend on Simplify.DI interface.

Disciplines and unifies dependencies registration, verification and objects creation.

Provides DIContainer.Current ambient context as centralized IOC container. Provides unified Interface for creation IOC container providers (wrappers) for IOC container frameworks.

Using DIContainer.Current and respective container provider you can switch between any IOC container without rewriting your code and IOC container behavior change. Also as a centralized IOC container you can use it for building, for example, some framework which needs to use constructor injection and at the same time use it by that framework user (example using it in framework: registration, resolving with lifetime scope).

Available at NuGet as binary package

By default DIContainer.Current initialized with DryIocDIProvider container provider (DryIOC).

Another container providers available:

Please create an issue, if you want another container provider.

Main IOC container interface is IDIContainerProvider

Examples

Entities

public interface IFoo
{
}

public class Foo : IFoo
{
    public Foo(IBar bar)
    {
    }
}

public class Foo2 : IFoo
{
    public Foo2(IBar bar, string someParameter)
    {
    }
}

public interface IBar
{
}

public class Bar : IBar
{
}

public class Bar2 : IBar
{
    public Bar2(string someParameter)
    {
    }
}

Registration

// Simple registration
DIContainer.Current.Register<IBar, Bar>()
    .Register<IFoo, Foo>();

// Registration with delegate
DIContainer.Current.Register<IBar>(p => new Bar2("test"));

// Registration with delegate and type resolve
DIContainer.Current.Register<IFoo>(p => new Foo2(p.Resolve<IBar>(), "test"));

Resolve

var myObj = DIContainer.Current.Resolve<IBar>();

Verification

Container verification is a process of building registered objects graph and checking what all required types are present in a container and there is no registrations lifetime mismatches

DIContainer.Current.Verify();

In case of any container mismatches an exception will be thrown, exact type of the exception and messages will depend on current container provider

Scopes

3 type of scopes available:

  • PerLifetimeScope (default scope) - only one instance of the same type will be created inside opened scope
  • Singleton - only one instance will be created per container
  • Transient - new instance will be created on every Resolve request

Using PerLifetimeScope scope

Lifetime scope registration

// Simple registration
DIContainer.Current.Register<IBar, Bar>(LifetimeType.PerLifetimeScope);

// Any dependency while registration with delegate should be resolved with delegate parameter `p`, it is current scope resolve provider.
DIContainer.Current.Register<IFoo>(p => new Foo2(p.Resolve<IBar>(), "Test"), LifetimeType.PerLifetimeScope);

Lifetime scope usage

// Note, what scope.Container actually it is the same container as DIContainer.Current, for example, if using SimpleInjector, but with DryIoc it will be child container.
using (var scope = DIContainer.Current.BeginLifetimeScope())
{
    var myObject = scope.Resolver.Resolve<IFoo>();
}

Registration specific to IOC container

You can use any IOC container to directly register types or perform specific actions, for example, with Simple Injector:

With direct container registration

var provider = new SimpleInjectorDIProvider();
DIContainer.Current = provider;

provider.Container.RegisterSingleton<IFoo>();
...

Standard registrations with SimpleInjector container verification example

var provider = new SimpleInjectorDIProvider();
DIContainer.Current = provider;

...
DIContainer.Current.Register<IBar, Bar>();
...

provider.Container.Verify();

Fluent interfaces example

public static class Program
{
    public static void Main(string[] args)
    {
        var provider = new DryIocDIProvider();

        provider.RegisterAll()
            .Verify();

        using var scope = provider.BeginLifetimeScope();

        scope.Resolver.Resolve<IMyService1>().DoWork();
    }

    private static IDIContainerProvider RegisterAll(this IDIContainerProvider provider)
    {
        provider.RegisterServicesGroup1()
            .RegisterServicesGroup2();

        return provider;
    }

    private static IDIRegistrator RegisterServicesGroup1(this IDIRegistrator registrator) => registrator
            .Register<IMyService1, MyService1>()
            .Register<IMyService2>(r => new MyService2("string parameter example"))
            .Register<IMyService3>(r => new MyService3(r.Resolve<IMyService2>()));

    private static IDIRegistrator RegisterServicesGroup2(this IDIRegistrator registrator) => registrator
            .Register<IMySettings, MySettings>(LifetimeType.Singleton)
            .Register<IUsersRepository, UsersRepository>()
            .Register<IGroupsRepository, GroupsRepository>();

}

Special integrations

Clone this wiki locally