Custom Serializer for Data Bus

Component: NServiceBus
NuGet Package NServiceBus (7.x)
  1. Run the solution. Two console applications start.
  2. Find the Sender application by looking for the one with "Sender" in it's console title and press Enter to send a message. A message is sent that includes a DataBus property that is serialized using a custom JSON serializer.
  3. The sample uses the FileShareDataBus. Open the solution folder in Windows Explorer and navigate to the \storage\ sub-folder. Each sub-folder within the \storage folder contains serialized data bus properties.
The FileShareDataBus does not remove physical attachments once the message has been processed. Apply a custom cleanup-strategy.

Code walk-through

This sample contains three projects:

  • Shared - A class library with messages and the custom data bus serializer.
  • Sender - A console application responsible for sending large messages.
  • Receiver - A console application responsible for receiving large messages from the sender.

Shared project

Look at the custom data bus serializer:

public class JsonDataBusSerializer :
    IDataBusSerializer
{
    public void Serialize(object databusProperty, Stream stream)
    {
        using (var writer = CreateNonClosingStreamWriter(stream))
        using (var jsonWriter = new JsonTextWriter(writer))
        {
            serializer.Serialize(jsonWriter, databusProperty);
        }
    }

    StreamWriter CreateNonClosingStreamWriter(Stream stream)
        => new StreamWriter(
            stream,
            Encoding.UTF8,
            bufferSize: 1024,
            leaveOpen: true);

    public object Deserialize(Stream stream)
    {
        using (var reader = new StreamReader(stream))
        using (var jsonReader = new JsonTextReader(reader))
        {
            return serializer.Deserialize(jsonReader);
        }
    }

    JsonSerializer serializer = JsonSerializer.Create(
        new JsonSerializerSettings
        {
            TypeNameHandling = TypeNameHandling.All
        }
    );
}

The custom serializer implements IDataBusSerializer.

Sender project

The endpoint in the Sender project is configured to use the custom data bus serializer:

endpointConfiguration.RegisterComponents(
    registration: components =>
    {
        components.ConfigureComponent<JsonDataBusSerializer>(DependencyLifecycle.SingleInstance);
    });

var dataBus = endpointConfiguration.UseDataBus<FileShareDataBus>();
dataBus.BasePath(@"..\..\..\..\storage");

Receiver project

The endpoint in the Receiver project must be configured to use the same custom data bus serializer in order to read data bus properties sent by the Sender endpoint:

endpointConfiguration.RegisterComponents(
    registration: components =>
    {
        components.ConfigureComponent<JsonDataBusSerializer>(DependencyLifecycle.SingleInstance);
    });

var dataBus = endpointConfiguration.UseDataBus<FileShareDataBus>();
dataBus.BasePath(@"..\..\..\..\storage");

Related Articles

  • Data Bus
    How to handle messages that are too large to be sent by a transport natively.

Last modified