AvroConvert 3.3.1
dotnet add package AvroConvert --version 3.3.1
NuGet\Install-Package AvroConvert -Version 3.3.1
<PackageReference Include="AvroConvert" Version="3.3.1" />
paket add AvroConvert --version 3.3.1
#r "nuget: AvroConvert, 3.3.1"
// Install AvroConvert as a Cake Addin
#addin nuget:?package=AvroConvert&version=3.3.1
// Install AvroConvert as a Cake Tool
#tool nuget:?package=AvroConvert&version=3.3.1
Avro format combines readability of JSON and data compression of binary serialization.
Apache Avro format 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 | ✔️ | ✔️ | ❌ |
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);
Related Work
AvroConvertOnline - online Avro Schema to C# model converter
- Library containing functionalities, which enable communication between microservices via Http using Avro data format
- 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 | 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 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETStandard 2.0
- BrotliSharpLib (>= 0.3.3)
- FastMember (>= 1.5.0)
- IronSnappy (>= 1.3.1)
- Microsoft.CSharp (>= 4.7.0)
- Newtonsoft.Json (>= 13.0.2)
- Portable.System.DateTimeOnly (>= 6.0.2)
-
net6.0
- BrotliSharpLib (>= 0.3.3)
- FastMember (>= 1.5.0)
- IronSnappy (>= 1.3.1)
- Newtonsoft.Json (>= 13.0.2)
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.1 | 96 | 1/27/2023 |
3.3.0 | 11,143 | 10/11/2022 |
3.2.9 | 21,305 | 6/22/2022 |
3.2.8 | 1,697 | 6/1/2022 |
3.2.7 | 1,736 | 5/23/2022 |
3.2.6 | 530 | 5/16/2022 |
3.2.5 | 28,344 | 4/13/2022 |
3.2.4 | 579 | 4/10/2022 |
3.2.3 | 23,113 | 10/29/2021 |
3.2.2 | 17,659 | 10/2/2021 |
3.2.1 | 795 | 9/29/2021 |
3.2.0 | 2,018 | 9/14/2021 |
3.1.5 | 17,313 | 8/30/2021 |
3.1.4 | 2,481 | 8/12/2021 |
3.1.3 | 2,839 | 8/2/2021 |
3.1.2 | 4,085 | 6/24/2021 |
3.1.1 | 1,001 | 6/14/2021 |
3.1.0 | 9,529 | 5/15/2021 |
3.0.1 | 2,803 | 4/2/2021 |
3.0.0 | 22,728 | 3/26/2021 |
2.7.1 | 31,484 | 2/5/2021 |
2.7.0 | 33,678 | 12/18/2020 |
2.6.3 | 2,975 | 10/25/2020 |
2.6.2 | 362 | 10/23/2020 |
2.6.1 | 3,300 | 7/25/2020 |
2.6.0 | 434 | 7/22/2020 |
2.5.1 | 1,273 | 6/11/2020 |
2.5.0 | 4,128 | 5/15/2020 |
2.4.1 | 1,282 | 4/14/2020 |
2.4.0 | 766 | 3/25/2020 |
2.3.0 | 620 | 3/19/2020 |
2.2.2 | 885 | 2/7/2020 |
2.2.1 | 433 | 2/7/2020 |
2.2.0 | 528 | 1/27/2020 |
2.1.0 | 450 | 1/16/2020 |
2.0.0 | 419 | 1/4/2020 |
1.8.1 | 721 | 12/9/2019 |
1.8.0 | 2,330 | 8/30/2019 |
1.7.0 | 481 | 8/22/2019 |
1.6.0 | 509 | 7/22/2019 |
1.5.1 | 537 | 7/14/2019 |
1.5.0 | 597 | 7/11/2019 |
1.4.0 | 494 | 6/17/2019 |
1.3.0 | 522 | 6/4/2019 |
1.2.0 | 576 | 6/3/2019 |
1.1.0 | 525 | 5/28/2019 |
1.0.1 | 598 | 5/21/2019 |
1.0.0 | 859 | 4/24/2019 |
0.8.0 | 799 | 5/1/2019 |
0.7.0 | 853 | 4/22/2019 |
0.6.3 | 808 | 4/19/2019 |
0.6.2 | 825 | 4/19/2019 |
0.6.1 | 790 | 4/19/2019 |
0.6.0 | 814 | 4/19/2019 |
0.5.0 | 887 | 4/18/2019 |
0.3.0 | 1,022 | 4/11/2019 |
0.2.1 | 826 | 4/11/2019 |
0.2.0 | 849 | 4/11/2019 |
0.1.0 | 846 | 4/10/2019 |