Alphacloud.MessagePack.AspNetCore.Formatters 5.0.0-alpha0020

This is a prerelease version of Alphacloud.MessagePack.AspNetCore.Formatters.
dotnet add package Alphacloud.MessagePack.AspNetCore.Formatters --version 5.0.0-alpha0020
                    
NuGet\Install-Package Alphacloud.MessagePack.AspNetCore.Formatters -Version 5.0.0-alpha0020
                    
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="Alphacloud.MessagePack.AspNetCore.Formatters" Version="5.0.0-alpha0020" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Alphacloud.MessagePack.AspNetCore.Formatters" Version="5.0.0-alpha0020" />
                    
Directory.Packages.props
<PackageReference Include="Alphacloud.MessagePack.AspNetCore.Formatters" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Alphacloud.MessagePack.AspNetCore.Formatters --version 5.0.0-alpha0020
                    
#r "nuget: Alphacloud.MessagePack.AspNetCore.Formatters, 5.0.0-alpha0020"
                    
#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.
#:package Alphacloud.MessagePack.AspNetCore.Formatters@5.0.0-alpha0020
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Alphacloud.MessagePack.AspNetCore.Formatters&version=5.0.0-alpha0020&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Alphacloud.MessagePack.AspNetCore.Formatters&version=5.0.0-alpha0020&prerelease
                    
Install as a Cake Tool

MessagePack Formatters for ASP.NET Core MVC and HttpClient

Allows to use MessagePack format with ASP.NET Core MVC. If multiple formatters are configured, content negotiation is used to determine which formatter to use.

This library leverages MessagePack-CSharp library by Yoshifumi Kawai (a.k.a. neuecc).

Build status

Stable Pre-release
Build Master PreRelease
NuGet ASP.NET Core MVC formatters NuGet NuGet
NuGet MediaTypeFormatter for HttpClient NuGet NuGet

Packages

ASP.NET Core MVC formatters

Installation

Install-Packagge Alphacloud.MessagePack.AspNetCore.Formatters

Features

  • Input formatter (decode MessagePack payload).
  • Output formatter (encode MessagePack payload).
  • Source link support (source code on demand in debugger).

Usage

Default configuration

Default configuration uses application/x-msgpack as media typeidentificator, msgpack as file name extension and ContractlessStandardResolver.

Add services.AddMessagePack(); call to your Startup.cs / ConfigureServices

public void ConfigureServices(IServiceCollection services)
{
    services.AddMessagePack();
    // ...
}
MVC Core (ASP.NET Core 2.x)

When using minimal MVC configuration (e.g. in WebAPI service) only base services are added by default. You are responsible for configuring each of the service you are going to use.

Note: order of formatters is important - in the example below Json will be default serializer, unless MVC is configured to reject requests with unsupported media type.

public void ConfigureServices(IServiceCollection services)
{
  services.AddMvcCore(options =>
    {
        // ...
    })
    .AddDataAnnotations()
    .AddJsonOptions(options =>
    {
        options.SerializerSettings.Culture = CultureInfo.InvariantCulture;
        options.SerializerSettings.Formatting = Formatting.None;
    })
    .AddFormatterMappings()
    .AddJsonFormatters()
    .AddXmlSerializerFormatters()
    .AddMsgPackFormatters()
    ;
}

Custom configuration

Default configuration can be changed by providing callback to AddMessagePack method.

Available settings:

  • MediaTypes - allows to specify additional media handled by MessagePack formatters. Default is application/x-msgpack.
  • FormatterResolver - allows to customize serialization, see MsgPack object serialization for details.
  • FileExtensions - allows to specify reponse format URL mapping. Default is msgpack. See sample project or Microsoft Docs for more information.
  • Compression - allows to specify LZ4 compression for messages.
  • UseOldSpecification - write message using old specification compatibility mode. Reading will support both old and new specifications. See Message Pack format specification.
  • OmitAssemblyVersion - don't write assembly version and public key token when using typeless formatter.
  • AllowAssemblyVersionMismatch - allows assembly version mistmatch when loading types during deserialization.
services.AddMessagePack(opt =>
  {
      opt.MediaTypes.Clear();
      opt.MediaTypes.Add("application/x-messagepack");
      opt.FileExtensions.Add("messagepack");
      opt.FormatterResolver = MessagePack.Resolvers.ContractlessStandardResolverAllowPrivate.Instance;
  })

MediaTypeFormatter for HttpClient

