CoreSystem.Serialization 1.0.0

⚡ CoreSystem.Serialization

Production-ready serialization abstraction for .NET 8

CoreSystem.Serialization provides a unified serialization abstraction for .NET applications, allowing you to switch between JSON, MessagePack, and Protocol Buffers without changing your application code. It integrates seamlessly with the Microsoft dependency injection container and exposes a consistent API across all supported serializers.

✨ Features

• ✅ Unified serialization API
• ✅ JSON serialization
• ✅ MessagePack serialization
• ✅ Protocol Buffers serialization
• ✅ Dependency Injection integration
• ✅ Configurable serialization options
• ✅ Common exception model
• ✅ Lightweight and provider-agnostic design

📦 Installation

dotnet add package CoreSystem.Serialization

🚀 Quick Start

Register the framework:

builder.Services.AddCoreSerialization(options =>
{
    options.DefaultSerializer = SerializerType.Json;
});

Inject the serializer factory:

public sealed class ProductService(
    ISerializerFactory serializerFactory)
{
}

Resolve a serializer:

var serializer =
    serializerFactory.GetSerializer(
        SerializerType.Json);

Serialize an object:

byte[] payload =
    serializer.Serialize(product);

Deserialize an object:

Product? product =
    serializer.Deserialize<Product>(payload);

⚙️ Configuration

Customize serialization behavior during registration.

builder.Services.AddCoreSerialization(options =>
{
    // Configure JSON or MessagePack options here.
});

📚 Supported Serializers

JSON

Recommended for:

• Human-readable payloads
• Debugging
• Maximum compatibility

var serializer =
    serializerFactory.GetSerializer(
        SerializerType.Json);

MessagePack

Recommended for:

• High-performance APIs
• Compact payloads
• Low latency

var serializer =
    serializerFactory.GetSerializer(
        SerializerType.MessagePack);

Protocol Buffers

Recommended for:

• Cross-platform communication
• Contract-first serialization
• Compact binary payloads

var serializer =
    serializerFactory.GetSerializer(
        SerializerType.Protobuf);

📦 Payload Format

CoreSystem.Serialization automatically determines how payloads are stored based on the selected serializer.

The serializer identifier allows binary payloads to be deserialized automatically without requiring consumers to know which serializer was originally used.

⚠️ Exception Handling

All serializer-specific exceptions are wrapped in a common exception type.

try
{
    var payload = serializer.Serialize(product);
}
catch (CoreSerializationException ex)
{
    Console.WriteLine(ex.Serializer);
}

📊 Why CoreSystem.Serialization?

Capability Raw Serializer Libraries CoreSystem.Serialization

Unified API ❌ ✅ JSON ✅ ✅ MessagePack ✅ ✅ Protocol Buffers ✅ ✅ Dependency Injection ❌ ✅ Factory Pattern ❌ ✅ Common Exception Model ❌ ✅ Configurable Options Limited ✅

📚 Documentation

The complete documentation includes:

• Getting Started
• Configuration
• JSON Serialization
• MessagePack Serialization
• Protocol Buffers Serialization
• Dependency Injection
• Exception Handling
• Best Practices

Visit the GitHub repository for the complete documentation.

🤝 Contributing

Issues, discussions and pull requests are welcome.

📄 License

Released under the MIT License.