Serialization

Component: NServiceBus
NuGet Package NServiceBus (5.x)

NServiceBus takes instances of .NET objects (messages, events, and commands) and sends/receives them over a specified transport. As part of this process, the object must be serialized and deserialized. NServiceBus achieves this using serializers.

When transitioning to a new serializer, messages that are currently 'in-flight' are formatted using the previous serialization format. This includes saga timeout and deferred/delayed messages via timeout persistence.
Make sure all queues of all endpoints are drained and empty, including any failed messages in the error queue and messages that need to be retried in the ServiceControl queue. NServiceBus versions 5 and earlier only support a single serializer/deserializer. Live migration is only supported in NServiceBus versions 6 and above.

The Newtonsoft JSON Serializer provides an effective general-purpose serializer appropriate for most use cases based on the ubiquitous Json.NET package. The Newtonsoft package provides a good combination of compactness, human readability, and performance. Other serializers are supported in order to enable specific performance or integration requirements.

Supported serializers

Using an existing serializer

The default serializer used in NServiceBus projects is the custom XmlSerializer.

The pages dedicated to particular serializers show how to configure the endpoint to use each of them. Unless explicitly configured otherwise, NServiceBus will use XmlSerializer for serializing and deserializing all messages.

The same serializer must be used by the sending endpoint to serialize messages and by the receiving endpoint to deserialize them, unless additional deserializers are specified.

In order to register a community-maintained serializer or custom serializer, refer to the Custom serializers - Register the serializer section.

Samples

Related Articles


Last modified