RabbitMQ 官方NET教程(六)【RPC】

在第二个教程中，我们学习了如何使用Work Queues 在多个工作者之间分配耗时的任务。

但是如果我们需要在远程计算机上运行功能并等待结果怎么办？ 那是一个不同的模式。 此模式通常称为远程过程调用或RPC。

在本教程中，我们将使用RabbitMQ构建一个RPC系统：一个客户端和一个可扩展的RPC服务器。由于我们没有任何值得分发的耗时任务，我们将创建一个返回斐波纳契数字的虚拟RPC服务。

客户端

为了说明如何使用RPC服务，我们将创建一个简单的客户端类。 它将公开一个名为call的方法，该方法发送RPC请求并阻塞，直到收到应答：

var rpcClient = new RPCClient();

Console.WriteLine(" [x] Requesting fib(30)");
var response = rpcClient.Call("30");
Console.WriteLine(" [.] Got '{0}'", response);

rpcClient.Close();

关于RPC的注意点

 虽然RPC是一个很常见的计算模式，但它经常被批评。 当程序员不知道函数调用是本地函数还是缓慢的RPC时，会出现问题。 这样的混乱导致了一个不可预知的系统，并增加了调试的不必要的复杂性。滥用RPC可能导致不可维护的意大利面条代码，而不是简化软件。

 铭记这一点，请考虑以下建议：

     确保显而易见哪个函数调用是本地的，哪个是远程的。
     记录您的系统。 使组件之间的依赖关系清晰。
     处理错误情况。 当RPC服务器长时间停机时，客户端应该如何反应？

 当有疑问避免RPC。 如果可以的话，你应该使用异步管道 - 而不是类似RPC的阻塞，结果被异步推送到下一个计算阶段。

回调队列

一般来说RPC在RabbitMQ上很容易。客户端发送请求消息，服务器回复响应消息。 为了收到一个响应，我们需要发送一个附带callback队列地址的请求：

var corrId = Guid.NewGuid().ToString();
var props = channel.CreateBasicProperties();
props.ReplyTo = replyQueueName;
props.CorrelationId = corrId;

var messageBytes = Encoding.UTF8.GetBytes(message);
channel.BasicPublish(exchange: "",
                     routingKey: "rpc_queue",
                     basicProperties: props,
                     body: messageBytes);

// ... then code to read a response message from the callback_queue ...

Message属性

 AMQP 0-9-1协议预先定义了一组随附消息的14个属性。 大多数属性很少使用，除了以下内容：

     deliveryMode：将消息标记为持久性（值为2）或transient（任何其他值）。 您可能会从第二个教程中记住此属性。
     contentType：用于描述mime类型的编码。 例如对于经常使用的JSON编码，将此属性设置为：application / json是一个很好的做法。
     replyTo：通常用来命名一个回调队列。
     correlationId：用于将RPC响应与请求相关联。

Correlation Id

在上面提出的方法中，我们建议为每个RPC请求创建一个回调队列。这是非常低效的，但幸运的是有一个更好的方法 - 让我们为每个客户端创建一个回调队列。

这引发了一个新的问题，在该队列中收到响应，响应所属的请求不清楚。那就是使用correlationId属性。我们将为每个请求设置唯一的值。之后，当我们在回调队列中收到一条消息时，我们将查看此属性，并且基于此，我们将能够将响应与请求相匹配。如果我们看到一个未知的correlationId值，我们可能会安全地丢弃该消息 - 它不属于我们的请求。

您可能会问，为什么我们应该忽略回调队列中的未知消息，而不是出现错误？这是由于在服务器端发生竞争条件的可能性。尽管不太可能，RPC服务器可能会在发送给我们的答案之后，但在发送请求的确认消息之前死亡。如果发生这种情况，重新启动的RPC服务器将再次处理该请求。这就是为什么在客户端上，我们必须优雅地处理这些重复的响应，而且RPC理应上是幂等的。

总结

我们的RPC将像这样工作：

 当客户端启动时，它创建一个匿名独占回调队列。
 对于RPC请求，客户端发送一个具有两个属性的消息：replyTo，它被设置为回调队列和correlationId，correlationId被设置为每个请求的唯一值。
 请求被发送到rpc_queue队列。
 RPC worker（aka：server）正在等待队列上的请求。 当请求出现时，它将执行该作业，并使用replyTo字段中的队列将结果发送回客户端。
 客户端等待回调队列中的数据。 当信息出现时，它会检查correlationId属性。 如果它与请求中的值相匹配，则返回对应用程序的响应。

完整示例

斐波纳契任务：

private static int fib(int n)
{
    if (n == 0 || n == 1) return n;
    return fib(n - 1) + fib(n - 2);
}

我们声明我们的fibonacci函数。 它只假定有效的正整数输入。 （不要指望这个工作者可以为大数字量工作，这可能是最慢的递归实现可能）。

我们的RPC服务器RPCServer.cs的代码如下所示：

using System;
using RabbitMQ.Client;
using RabbitMQ.Client.Events;
using System.Text;

