Samhammer.DependencyInjection
6.1.0
See the version list below for details.
dotnet add package Samhammer.DependencyInjection --version 6.1.0
NuGet\Install-Package Samhammer.DependencyInjection -Version 6.1.0
<PackageReference Include="Samhammer.DependencyInjection" Version="6.1.0" />
paket add Samhammer.DependencyInjection --version 6.1.0
#r "nuget: Samhammer.DependencyInjection, 6.1.0"
// Install Samhammer.DependencyInjection as a Cake Addin #addin nuget:?package=Samhammer.DependencyInjection&version=6.1.0 // Install Samhammer.DependencyInjection as a Cake Tool #tool nuget:?package=Samhammer.DependencyInjection&version=6.1.0
Samhammer.DependencyInjection
Usage
How to add this to your project:
- reference this package to your project: https://www.nuget.org/packages/Samhammer.DependencyInjection/
- call ResolveDependencies on the IServiceCollection
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 Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.DependencyInjection (>= 6.0.0)
- Microsoft.Extensions.DependencyModel (>= 6.0.0)
- Microsoft.Extensions.Logging (>= 6.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Samhammer.DependencyInjection:
Package | Downloads |
---|---|
Samhammer.DependencyInjection.Override
Resolving Services for .NET Core projects |
|
Samhammer.SocketServer.ApiClient
Authentication client for .NET Core projects |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.0.0 | 2,163 | 3/8/2024 |
6.1.1 | 5,679 | 4/12/2023 |
6.1.0 | 9,263 | 1/27/2022 |
6.0.0 | 2,962 | 1/20/2022 |
3.1.6 | 782 | 1/27/2022 |
3.1.5.2 | 24,539 | 10/2/2020 |
3.1.5.1 | 427 | 10/1/2020 |
3.1.4 | 653 | 8/12/2020 |
3.1.3 | 529 | 4/28/2020 |
3.1.0 | 1,507 | 3/18/2020 |
2.2.1 | 4,245 | 9/30/2019 |
2.2.0 | 462 | 9/30/2019 |
2.1.0 | 589 | 6/25/2019 |
2.0.0 | 3,291 | 4/15/2019 |
1.0.0 | 562 | 4/10/2019 |