AvroConvert 3.3.6

.NET 6.0 .NET Standard 2.0 
dotnet add package AvroConvert --version 3.3.6
NuGet\Install-Package AvroConvert -Version 3.3.6
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="AvroConvert" Version="3.3.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add AvroConvert --version 3.3.6
#r "nuget: AvroConvert, 3.3.6"
#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. 
// Install AvroConvert as a Cake Addin
#addin nuget:?package=AvroConvert&version=3.3.6

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

<p align="center"> <img alt="SolTechnology-logo" src="./docs/logo.png" width="200"> </p>

<h2 align="center"> AvroConvert </h2>

<p align="center"> <a> Rapid Avro serializer for C# .NET </a> </p>

<p align="center"> <a href="https://www.nuget.org/packages/AvroConvert"><img src="https://img.shields.io/badge/Nuget-v3.3.6-blue?logo=nuget"></a> <a href="https://avroconvertonline.azurewebsites.net/"><img src="https://img.shields.io/badge/Downloads-378k-blue?logo=github"></a> <a href="https://github.com/AdrianStrugala/AvroConvert/actions/workflows/build&test.yml"><img src="https://github.com/AdrianStrugala/AvroConvert/actions/workflows/build&test.yml/badge.svg"></a>

</p>

Docs

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

Apache Wiki

Apache Avro format documentation

AvroConvert Documentation

First steps with Avro in the .NET article

Benchmark and Avro API article

Benefits

Introducing Avro to the projects brings three main benefits:

  • Reduction of data size and storage cost
  • Decrease of the communication time and the network traffic between microservices
  • Increased security - the data is not visible in plain text format

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 encryption ✔️ ✔️ ❌

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 data size 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

  1. AvroConvertOnline - online Avro Schema to C# model converter

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

  3. Nuget - Library containing components needed for Confluent Kafka integration

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  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 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
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.3.6 126 5/29/2023
3.3.5 1,115 5/11/2023
3.3.4 13,888 3/3/2023
3.3.3 324 2/28/2023
3.3.2 15,674 2/6/2023
3.3.1 1,950 1/27/2023
3.3.0 36,667 10/11/2022
3.2.9 34,040 6/22/2022
3.2.8 1,892 6/1/2022
3.2.7 1,877 5/23/2022
3.2.6 671 5/16/2022
3.2.5 40,356 4/13/2022
3.2.4 718 4/10/2022
3.2.3 26,063 10/29/2021
3.2.2 18,955 10/2/2021
3.2.1 855 9/29/2021
3.2.0 2,086 9/14/2021
3.1.5 18,884 8/30/2021
3.1.4 2,732 8/12/2021
3.1.3 2,891 8/2/2021
3.1.2 4,164 6/24/2021
3.1.1 1,053 6/14/2021
3.1.0 13,553 5/15/2021
3.0.1 3,721 4/2/2021
3.0.0 23,459 3/26/2021
2.7.1 39,229 2/5/2021
2.7.0 33,957 12/18/2020
2.6.3 3,020 10/25/2020
2.6.2 407 10/23/2020
2.6.1 3,483 7/25/2020
2.6.0 471 7/22/2020
2.5.1 1,315 6/11/2020
2.5.0 9,265 5/15/2020
2.4.1 1,337 4/14/2020
2.4.0 813 3/25/2020
2.3.0 670 3/19/2020
2.2.2 933 2/7/2020
2.2.1 475 2/7/2020
2.2.0 569 1/27/2020
2.1.0 488 1/16/2020
2.0.0 460 1/4/2020
1.8.1 756 12/9/2019
1.8.0 2,627 8/30/2019
1.7.0 527 8/22/2019
1.6.0 544 7/22/2019
1.5.1 582 7/14/2019
1.5.0 634 7/11/2019
1.4.0 527 6/17/2019
1.3.0 573 6/4/2019
1.2.0 621 6/3/2019
1.1.0 566 5/28/2019
1.0.1 639 5/21/2019
1.0.0 916 4/24/2019
0.8.0 857 5/1/2019
0.7.0 904 4/22/2019
0.6.3 856 4/19/2019
0.6.2 869 4/19/2019
0.6.1 836 4/19/2019
0.6.0 867 4/19/2019
0.5.0 940 4/18/2019
0.3.0 1,087 4/11/2019
0.2.1 880 4/11/2019
0.2.0 901 4/11/2019
0.1.0 899 4/10/2019