AvroConvert 3.2.9

.NET Standard 2.0
NuGet\Install-Package AvroConvert -Version 3.2.9
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.
dotnet add package AvroConvert --version 3.2.9
<PackageReference Include="AvroConvert" Version="3.2.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AvroConvert --version 3.2.9
#r "nuget: AvroConvert, 3.2.9"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install AvroConvert as a Cake Addin
#addin nuget:?package=AvroConvert&version=3.2.9

// Install AvroConvert as a Cake Tool
#tool nuget:?package=AvroConvert&version=3.2.9

Avro format combines readability of JSON and compression of binary data serialization.

Introduction article

Apache Wiki

General information

Documentation

Benefits

The main purpose of the project was to enhance HTTP communication between microservices. Replacing JSON with Avro brought three main benefits:

  • Decreased the communication time between microservices
  • Reduced the network traffic by about 30%
  • Increased communication security - the data was not visible in plain JSON text

Features

AvroConvert Apache.Avro Newtonsoft.Json
Rapid serialization ✔️ ✔️ ✔️
Easy to use ✔️ ✔️
Built-in compression ✔️ ✔️
Low memory allocation ✔️ ✔️ ✔️
Support for C# data structures: Dictionary, List, DateTime... ✔️ ✔️
Support for compression codecs Deflate<br/> Snappy<br/> GZip<br/> Brotli Deflate
Readable schema of data structure ✔️ ✔️ ✔️
Data is encrypted ✔️ ✔️

Full Changelog

Benchmark

Results of BenchmarkDotNet:

Converter Request Time [ms] Allocated Memory [MB] Compressed Size [kB]
Json 672.3 52.23 6044
Avro 384.7 76.58 2623
Json_Gzip 264.1 88.32 514
Avro_Gzip 181.2 75.05 104
Json_Brotli 222.5 86.15 31
Avro_Brotli 193.5 74.75 31

Article describing Avro format specification and benchmark methodology: https://www.c-sharpcorner.com/blogs/avro-rest-api-as-the-evolution-of-json-based-communication-between-mic

Conclusion: <br> Using Avro for communication between your services significantly reduces communication time and network traffic. Additionally choosing encoding (compression algorithm) can improve the results even further.

Code samples

  • Serialization
 byte[] avroObject = AvroConvert.Serialize(object yourObject);

<br/>

  • Deserialization
CustomClass deserializedObject = AvroConvert.Deserialize<CustomClass>(byte[] avroObject);

<br/>

  • Read schema from Avro object
string schemaInJsonFormat = AvroConvert.GetSchema(byte[] avroObject)

<br/>

  • Deserialization of large collection of Avro objects one by one
using (var reader = AvroConvert.OpenDeserializer<CustomClass>(new MemoryStream(avroObject)))
{
    while (reader.HasNext())
    {
        var item = reader.ReadNext();
        // process item
    }
}
  • Generation of C# models from Avro file or schema
  string resultModel = AvroConvert.GenerateModel(avroObject);
  • Conversion of Avro to JSON directly
  var resultJson = AvroConvert.Avro2Json(avroObject);

Full Documentation

Support

If you find my work useful, you can support it 😃

<p align="center"> <a href="https://www.buymeacoffee.com/adrianstrugala" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 31px !important;width: 130px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a> </p>

Nuget - Library containing functionalities, which enable communication between microservices via Http using Avro data format

Nuget - Library containing extensions for Confluent Kafka platform - used together with Kafka Consumer and Producer

License

The project is CC BY-NC-SA 3.0 licensed.
For commercial purposes purchase AvroConvert on website - Xabe.net

Contribution

We want to improve AvroConvert as much as possible. If you have any idea, found next possible feature, optimization opportunity or better way for integration, leave a comment or pull request.

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
.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
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on AvroConvert:

Package Downloads
SolTechnology.Avro.Kafka

Library containing extensions for Confluent Kafka platform

SolTechnology.Avro.Http

Library containing functionalities, which enable communication between microservices using Avro data format

OptimoveSdk.Engager.Integration

SDK for Engagers intergration with Optimove

SolTechnology.Core.ApiClient

SolTechnology Core API client library

SolTechnology.Core.BlobStorage

SolTechnology Core Azure blob storage library

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.2.9 5,135 6/22/2022
3.2.8 1,317 6/1/2022
3.2.7 1,160 5/23/2022
3.2.6 375 5/16/2022
3.2.5 13,831 4/13/2022
3.2.4 355 4/10/2022
3.2.3 19,959 10/29/2021
3.2.2 16,739 10/2/2021
3.2.1 613 9/29/2021
3.2.0 1,856 9/14/2021
3.1.5 16,704 8/30/2021
3.1.4 2,272 8/12/2021
3.1.3 2,782 8/2/2021
3.1.2 3,972 6/24/2021
3.1.1 944 6/14/2021
3.1.0 7,489 5/15/2021
3.0.1 2,134 4/2/2021
3.0.0 22,464 3/26/2021
2.7.1 27,635 2/5/2021
2.7.0 33,474 12/18/2020
2.6.3 2,910 10/25/2020
2.6.2 298 10/23/2020
2.6.1 3,101 7/25/2020
2.6.0 372 7/22/2020
2.5.1 1,204 6/11/2020
2.5.0 2,751 5/15/2020
2.4.1 1,186 4/14/2020
2.4.0 675 3/25/2020
2.3.0 550 3/19/2020
2.2.2 805 2/7/2020
2.2.1 373 2/7/2020
2.2.0 460 1/27/2020
2.1.0 380 1/16/2020
2.0.0 359 1/4/2020
1.8.1 657 12/9/2019
1.8.0 2,079 8/30/2019
1.7.0 419 8/22/2019
1.6.0 445 7/22/2019
1.5.1 471 7/14/2019
1.5.0 533 7/11/2019
1.4.0 432 6/17/2019
1.3.0 462 6/4/2019
1.2.0 511 6/3/2019
1.1.0 464 5/28/2019
1.0.1 536 5/21/2019
1.0.0 794 4/24/2019
0.8.0 740 5/1/2019
0.7.0 798 4/22/2019
0.6.3 742 4/19/2019
0.6.2 764 4/19/2019
0.6.1 730 4/19/2019
0.6.0 753 4/19/2019
0.5.0 824 4/18/2019
0.3.0 961 4/11/2019
0.2.1 761 4/11/2019
0.2.0 784 4/11/2019
0.1.0 785 4/10/2019