Greentube.Serialization.DependencyInjection 1.0.0-alpha2

Integration of Greentube.Serialization with Microsoft.DependencyInjection.

This is a prerelease version of Greentube.Serialization.DependencyInjection.
Install-Package Greentube.Serialization.DependencyInjection -Version 1.0.0-alpha2
dotnet add package Greentube.Serialization.DependencyInjection --version 1.0.0-alpha2
<PackageReference Include="Greentube.Serialization.DependencyInjection" Version="1.0.0-alpha2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Greentube.Serialization.DependencyInjection --version 1.0.0-alpha2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Greentube.Serialization.DependencyInjection NuGet

By extending the Microsoft.Extensions.DependencyInjection it's possible to expose a simple fluent API to add a serializer to the container.
With that, it's easy to consume ISerializer via dependency injection.

Two hooks are provided by this package. A SerializationBuilder and extensions on IServiceCollection directly.

Extensions to IServiceCollection

Consider you have an implementation of type NoOpSerializer.

class NoOpSerializer : ISerializer
{
    public byte[] Serialize<T>(T @object) => null;
    public object Deserialize(Type type, byte[] bytes) => null;
}

It could be registered like:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSerializer<NoOpSerializer>(ServiceLifetime.Singleton);
}

In case NoOpSerializer depends on some options:

class NoOpOptions { }

class NoOpSerializer : ISerializer
{
    private NoOpOptions _options;
    public NoOpSerializer(NoOpOptions options) => _options = options;

    public byte[] Serialize<T>(T @object) => null;
    public object Deserialize(Type type, byte[] bytes) => null;
}

Registration can be done as:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSerializer<NoOpSerializer, NoOpOptions>(ServiceLifetime.Singleton);
}

The options type provided will use the framework Microsoft.Extensions.Options for configuration. That means that values provided to the options instance could be defined via configuration files in different formats and even environment variables. For more information on MEO, refer to Microsoft documentation.

Note that there's no dependency on IOptions&lt;T&gt; from NoOpSerializer's constructor. That allows decoupling between the assembly where NoOpSerializer was defined and Microsoft.Extensions.Options.

SerializationBuilder

Besides adding the serializer directly to ServiceCollection, it's possible to use the builder. This allows other libraries to expose AddSerializer through their own builders and have a more fluent API when setting up libraries that require serialization.

public void ConfigureServices(IServiceCollection services)
{
    services.AddSerialization(builder =>
        builder.AddSerializer<NoOpSerializer>(ServiceLifetime.Singleton);
    );
}

This assembly was created to allow implementations have their own extension methods like:

  • AddJson
  • AddProtoBuf
  • AddXml
  • AddMessagePack
  • etc

Which in turn simply call AddSerializer&lt;T&gt; with the desired lifetime while having their Options type also registered.

Greentube.Serialization.DependencyInjection NuGet

By extending the Microsoft.Extensions.DependencyInjection it's possible to expose a simple fluent API to add a serializer to the container.
With that, it's easy to consume ISerializer via dependency injection.

Two hooks are provided by this package. A SerializationBuilder and extensions on IServiceCollection directly.

Extensions to IServiceCollection

Consider you have an implementation of type NoOpSerializer.

class NoOpSerializer : ISerializer
{
    public byte[] Serialize<T>(T @object) => null;
    public object Deserialize(Type type, byte[] bytes) => null;
}

It could be registered like:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSerializer<NoOpSerializer>(ServiceLifetime.Singleton);
}

In case NoOpSerializer depends on some options:

class NoOpOptions { }

class NoOpSerializer : ISerializer
{
    private NoOpOptions _options;
    public NoOpSerializer(NoOpOptions options) => _options = options;

    public byte[] Serialize<T>(T @object) => null;
    public object Deserialize(Type type, byte[] bytes) => null;
}

Registration can be done as:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSerializer<NoOpSerializer, NoOpOptions>(ServiceLifetime.Singleton);
}

The options type provided will use the framework Microsoft.Extensions.Options for configuration. That means that values provided to the options instance could be defined via configuration files in different formats and even environment variables. For more information on MEO, refer to Microsoft documentation.

Note that there's no dependency on IOptions&lt;T&gt; from NoOpSerializer's constructor. That allows decoupling between the assembly where NoOpSerializer was defined and Microsoft.Extensions.Options.

SerializationBuilder

Besides adding the serializer directly to ServiceCollection, it's possible to use the builder. This allows other libraries to expose AddSerializer through their own builders and have a more fluent API when setting up libraries that require serialization.

public void ConfigureServices(IServiceCollection services)
{
    services.AddSerialization(builder =>
        builder.AddSerializer<NoOpSerializer>(ServiceLifetime.Singleton);
    );
}

This assembly was created to allow implementations have their own extension methods like:

  • AddJson
  • AddProtoBuf
  • AddXml
  • AddMessagePack
  • etc

Which in turn simply call AddSerializer&lt;T&gt; with the desired lifetime while having their Options type also registered.

Version History

Version Downloads Last updated
1.0.0-alpha2 262 11/26/2017
1.0.0-alpha 163 11/25/2017