VL.Messaging.RabbitMQ 1.1.4

RabbitMQ Messaging

A thin wrapper around RabbitMQ that simplifies and standardizes consuming/publishing messages.

Getting Started

1. Install package VL.Messaging.RabbitMQ

   dotnet add package VL.Messaging.RabbitMQ
   

2. Setup the messaging core

   builder.Services.AddRabbitMQMessaging(builder.Configuration);
   

3. Setup a publisher and publish a message

   // Program.cs (DI Setup)
   builder.Services
       .AddRabbitMQMessaging(builder.Configuration)
       .AddMessagePublisher<FooMessage>("exchange", "routing-key");
   
   // FooMessage.cs (Create or reuse a concrete message type)
   public class FooMessage : Message { }
   
   // Use `IMessagePublisher<FooMessage>` and let DI provide a publisher instance
   publisher.PublishAsync(new FooMessage());
   

4. Setup a handler and consume messages

   // Program.cs (DI Setup)
   builder.Services
       .AddRabbitMQMessaging(builder.Configuration)
       .AddMessageConsumer("queue", "exchange")
       .AddMessageHandler<FooMessage, FooMessageHandler>("routing-key");
   
   // FooMessage.cs (Create a concrete message type)
   public class FooMessage : Message { }
   
   // FooMessageHandler.cs (Create a concrete message handler)
   public class FooMessageHandler : MessageHandlerBase<FooMessage>
   {
       public override Task HandleAsync(FooMessage message, CancellationToken cancellationToken = default)
       {
           // Your implementation goes here
       }
   }
   

FAQ

• How to set the expiration time for a certain message type?

  Provide MessagePublisherOptions with the desired expiration time to the message publisher configuration.

  var options = new MessagePublisherOptions
  {
      MessageExpiration = TimeSpan.FromSeconds(30)
  };
  
  builder.Services
      .AddRabbitMQMessaging(builder.Configuration)
      .AddMessagePublisher<FooMessage>("exchange", "routing-key", options);
  

• How to set specific connection settings?

  A custom configuration for the RabbitMQ messaging system can be provided through the Microsoft configuration system. Here is a little example of how it's achieved with the appsettings.json config file.

  {
      // Omitted for brevity
      "Messaging.RabbitMQ": {
          "ConnectionSettings": {
              "HostName": "foo",
              "Port": 8888,
              "Username": "bar",
              "Password": "baz"
          }
      }
  }