Imani.Solutions.RabbitMQ 0.0.1

rabbitmq-dotNet-showCase

This is a reference DotNet Core client/wrapper for connecting with RabbitMQ. It demonstrates the best practice development techniques.

This project implements the builder design pattern for producers and consumers.

Environments or Input Properties

This module uses the ConfigSettings object from the open source Imani Solutions DotNet API. This supports getting string, numbers, secrets or encrypted passwords properties from input arguments or environment variables.

You can set the properties using an environment variable or input argument (prefixed with --PROPERTY_NAME).

Sample Code

Consumer Code

Rabbit rabbit = Rabbit.Connect();
var consumer = rabbit.ConsumerBuilder()
                      .SetExchange(exchange)
                      .AddQueue(queue,expectedRoutingKey)
                      .Build();

consumer.RegisterReceiver(receiver);

private void receiver(IModel channel, object sender, BasicDeliverEventArgs eventArg)
{
  var actual = Encoding.UTF8.GetString(eventArg.Body.ToArray());

  channel.BasicAck(eventArg.DeliveryTag,false);
}

Publisher Code

var msg = Encoding.UTF8.GetBytes(expectedMsg);
RabbitPublisher publisher = subject.PublishBuilder().
            SetExchange(exchange)
            .AddQueue(queue,expectedRoutingKey)
            .Build();
        

string routingKey = "";
publisher.Publish(msg, routingKey);

Best Practices

Client Side

• Use Quorum queues for consistency
• Enable auto reconnect for connections
• Use one connection per process
• Use one channel per thread
• Enable handlers to detect blocked connections'
• Use Durable exchanges, durable queues and persistent messages for reliablity
• Set auto delete on temporary queues
• Set client name to assist with identifying application connections
• Keep exchange names the same case for producers and consumers

Client Publisher Side

• Use Publisher confirms for consistency
• Add a handler for BasicReturn when messages not routed to a queue
• Set the mandatory message property to true to prevent Unroutable messages.

Client Consumer Side

• Use manual ACK for consumers per message
• Set Prefetch limit for consumers
  • Set the prefetch limit (round trip latency/processing time) (ex: MAX 1K)
• If you use dead letter exchanges/queues set to a very high count since DLX do not support confirmation and can lost messages
• Use consumer (push) over get (pull)
• Name queues based on patterns of routing keys where applicable