Microsoft.AspNet.WebApi.Client package contains adds support for formatting and content negotiation to System.Net.Http. It allows to add custom content serializers by extending MediaTypeFormatter class.

Installation

Install-Package Alphacloud.MessagePack.HttpFormatter

Usage

Sending request

Library contains two extension methods PostAsMsgPackAsync and PutAsMsgPackAsync. To serialize payload ContractlessStandardResolver is used, which gives a JSON-like experience.

var response = await httpClient.PostAsMsgPackAsync(uri, payload, cancellationToken).ConfigureAwait(false);

Reading response

To deserialize Msgpack response, formatter must be added to formatters collection passed to ReadAsAsync extension method.

This is recommeded method as it enables content negotiation.

var res = await response.Content.ReadAsAsync<TestModel>(_formatters, CancellationToken.None);

if you are expecting only MsgPack content, use MsgPackHttpContentExtensions.ReadMsgPackAsAsync() for HttpContent.

Samples

Sample application is located at src/samples/NetCoreWebApi. Sample Postman requests can be found at src/samples/MessagePack.postman_collection.json. To post MessagePack content, use SingleModel.msgpack located under src/samples.

References

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
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
5.0.0-alpha0020 185 3/14/2024
5.0.0-alpha0019 143 3/8/2024
5.0.0-alpha0013 299 4/1/2023
5.0.0-alpha0012 186 3/31/2023
4.1.0 182,989 3/31/2023
4.0.0 13,534 5/30/2022
4.0.0-beta0001 246 5/27/2022
4.0.0-alpha0025 233 5/27/2022
4.0.0-alpha0021 233 5/26/2022
3.2.0 12,366 8/1/2021
3.2.0-alpha0018 362 8/1/2021
3.2.0-alpha0017 370 8/1/2021
3.2.0-alpha0016 363 8/1/2021
3.2.0-alpha0010 302 6/20/2021
3.2.0-alpha0008 330 4/30/2021
3.2.0-alpha0007 360 4/19/2021
3.2.0-alpha0006 360 4/19/2021
3.2.0-alpha0001 324 1/29/2021
3.1.0 5,433 1/29/2021
3.1.0-beta0001 310 1/29/2021
3.1.0-alpha0003 336 1/28/2021
3.1.0-alpha0002 390 12/27/2020
3.1.0-alpha0001 372 12/27/2020
3.0.0 702 12/6/2020
3.0.0-beta0001 440 12/5/2020
2.3.0-alpha0010 472 12/5/2020
2.3.0-alpha0001 436 10/21/2020
2.2.0 2,280 10/21/2020
2.2.0-beta0001 459 10/21/2020
2.2.0-alpha0045 445 10/21/2020
2.2.0-alpha0025 519 2/26/2020
2.2.0-alpha0024 593 2/8/2020
2.2.0-alpha0023 563 2/8/2020
2.2.0-alpha0020 457 8/19/2020
2.2.0-alpha0019 505 6/22/2020
2.2.0-alpha0017 506 5/20/2020
2.2.0-alpha0016 511 5/20/2020
2.2.0-alpha0015 460 5/19/2020
2.2.0-alpha0001 474 3/1/2020
2.1.3 2,507 8/19/2020
2.1.3-beta0001 475 8/19/2020
2.1.2 1,273 5/29/2020
2.1.2-beta0001 477 5/29/2020
2.1.1 1,382 3/1/2020
2.1.1-beta0001 524 3/1/2020
2.1.0 884 2/8/2020
2.1.0-beta0001 552 2/8/2020
2.1.0-alpha0004 563 2/8/2020
2.1.0-alpha0002 599 2/8/2020
2.0.0 1,338 1/14/2020
2.0.0-beta0001 494 1/14/2020
2.0.0-alpha0003 603 1/12/2020
1.1.0-alpha0002 509 11/18/2019
1.0.0 843 11/18/2019
1.0.0-beta0001 518 11/18/2019
0.3.0-alpha0011 506 11/9/2019
0.3.0-alpha0005 567 7/10/2019
0.3.0-alpha0002 542 7/6/2019
0.3.0-alpha0001 563 5/8/2019
0.2.0 1,872 2/5/2019
0.2.0-alpha0019 649 2/4/2019
0.2.0-alpha0018 647 2/4/2019
0.2.0-alpha0016 916 1/28/2019
0.2.0-alpha0013 927 1/27/2019
0.2.0-alpha0001 840 8/19/2018
0.1.0 1,180 8/19/2018
0.1.0-rc0024 838 8/19/2018
0.1.0-beta0001 863 8/19/2018