Greentube.Serialization.DependencyInjection
1.0.0-alpha2
dotnet add package Greentube.Serialization.DependencyInjection --version 1.0.0-alpha2
NuGet\Install-Package Greentube.Serialization.DependencyInjection -Version 1.0.0-alpha2
<PackageReference Include="Greentube.Serialization.DependencyInjection" Version="1.0.0-alpha2" />
paket add Greentube.Serialization.DependencyInjection --version 1.0.0-alpha2
#r "nuget: Greentube.Serialization.DependencyInjection, 1.0.0-alpha2"
// Install Greentube.Serialization.DependencyInjection as a Cake Addin
#addin nuget:?package=Greentube.Serialization.DependencyInjection&version=1.0.0-alpha2&prerelease
// Install Greentube.Serialization.DependencyInjection as a Cake Tool
#tool nuget:?package=Greentube.Serialization.DependencyInjection&version=1.0.0-alpha2&prerelease
Greentube.Serialization.DependencyInjection 
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<T>
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<T>
with the desired lifetime while having their Options type also registered.
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 |
-
.NETStandard 2.0
- Greentube.Serialization (>= 1.0.0-alpha2)
- Microsoft.Extensions.DependencyInjection (>= 2.0.0)
- Microsoft.Extensions.Options (>= 2.0.0)
NuGet packages (6)
Showing the top 5 NuGet packages that depend on Greentube.Serialization.DependencyInjection:
Package | Downloads |
---|---|
Greentube.Messaging.DependencyInjection
Extensions to configure Greentube.Messaging via Microsoft.Extensions.DependencyInjection. |
|
Greentube.Serialization.DependencyInjection.Xml
Integration of Greentube.Serialization.Xml with Microsoft.DependencyInjection. |
|
Greentube.Serialization.DependencyInjection.ProtoBuf
Integration of Greentube.Serialization.ProtoBuf with Microsoft.DependencyInjection. |
|
Greentube.Serialization.DependencyInjection.Json
Integration of Greentube.Serialization.Json with Microsoft.DependencyInjection. |
|
Greentube.Serialization.DependencyInjection.MessagePack
Integration of Greentube.Serialization.MessagePack with Microsoft.DependencyInjection. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0-alpha2 | 1,904 | 11/26/2017 |
1.0.0-alpha | 724 | 11/25/2017 |