class RPCServer
{
    public static void Main()
    {
        var factory = new ConnectionFactory() { HostName = "localhost" };
        using (var connection = factory.CreateConnection())
        using (var channel = connection.CreateModel())
        {
            channel.QueueDeclare(queue: "rpc_queue", durable: false,
              exclusive: false, autoDelete: false, arguments: null);
            channel.BasicQos(0, 1, false);
            var consumer = new EventingBasicConsumer(channel);
            channel.BasicConsume(queue: "rpc_queue",
              noAck: false, consumer: consumer);
            Console.WriteLine(" [x] Awaiting RPC requests");

            consumer.Received += (model, ea) =>
            {
                string response = null;

                var body = ea.Body;
                var props = ea.BasicProperties;
                var replyProps = channel.CreateBasicProperties();
                replyProps.CorrelationId = props.CorrelationId;

                try
                {
                    var message = Encoding.UTF8.GetString(body);
                    int n = int.Parse(message);
                    Console.WriteLine(" [.] fib({0})", message);
                    response = fib(n).ToString();
                }
                catch (Exception e)
                {
                    Console.WriteLine(" [.] " + e.Message);
                    response = "";
                }
                finally
                {
                    var responseBytes = Encoding.UTF8.GetBytes(response);
                    channel.BasicPublish(exchange: "", routingKey: props.ReplyTo,
                      basicProperties: replyProps, body: responseBytes);
                    channel.BasicAck(deliveryTag: ea.DeliveryTag,
                      multiple: false);
                }
            };

            Console.WriteLine(" Press [enter] to exit.");
            Console.ReadLine();
        }
    }

    /// 

    /// Assumes only valid positive integer input.
    /// Don't expect this one to work for big numbers, and it's
    /// probably the slowest recursive implementation possible.
    /// 

    private static int fib(int n)
    {
        if (n == 0 || n == 1)
        {
            return n;
        }

        return fib(n - 1) + fib(n - 2);
    }
}

服务器代码相当简单：

 像往常一样，我们开始建立连接，通道和声明队列。
 我们可能想要运行多个服务器进程。 为了在多个服务器上平均分配负载，我们需要在channel.basicQos中设置prefetchCount设置。
 我们使用basicConsume访问队列。 然后我们注册一个传递处理程序，我们在其中进行工作并发回响应。

我们的RPC客户机的代码RPCClient.cs：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using RabbitMQ.Client;
using RabbitMQ.Client.Events;

class RPCClient
{
    private IConnection connection;
    private IModel channel;
    private string replyQueueName;
    private QueueingBasicConsumer consumer;

    public RPCClient()
    {
        var factory = new ConnectionFactory() { HostName = "localhost" };
        connection = factory.CreateConnection();
        channel = connection.CreateModel();
        replyQueueName = channel.QueueDeclare().QueueName;
        consumer = new QueueingBasicConsumer(channel);
        channel.BasicConsume(queue: replyQueueName,
                             noAck: true,
                             consumer: consumer);
    }

    public string Call(string message)
    {
        var corrId = Guid.NewGuid().ToString();
        var props = channel.CreateBasicProperties();
        props.ReplyTo = replyQueueName;
        props.CorrelationId = corrId;

        var messageBytes = Encoding.UTF8.GetBytes(message);
        channel.BasicPublish(exchange: "",
                             routingKey: "rpc_queue",
                             basicProperties: props,
                             body: messageBytes);

        while(true)
        {
            var ea = (BasicDeliverEventArgs)consumer.Queue.Dequeue();
            if(ea.BasicProperties.CorrelationId == corrId)
            {
                return Encoding.UTF8.GetString(ea.Body);
            }
        }
    }

    public void Close()
    {
        connection.Close();
    }
}

class RPC
{
    public static void Main()
    {
        var rpcClient = new RPCClient();

        Console.WriteLine(" [x] Requesting fib(30)");
        var response = rpcClient.Call("30");
        Console.WriteLine(" [.] Got '{0}'", response);

        rpcClient.Close();
    }
}

客户端代码涉及：

 我们建立一个连接和通道，并声明一个独占的'callback'队列作为回复。
 我们订阅'callback'队列，以便我们可以接收RPC响应。
 我们的call方法使得实际的RPC请求。
 在这里，我们首先生成一个唯一的correlationId数字并保存它 - while循环将使用此值来捕获适当的响应。
 接下来，我们发布请求消息，其中包含两个属性：replyTo和correlationId。
 在这一点上，我们可以坐下来等待适当的响应到达。
 while循环正在做一个非常简单的工作，对于每个响应消息，它检查correlationId是否是我们正在寻找的。 如果是这样，它会保存响应。
 最后，我们将响应返回给用户。

使客户端请求：

var rpcClient = new RPCClient();

Console.WriteLine(" [x] Requesting fib(30)");
var response = rpcClient.Call("30");
Console.WriteLine(" [.] Got '{0}'", response);

rpcClient.Close();

我们的RPC服务现在已经准备就绪。 我们可以启动服务器：

cd RPCServer
dotnet run
# => [x] Awaiting RPC requests

运行客户端请求fibonacci数字：

cd RPCClient
dotnet run
# => [x] Requesting fib(30)

这里提出的设计不是RPC服务的唯一可能的实现，而是具有一些重要的优点：

 如果RPC服务器太慢，可以通过运行另一个RPC服务器进行扩展。 尝试在新的控制台中运行第二个RPCServer。
 在客户端，RPC需要发送和接收一条消息。 不需要同步调用，如queueDeclare。 因此，RPC客户端只需要一个网络往返单个RPC请求。

我们的代码仍然非常简单，不会尝试解决更复杂（但重要的）问题，如：

 如果没有服务器运行，客户端应该如何反应？
 客户端是否需要RPC的某种超时时间？
 如果服务器发生故障并引发异常，应该将其转发给客户端？
 在处理之前防止无效的传入消息（例如检查边界，类型）。