Quickwire 1.3.2

Quickwire

Attribute-based dependency injection for .NET.

Features

• Register services for dependency injection using attributes and reduce boilerplate code.
• Uses the built-in .NET dependency injection container. No need to use a third party container or to change your existing code.
• Full support for property injection.
• Inject configuration settings seamlessly into your services.
• Use configuration selectors to register different implementations based on the current environment.

Quick start

1. Install from NuGet:

dotnet add package Quickwire

2. Activate Quickwire for the current assembly in the AddServices method of the Startup class:

public void ConfigureServices(IServiceCollection services)
{
    services.ScanCurrentAssembly();
}

3. Decorate services with this attribute in order to register them for dependency injection:

[RegisterService]
public class MyService
{
    // ...
}

Registering a service

There are two ways to register a service using Quickwire.

• Apply the [RegisterService] attribute to a class.
• Apply the [RegisterFactory] attribute to a static factory method.

Registering a service using a class

Registration

When applying the [RegisterService] attribute to a class, the class will be registered as the concrete type to use for the service of the same type.

It is also possible to specify the ServiceType property on the [RegisterService] attribute to register the concrete type under a different service type. The ServiceType should be parent type, or interface implemented by the class.

The attribute takes a parameter of type ServiceLifetime to specify the lifetime of the service. If left unspecified, the default is Transient.

Instantiation

By default, Quickwire will use the public constructor to instantiate the concrete type. There must be exactly one public constructor available or an exception will be thrown.

If there are more than one public constructor, or if a non-public constructor should be used, the [ServiceConstructor] should be applied to indicate explicitly and unambiguously which constructor to use.

By default, all the constructor parameters will be resolved using dependency injection, however it is also possible to decorate parameters using the [InjectConfiguration] attribute to inject a configuration setting. It is also possible to use [InjectService(Optional = true)] to make a dependency optional.

Property injection

Property injection can be achieved by decorating a property with a setter with the [InjectService] attribute.

[RegisterService(ServiceLifetime.Singleton)]
public class MyService
{
    [InjectService]
    public IHttpClientBuilder HttpClientBuilder { get; private set; }

    // ...
}

Automatic init-only property injection

By decorating a service class with the [InjectAllInitOnlyProperties] attribute, dependency injection will be performed on all init-only properties in the class.

[RegisterService(ServiceLifetime.Singleton)]
[InjectAllInitOnlyProperties]
public class MyService
{
    public IHttpClientBuilder HttpClientBuilder { get; init; }

    // ...
}

Registering a service using a factory

When applying the [RegisterFactory] attribute to a static method, the static method will be registered as a factory used

By default, all the method parameters will be resolved using dependency injection, however it is also possible to decorate parameters using the [InjectConfiguration] attribute to inject a configuration setting. It is also possible to use [InjectService(Optional = true)] to make a dependency optional.

public static class LoggingConfiguration
{
    [RegisterFactory]
    public static ILogger CreateLogger()
    {
        // ...
    }
}

Configuration setting injection

Constructor parameters, properties and factory parameters can also be decorated with the [InjectConfiguration] attribute in order to inject a configuration setting.

Conversion to most basic types, including enumeration types, is supported.

[RegisterService]
public class MyService
{
    [InjectConfiguration("external_api:url")]
    public string ExternalApiUrl { get; init; }

    [InjectConfiguration("external_api:retries")]
    public int Retries { get; init; }

    [InjectConfiguration("external_api:timeout")]
    public TimeSpan Timeout { get; init; }

    // ...
}

Environment selection

It is possible to disable specific services or service factories using the [EnvironmentSelector] attribute.

[EnvironmentSelector(Enabled = new[] { "Development" })]
public class DebugFactories
{
    // This is only registered in the Development environment
    [RegisterFactory]
    public static ILogger CreateDebugLogger()
    {
        // ...
    }

    // ...
}

Selection based on configuration

It is possible to disable specific services or service factories based on the value of specific configuration settings using the [ConfigurationBasedSelector].

[ConfigurationBasedSelector("logging:mode", "debug")]
public class DebugFactories
{
    // This is only registered if the logging:mode configuration setting is set to "debug"
    [RegisterFactory]
    public static ILogger CreateDebugLogger()
    {
        // ...
    }

    // ...
}

Using Quickwire with ASP.NET Core controllers

By default, controllers in ASP.NET Core are not activated using the dependency injection container. ASP.NET Core does however offer a simple way to change that behavior. In the Startup class, in ConfigureServices, use the following extension method:

public void ConfigureServices(IServiceCollection services)
{
    // Activate controllers using the dependency injection container
    services.AddControllers().AddControllersAsServices();

    services.ScanCurrentAssembly();
}

Then decorate controllers as any other service:

[ApiController]
[Route("[controller]")]
[RegisterService]
public class ShoppingCartController : ControllerBase
{
    [InjectService]
    public IShoppingCartRepository { get; init; }

    // ...
}

Equivalence with Spring Framework in Java

The approach provided by Quickwire in .NET matches closely the approach that can be used in Java with the Spring Framework. The table below outlines the similarities between both approaches.

License

Copyright 2021 Flavien Charlon

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.