NanoRabbit 0.0.4

About

NanoRabbit, A Lightweight RabbitMQ .NET API for .NET 6.

Installation

You can get NanoRabbit by grabbing the latest NuGet package.

Version

Document

The NanoRabbit Document is at NanoRabbit Wiki.

QuickStart

NanoRabbit is designed as a library depends on NAMING Connections, Producers, Consumers. So it's important to set a UNIQUE NAME for each Connections, Producers, Consumers.

For more, please visit the Examples.

Register a Connection

Register a RabbitMQ Connection by instantiating RabbitPool, and configure the producer and consumer.

var pool = new RabbitPool();
pool.RegisterConnection(new ConnectOptions("Connection1", option =>
{
    option.ConnectConfig = new(config =>
    {
        config.HostName = "localhost";
        config.Port = 5672;
        config.UserName = "admin";
        config.Password = "admin";
        config.VirtualHost = "DATA";
    });
    option.ProducerConfigs = new List<ProducerConfig>
    {
        new ProducerConfig("DataBasicQueueProducer", c =>
        {
            c.ExchangeName = "BASIC.TOPIC";
            c.RoutingKey = "BASIC.KEY";
            c.Type = ExchangeType.Topic;
        })
    };
    option.ConsumerConfigs = new List<ConsumerConfig>
    {
        new ConsumerConfig("DataBasicQueueConsumer", c =>
        {
            c.QueueName = "BASIC_QUEUE";
        })
    };
}));

Simple Publish

After registering the RabbitPool, you can simply publish a message by calling SimplePublish<T>().

await Task.Run(async () =>
{
    while (true)
    {
        pool.SimplePublish<string>("Connection1", "DataBasicQueueProducer", "Hello from SimplePublish<T>()!");
        Console.WriteLine("Sent to RabbitMQ");
        await Task.Delay(1000);
    }
});

There is also a easy-to-use RabbitProducer, which used to publish messages without ConnectionName and ProducerConfig, for more, read Wiki.

Receive messages

Instantiate a consumer in Program.cs:

var consumer = new BasicConsumer("Connection1", "DataBasicQueueConsumer", pool);
await Task.Run(async () =>
{
    while (true)
    {
        Console.WriteLine("Start receiving...");
        consumer.Receive();
        await Task.Delay(1000);
    }
});

Create your own consumer, for example: BasicConsumer.cs:

public class BasicConsumer : RabbitConsumer<string>
{
    public BasicConsumer(string connectionName, string consumerName, IRabbitPool pool) : base(connectionName, consumerName, pool)
    {
    }

    protected override void MessageHandler(string message)
    {
        Console.WriteLine($"Receive: {message}");
    }
}

DependencyInjection

Register IRabbitPool in Program.cs:

HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Services.AddRabbitPool(c =>
{
    c.Add(new ConnectOptions("Connection1", option =>
    {
        option.ConnectConfig = new(config =>
        {
            config.HostName = "localhost";
            config.Port = 5672;
            config.UserName = "admin";
            config.Password = "admin";
            config.VirtualHost = "DATA";
        });
        option.ProducerConfigs = new List<ProducerConfig>
        {
            new ProducerConfig("DataBasicQueueProducer", c =>
            {
                c.ExchangeName = "BASIC.TOPIC";
                c.RoutingKey = "BASIC.KEY";
                c.Type = ExchangeType.Topic;
            })
        };
        option.ConsumerConfigs = new List<ConsumerConfig>
        {
            new ConsumerConfig("DataBasicQueueConsumer", c =>
            {
                c.QueueName = "BASIC_QUEUE";
            })
        };
    }));

    c.Add(new ConnectOptions("Connection2", option =>
    {
        // ...
    }));
});

Then, you can use IRabbitPool at anywhere.

More DI Usage at Wiki.

Contributing

1. Fork this repository.
2. Create a new branch in you current repos from the dev branch.
3. Push commits and create a Pull Request (PR) to NanoRabbit.

TODO

• Basic Consume & Publish support
• DependencyInjection support
• Logging support
• ASP.NET support
• Exchange Configurations

Thanks

• Visual Studio 2022
• RabbitMQ.Client
• Newtonsoft.Json
• Masstransit
• EasyNetQ

LICENSE

NanoRabbit is licensed under the Apache-2.0 license.