RabbitMQ

RabbitMQ是实现了高级消息队列协议（AMQP）的开源消息代理软件（亦称面向消息的中间件）。RabbitMQ 服务器是用 Erlang 语言编写的，而聚类和故障转移是构建在开源的通讯平台框架上的。所有主要的编程语言均有与代理接口通讯的客户端库。

CAP 支持使用 RabbitMQ 作为消息传输器。

注意事项

CAP 在消费者启动并注册订阅时声明队列和绑定。若发布时对应的队列和绑定尚未创建，RabbitMQ 不会为该队列保留消息。生产环境建议在开始发布前启动消费者，或自行预先创建所需队列和绑定。

配置

要使用 RabbitMQ 作为消息传输器，你需要从 NuGet 安装以下扩展包：

Install-Package DotNetCore.CAP.RabbitMQ

然后，你可以在 Startup.cs 的 ConfigureServices 方法中添加基于 RabbitMQ 的配置项。

public void ConfigureServices(IServiceCollection services)
{
    // ...

    services.AddCap(x =>
    {
        x.UseRabbitMQ(opt=>
        {
            //RabbitMQOptions
        });
        // x.UseXXX ...
    });
}

RabbitMQ Options

CAP 直接对外提供的 RabbitMQ 配置参数如下：

配置项	描述	类型	默认值
HostName	宿主地址，如果要配置集群可以使用逗号分隔，例如 192.168.1.111,192.168.1.112	string	localhost
UserName	用户名	string	guest
Password	密码	string	guest
VirtualHost	虚拟主机	string	/
Port	端口号	int	-1
ExchangeName	CAP默认Exchange名称	string	cap.default.router
QueueArguments	队列额外参数 x-arguments	QueueArgumentsOptions	N/A
QueueOptions	更改已创建队列的选项	QueueRabbitOptions	{ Durable=true, Exclusive=false, AutoDelete=false }
ConnectionFactoryOptions	RabbitMQClient原生参数	ConnectionFactory	N/A
CustomHeadersBuilder	订阅者自定义头信息	见下文	N/A
PublishConfirms	是否启用发布确认	bool	false
BasicQosOptions	指定消费的Qos	BasicQos	N/A

QueueArguments 支持以下可选的队列声明参数：

属性	说明	默认值
QueueType	队列类型，例如 classic 或 quorum（x-queue-type）。	未设置
QueueMode	队列模式（x-queue-mode）。	未设置
MessageTTL	消息生存时间，单位为毫秒（x-message-ttl）。	864000000（10 天）

ConnectionFactory Option

如果你需要 更多 原生 ConnectionFactory 相关的配置项，可以通过 ConnectionFactoryOptions 配置项进行设定：

services.AddCap(x =>
{
    x.UseRabbitMQ(o =>
    {
        o.HostName = "localhost";
        o.ConnectionFactoryOptions = opt => { 
            //rabbitmq client ConnectionFactory config
        };
    });
});

CustomHeadersBuilder Option

当需要从异构系统或者直接接收从RabbitMQ 控制台发送的消息时，由于 CAP 需要定义额外的头信息才能正常订阅，所以此时会出现异常。通过提供此参数来进行自定义头信息的设置来使订阅者正常工作。

你可以在这里找到有关 头信息 的说明。

用法如下：

x.UseRabbitMQ(aa =>
{
    aa.CustomHeadersBuilder = (msg, sp) =>
    [
        new(DotNetCore.CAP.Messages.Headers.MessageId, sp.GetRequiredService<ISnowflakeId>().NextId().ToString()),
        new(DotNetCore.CAP.Messages.Headers.MessageName, msg.RoutingKey)
    ];
});

如何连接 RabbitMQ 集群？

使用逗号分隔连接字符串即可，如下：

x=> x.UseRabbitMQ("localhost:5672,localhost:5673,localhost:5674")