Samhammer.DependencyInjection.Override 6.1.0

.NET Standard 2.0
dotnet add package Samhammer.DependencyInjection.Override --version 6.1.0
NuGet\Install-Package Samhammer.DependencyInjection.Override -Version 6.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Samhammer.DependencyInjection.Override" Version="6.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Samhammer.DependencyInjection.Override --version 6.1.0
#r "nuget: Samhammer.DependencyInjection.Override, 6.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Samhammer.DependencyInjection.Override as a Cake Addin
#addin nuget:?package=Samhammer.DependencyInjection.Override&version=6.1.0

// Install Samhammer.DependencyInjection.Override as a Cake Tool
#tool nuget:?package=Samhammer.DependencyInjection.Override&version=6.1.0

Samhammer.DependencyInjection

Usage

How to add this to your project:
services.ResolveDependencies();
How to register a class as service
  • add Inject attribute to the class
  • set target optionally (default: Matching)
  • set servicelifetime optionally (default: Scoped)
Target Matching
  • will register as service to interface with same name as class (IClassname)
[Inject(Target.Matching, ServiceLifetime.Scoped)]
public class Class : IClass
{
}

public interface IClass : IBaseClass
{
}

public interface IBaseClass
{
}
Target All
  • will register as service to all implemented interfaces of class
  • ATTENTION with lifetime singleton / scoped. Each interface service returns his own instance of the class
[Inject(Target.All, ServiceLifetime.Scoped)]
public class Class : IClass
{
}

public interface IClass : IBaseClass
{
}

public interface IBaseClass
{
}
How to register a class as service with specific type
  • add InjectAs attribute to the class
  • add interface or class as paramter is required (class will register to this type)
[InjectAs(typeof(IServiceToRegister))]
public class ClassWithSpecificService: IServiceToRegister, IServiceNotRegister
{
}

public interface IServiceToRegister
{
}

public interface IServiceNotRegister
{
}
How to register a instance as service
  • add Factory attribute to the factory class
  • add at least one public static method with parameter IServiceProvider
  • the returned instance will be registered to the return type of method
[Factory]
public class Factory
{
    public static IClassFromFactory Build(IServiceProvider serviceProvider)
    {
        return new ClassFromFactory();
    }
}

Configuration

Starting with version 3.1.5 all customizations needs to be done with the options action.

The registrations to servicecollection will no longer be used because we dont want to use ioc to setup ioc. @see also https://docs.microsoft.com/de-de/dotnet/core/compatibility/2.2-3.1#hosting-generic-host-restricts-startup-constructor-injection

How to enable logging?

By default the project will not do any logging, but you can activate it. This will require that you provide an ILoggerFactory from Microsoft.Extensions.Logging.

Sample with microsoft console logger.
var loggerFactory = LoggerFactory.Create(builder => builder.AddConsole().SetMinimumLevel(LogLevel.Debug));
services.ResolveDependencies(options => options.SetLogging(loggerFactory));
Sample with serilog logger. (you need to setup serilog before)
services.ResolveDependencies(options => options.SetLogging(new SerilogLoggerFactory()));
How to change assembly resolving strategy?

By default the project will only resolve types of project assemblies, but not on packages or binaries. But you can replace the default strategy with your own implementation.

services.ResolveDependencies(options => options.SetAssemblyStrategy(new MyAssemblyResolvingStrategy()));
How to change type resolving strategy?

It is possible to change the way types are found by the DependencyInjectionAttribute. Also one could change the naming schema of interfaces by using a custom type resolving strategy.

services.ResolveDependencies(options => options.SetTypeStrategy(new MyTypeResolvingStrategy()));
How to add additional service provider

By default the project will only resolve types with Inject attributes. But you can add additonal resolving provider with your own implementation.

services.ResolveDependencies(options => options.AddProvider<MyServiceDescriptorProvider>((logger, o) => new MyServiceDescriptorProvider(logger, o)));

Using overrides

You can use overrides to have a different behavior depending on the configuration used on resolving dependencies.

Just add the override attribute to a new class that inherits a class with one of the dependency injection attributes. As soon as the configuration matches "MyConfigName" your original implementation will be overwritten by the implementation of this class.

Classes with non matching configuration names are not registered.

[Override("MyConfigName")]
public class MyConfigNameOverride : InjectParentClass
{
}

[Override("OtherConfigName")]
public class OtherConfigNameOverride : InjectParentClass
{
}

[Inject]
public class InjectParentClass : IInjectParentClass
{
}

public interface IInjectParentClass
{
}

How to use

Add this nuget package to your project: https://www.nuget.org/packages/Samhammer.DependencyInjection.Override/

serviceCollection.ResolveDependencies(o => { o.UseOverride("MyConfigName"); });

Contribute

How to publish package
  • Create a tag and let the github action do the publishing for you
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.1.0 1,553 1/27/2022
3.1.6 356 1/27/2022