Native integration with RabbitMQ

Component: RabbitMQ Transport
NuGet Package NServiceBus.RabbitMQ (5.x)
Target NServiceBus Version: 7.x

Code walk-through

The sample consists of two console applications, a simple receiver endpoint and a native sender. These endpoints demonstrate how to have senders on other platforms send messages to NServiceBus endpoints. While the .NET RabbitMQ client is used in this sample, the approach demonstrated can be used with any of the official or community native RabbitMQ client libraries.

Putting the message in the correct queue

When integrating native RabbitMQ senders with NServiceBus endpoints, the first thing required is to ensure that the native senders are configured to put the messages in the queue where the endpoint is listening. By default, NServiceBus endpoints will listen on a queue with the same name as the endpoint, so set the endpoint name using:

var endpointConfiguration = new EndpointConfiguration("Samples.RabbitMQ.NativeIntegration");
var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();

With this in place, the native sender can send a message to this endpoint using:

    exchange: string.Empty,
    routingKey: "Samples.RabbitMQ.NativeIntegration",
    mandatory: false,
    basicProperties: properties,
    body: Encoding.UTF8.GetBytes(payload));

Message serialization

In this sample, XML is used to format the payload since NServiceBus is able to automatically detect the message type based on the root node of the XML document. The native sender will send a MyMessage XML string as the message payload.

The root node should be the fully qualified type name (including namespace if it has one) of the message.
var payload = "<MyMessage><SomeProperty>Hello from native sender</SomeProperty></MyMessage>";

The next step is to define a message contract in the receiver that matches the XML-formatted payload. The contract that matches the payload used in this sample looks like this:

public class MyMessage :
    public string SomeProperty { get; set; }

See the message type detection documentation for more details.

Uniquely identifying messages

NServiceBus requires all messages to be uniquely identified in order to be able to perform retries in a safe way. Unfortunately, RabbitMQ doesn't provide a unique ID for messages automatically, so a unique ID has to be generated manually. By default, NServiceBus will look for this message ID in the optional AMQP message-id message header. This behavior can be modified by using a custom message ID strategy to tell NServiceBus to look in a different location for the message ID. Using this custom strategy, the ID can be extracted from any message header, or even the message payload itself.

In this sample, a unique ID is generated on the sender side and assigned to the MessageId property:

var messageId = Guid.NewGuid().ToString();

properties.MessageId = messageId;

Access to the native RabbitMQ message details

The transport adds the native RabbitMQ client BasicDeliverEventArgs to the message processing context. The sample demonstrates this by setting a custom AppId that is accessed in the message handler using the following syntax:

var nativeAppId = context.Extensions.Get<BasicDeliverEventArgs>().BasicProperties.AppId;

Related Articles

Last modified