AvroConvert 3.2.0

Docs

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

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 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(_avroBytes);

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>

Related packages

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

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