Solace.SchemaRegistry.Serdes.Avro

Solace Avro Schema Registry SERDES for .NET

A high-performance Apache Avro serialization and deserialization library for Solace event brokers, providing seamless integration with Schema Registry for type-safe messaging.

Features

• Avro Serialization/Deserialization: High-performance async serializers and deserializers for Apache Avro-based messaging
• Schema Registry Integration: Automatic schema resolution and validation through Solace Schema Registry
• Record Strategy: Advanced artifact reference resolution strategy for Avro records
• Type Safety: Compile-time type checking with runtime schema validation
• Configurable: Flexible configuration options for serialization behavior via AvroProperties
• Cross-Platform: Targets .NET Standard 2.0 for broad compatibility

Installation

Install the package from NuGet:

dotnet add package Solace.SchemaRegistry.Serdes.Avro

Or via Package Manager Console:

Install-Package Solace.SchemaRegistry.Serdes.Avro

Quick Start

Basic Usage

using Solace.SchemaRegistry.Serdes.Avro;
using Solace.SchemaRegistry.Serdes.Core.Resolver;
using System.Collections.Generic;
using System.Threading.Tasks;

// Build configuration properties
var configurationProperties = new Dictionary<string, object>
{
    { SchemaResolverPropertyKeys.RegistryUrl, "https://your-registry-url/apis/registry/v3" },
    { SchemaResolverPropertyKeys.AuthUsername, "your-username" },
    { SchemaResolverPropertyKeys.AuthPassword, "your-password" },
    // AvroPropertyKeys constants
    { AvroPropertyKeys.EncodingType, AvroProperties.AvroEncoding.Binary },
    { AvroPropertyKeys.RecordType, AvroProperties.AvroRecordType.GenericRecord }
};

// Configure the serializer
var serializer = new AvroSerializer<MyAvroClass>();
serializer.Configure(configurationProperties);

// Serialize your data asynchronously
byte[] serializedData = await serializer.SerializeAsync("my-topic", myAvroObject, headers);

// Configure the deserializer
var deserializer = new AvroDeserializer<MyAvroClass>();
deserializer.Configure(configurationProperties);

// Deserialize the data asynchronously
MyAvroClass deserializedObject = await deserializer.DeserializeAsync("my-topic", serializedData, headers);

Error Handling

using Solace.SchemaRegistry.Serdes.Avro;
using Solace.Serdes;

try
{
    MyAvroClass result = await deserializer.DeserializeAsync("my-topic", serializedData, headers);
}
catch (SerializationException ex)
{
    // Handle serialization/deserialization errors
    Console.WriteLine($"Avro deserialization failed: {ex.Message}");
}

Resource Management

// Always dispose of serializers and deserializers when done
using var serializer = new AvroSerializer<MyAvroClass>();
using var deserializer = new AvroDeserializer<MyAvroClass>();

Key Classes

• AvroSerializer<T>: Async serializer for converting objects to byte arrays with Avro schema validation
• AvroDeserializer<T>: Async deserializer for converting byte arrays back to objects with Avro schema validation
• AvroPropertyKeys: Configuration key constants for customizing Avro serialization behavior
• Record Strategy: Advanced artifact reference resolution for Avro record handling

Dependencies

• Apache.Avro: Official Apache Avro library for .NET
• Solace.SchemaRegistry.Serdes.Core: Core abstractions and schema registry client

Requirements

• .NET Standard 2.0 or higher
• C# 7.3 or later

Documentation

For detailed documentation and examples, visit Solace Documentation.

License

Licensed under the Solace Community License, Version 1.0. See LICENSE for details.

Support

For questions and support, please visit the Solace Community or refer to the official Solace documentation.

Copyright 2026 Solace Corporation. All rights reserved.