EzRabbitMQ 0.1.2-beta003

EzRabbitMQ

Library for .Net Core 5 simplifying the usage of rabbitMQ.

Features :

• Optional AppInsight consumer/ message / producer tracing.

• Error handling with optional retry count.

• PollyRetryPolicies on rabbitMQ calls for client resiliency.

Usage

Register services :

services.AddEzRabbitMQ(config); // IConfiguration

Configuration

In AppSettings.json file:

{ 
  "EzRabbitMQ": {
    "HostName": "localhost",
    "UserName": "guest",
    "Password": "guest",
    "Port": 5672
  }
}

Or using environment variables :

// linux example
export EzRabbitMQ__HostName="localhost"

// powershell example
$env:EzRabbitMQ__HostName="localhost"

Send direct message

IProducerService producerService; // use injection to get a IProducerService
producerService.Send(new DirectProducerOptions("ROUTING KEY"), new { Example = 123 });

Send topic message

IProducerService producerService; // use injection to get a IProducerService
producerService.Send(new TopicProducerOptions("TOPIC.SUBTOPIC.*"), new { Example = 123 });

Send fanout message

IProducerService producerService; // use injection to get a IProducerService
producerService.Send(new FanoutProducerOptions(), new { Example = 123 });

Send headers message

IProducerService producerService; // use injection to get a IProducerService
var headerProducer = new HeadersProducerOptions(new()
{
    { "file-type", "jpg" },
    { "theme", "wild" }
});
producerService.Send(headerProducer, new { Example = 123 });

Listen messages using events

You can create EventMailbox mailbox instance and react to messages with the OnMessageReceived event.

// use injection to get a IMailboxService
var mailboxOptions = new DirectMailboxOptions("ROUTING KEY", "MAILBOX NAME");
var mailbox = mailboxService.Create<EventMailbox<DataSample>>(mailboxOptions, new ConsumerOptions());

mailbox.OnMessageReceived += (sender, data) => {
    // data is IMessage<DataSample>
};

Listen direct messages

// use injection to get a IMailboxService
var mailboxOptions = new DirectMailboxOptions("ROUTING KEY", "MAILBOX NAME");
var mailbox = mailboxService.Create<EventMailbox<DataSample>>(mailboxOptions, new ConsumerOptions());

Listen topic messages

// use injection to get a IMailboxService
var mailboxOptions = new TopicMailboxOptions("ROOT.SECTOR-A.*", "MAILBOX NAME");
var mailbox = mailboxService.Create<EventMailbox<DataSample>>(mailboxOptions, new ConsumerOptions());

Listen fanout messages

// use injection to get a IMailboxService
var mailboxOptions = new FanoutMailboxOptions("MAILBOX NAME");
var mailbox = mailboxService.Create<EventMailbox<DataSample>>(mailboxOptions, new ConsumerOptions());

Listen headers messages

// use injection to get a IMailboxService
var converterToGifMailboxOptions = new HeadersMailboxOptions(new()
{
    { "type", "jpg" },
    { "type", "png" }
}, XMatch.Any, "converter-to-gif");
var converterToGifMailbox = mailboxService.Create<EventMailbox<DataSample>>(converterToGifMailboxOptions, new ConsumerOptions());

var thumbnailCreatorMailboxOptions = new HeadersMailboxOptions(new()
{
    { "type", "gif" },
    { "target", "avatar" }
}, XMatch.All, "thumbnail-creator");
var thumbnailCreatorMailbox = mailboxService.Create<EventMailbox<DataSample>>(thumbnailCreatorMailboxOptions, new ConsumerOptions());

Listen messages using implementation

Or you can implement your own Mailbox inheriting Mailbox<T>, you will have to implement the OnMessage method.

public class MyMailbox<T> : Mailbox<T>
{
    public EventMailbox(
        ILogger<MyMailbox<T>> logger,
        IMailboxOptions options,
        ISessionService session,
        ConsumerOptions consumerOptions
    ) : base(logger, options, null, session, consumerOptions)   { }

    protected override void OnMessage(IMessage<T> data)
    {
        // react to message
    }
}

// use injection to get a IMailboxService
var options = ConsumerOptions.CreateDefaultOptions;
var mailboxOptions = new DirectMailboxOptions("ROUTINg KEY", "MAILBOX NAME");
var mailbox = mailboxService.Create<MyMailbox<DataSample>>(mailboxOptions, options);

ConsumerOptions

This options can add rabbitMQ arguments to enable / disable features.

ConsumerOptions default values:

RetryCount:

You can enable retry on consumer exception by using the consumerOptions object :

var options = new ConsumerOptions
{
    AutoAck = false, // AutoAck must be false to use RetryCount
    RetryCount = 3, // After 3 retry exception in the message will be reject,
};

Durable Queue :

To create a durable queue persistant after server restart :

var options = new ConsumerOptions
{
    QueueDurable = true, // set durable feature on queue (need queue recreation if changed)
    QueueAutoDelete = false. // set auto delete feature on queue (need queue recreation if changed)
};

Durable Exchange :

To create a durable exchange persistant after server restart :

var options = new ConsumerOptions
{
    ExchangeDurable = true, // set durable feature on queue (need queue recreation if changed)
    ExchangeAutoDelete = false. // set auto delete feature on queue (need queue recreation if changed)
};

Exclusive Queue

To allow only one consumer you can enable the Exclusive feature of the queue :

var options = new ConsumerOptions
{
    QueueExclusive  = true, // set exclusive feature on queue (need queue recreation if changed)
};

Limits

To set the prefetch message count limit :

var options = new ConsumerOptions
{
    PrefetchCount = 10, // set the prefetch amount of message read by this consumer
    PrefetchGlobal = false // channel global or by consumer limit
};