AvroConvert 2.3.0
See the version list below for details.
dotnet add package AvroConvert --version 2.3.0
NuGet\Install-Package AvroConvert -Version 2.3.0
<PackageReference Include="AvroConvert" Version="2.3.0" />
paket add AvroConvert --version 2.3.0
#r "nuget: AvroConvert, 2.3.0"
// Install AvroConvert as a Cake Addin
#addin nuget:?package=AvroConvert&version=2.3.0
// Install AvroConvert as a Cake Tool
#tool nuget:?package=AvroConvert&version=2.3.0
AvroConvert
Avro format combines readability of JSON format and compression of binary data serialization. <br></br>
The main purpose of the project was to enhance communication between microservices. Replacing JSON with Avro brought two main benefits:
- Reduced amount of data send via HTTP by about 30%
- Increased communication security - the data was not visible in plain JSON text
Documentation
General information: http://avro.apache.org/
Wiki: https://cwiki.apache.org/confluence/display/AVRO/Index
Why choose Avro?
Benchmark with comparison to Newtonsoft.Json:
Converter | Compression time [ms] | Compressed size [kB] |
---|---|---|
Json | 140 | 9945 |
Avro (null encoding) | 235 | 2435 |
Avro (Deflate encoding) | 144 | 206 |
Avro (Snappy encoding) | 127 | 420 |
Avro (Gzip encoding) | 143 | 206 |
You can find the benchmark under tests/AvroConvertTests/Benchmark directory.
Conclusion: <br> Using Avro for communication between your services reduces up to almost 50 times (!!!) network traffic. This makes huge time and bandwidth savings.
Code samples
Serialization
byte[] avroObject = AvroConvert.Serialize(object yourObject);
Using encoding
byte[] avroObject = AvroConvert.Serialize(object yourObject, CodecType.Snappy);
Supported encoding types:
- Null (default)
- Deflate
- Snappy
- GZip
Deserialization
//Using generic method
CustomClass deserializedObject = AvroConvert.Deserialize<CustomClass>(byte[] avroObject);
//Using dynamic method
CustomClass deserializedObject = AvroConvert.Deserialize(byte[] avroObject, typeof(CustomClass));
Deserialization when a property value is null, but schema contains information about default value
//Model used for serialization
public class DefaultValueClass
{
[DefaultValue("Let's go")]
public string justSomeProperty { get; set; }
[DefaultValue(2137)]
public long? andLongProperty { get; set; }
}
//Deserializing object with null data
DefaultValueClass deserializedObject = AvroConvert.Deserialize<DefaultValueClass>(byte[] avroObject);
//Produces following object:
> deserializedObject.justSomeProperty
> "Let's go"
> deserializedObject.andLongProperty
> 2137
Generating Avro schema for C# classes
Using simple class
//Model
public class SimpleTestClass
{
public string justSomeProperty { get; set; }
public long andLongProperty { get; set; }
}
//Action
string schemaInJsonFormat = AvroConvert.GenerateSchema(typeof(SimpleTestClass));
//Produces following schema:
"{"type":"record","name":"AvroConvert.SimpleTestClass","fields":[{"name":"justSomeProperty","type":["null","string"]},{"name":"andLongProperty","type":"long"}]}"
Using class decorated with attributes
//Model
[DataContract(Name = "User", Namespace = "user")]
public class AttributeClass
{
[DataMember(Name = "name")]
public string StringProperty { get; set; }
[DataMember(Name = "favorite_number")]
[NullableSchema]
public int? NullableIntProperty { get; set; }
[DataMember(Name = "favorite_color")]
public string AndAnotherString { get; set; }
}
//Action
string schemaInJsonFormat = AvroConvert.GenerateSchema(typeof(AttributeClass));
//Produces following schema:
"{"type":"record","name":"user.User","fields":[{"name":"name","type":["null","string"]},{"name":"favorite_number","type":["null","int"]},{"name":"favorite_color","type":["null","string"]}]}"
Reading Avro schema from Avro encoded object
string schemaInJsonFormat = AvroConvert.GetSchema(byte[] avroObject)
License
AvroConvert is licensed under Attribution-NonCommercial-ShareAlike 3.0 Unported (CC BY-NC-SA 3.0) - see License for details. For commercial purposes purchase AvroConvert on website - Xabe
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 Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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. net8.0 was computed. 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. |
.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. |
-
.NETStandard 2.0
- AutoMapper (>= 8.0.0)
- Newtonsoft.Json (>= 12.0.2)
NuGet packages (6)
Showing the top 5 NuGet packages that depend on AvroConvert:
Package | Downloads |
---|---|
SolTechnology.Avro.Kafka
Library containing extensions for Confluent Kafka platform |
|
Memphis.Client
Memphis.Client SDK intended to make easy integration of Memphis into .NET projects |
|
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 |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
3.4.7 | 336 | 4/26/2024 | |
3.4.6 | 7,358 | 3/4/2024 | |
3.4.5 | 2,755 | 2/15/2024 | |
3.4.4 | 6,780 | 1/16/2024 | |
3.4.3 | 30,794 | 12/9/2023 | |
3.4.2 | 3,047 | 12/1/2023 | |
3.4.1 | 8,511 | 11/11/2023 | |
3.4.0 | 17,967 | 9/18/2023 | |
3.3.7 | 13,145 | 8/7/2023 | |
3.3.6 | 25,198 | 5/29/2023 | |
3.3.5 | 6,938 | 5/11/2023 | |
3.3.4 | 40,387 | 3/3/2023 | |
3.3.3 | 546 | 2/28/2023 | |
3.3.2 | 20,930 | 2/6/2023 | |
3.3.1 | 2,755 | 1/27/2023 | |
3.3.0 | 79,909 | 10/11/2022 | |
3.2.9 | 72,897 | 6/22/2022 | |
3.2.8 | 2,036 | 6/1/2022 | |
3.2.7 | 1,997 | 5/23/2022 | |
3.2.6 | 775 | 5/16/2022 | |
3.2.5 | 59,791 | 4/13/2022 | |
3.2.4 | 803 | 4/10/2022 | |
3.2.3 | 29,231 | 10/29/2021 | |
3.2.2 | 24,452 | 10/2/2021 | |
3.2.1 | 983 | 9/29/2021 | |
3.2.0 | 2,623 | 9/14/2021 | |
3.1.5 | 22,950 | 8/30/2021 | |
3.1.4 | 3,859 | 8/12/2021 | |
3.1.3 | 3,856 | 8/2/2021 | |
3.1.2 | 4,285 | 6/24/2021 | |
3.1.1 | 1,137 | 6/14/2021 | |
3.1.0 | 21,014 | 5/15/2021 | |
3.0.1 | 5,679 | 4/2/2021 | |
3.0.0 | 24,237 | 3/26/2021 | |
2.7.1 | 54,139 | 2/5/2021 | |
2.7.0 | 34,534 | 12/18/2020 | |
2.6.3 | 3,079 | 10/25/2020 | |
2.6.2 | 469 | 10/23/2020 | |
2.6.1 | 3,754 | 7/25/2020 | |
2.6.0 | 548 | 7/22/2020 | |
2.5.1 | 1,402 | 6/11/2020 | |
2.5.0 | 14,951 | 5/15/2020 | |
2.4.1 | 1,420 | 4/14/2020 | |
2.4.0 | 927 | 3/25/2020 | |
2.3.0 | 755 | 3/19/2020 | |
2.2.2 | 1,036 | 2/7/2020 | |
2.2.1 | 553 | 2/7/2020 | |
2.2.0 | 647 | 1/27/2020 | |
2.1.0 | 544 | 1/16/2020 | |
2.0.0 | 534 | 1/4/2020 | |
1.8.1 | 825 | 12/9/2019 | |
1.8.0 | 3,146 | 8/30/2019 | |
1.7.0 | 595 | 8/22/2019 | |
1.6.0 | 619 | 7/22/2019 | |
1.5.1 | 695 | 7/14/2019 | |
1.5.0 | 723 | 7/11/2019 | |
1.4.0 | 593 | 6/17/2019 | |
1.3.0 | 627 | 6/4/2019 | |
1.2.0 | 684 | 6/3/2019 | |
1.1.0 | 639 | 5/28/2019 | |
1.0.1 | 729 | 5/21/2019 | |
1.0.0 | 987 | 4/24/2019 | |
0.8.0 | 941 | 5/1/2019 | |
0.7.0 | 994 | 4/22/2019 | |
0.6.3 | 926 | 4/19/2019 | |
0.6.2 | 945 | 4/19/2019 | |
0.6.1 | 889 | 4/19/2019 | |
0.6.0 | 922 | 4/19/2019 | |
0.5.0 | 1,027 | 4/18/2019 | |
0.3.0 | 1,177 | 4/11/2019 | |
0.2.1 | 965 | 4/11/2019 | |
0.2.0 | 966 | 4/11/2019 | |
0.1.0 | 1,010 | 4/10/2019 |