AvroConvert 3.3.4

<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.4-blue?logo=nuget"></a> <a href="https://avroconvertonline.azurewebsites.net/"><img src="https://img.shields.io/badge/Downloads-300k-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

Full Changelog

Benchmark

Results of BenchmarkDotNet:

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

Related Work

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

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

3. - 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.