RabbitMQ 教程 - 远程过程调用 (RPC)

远程过程调用 (RPC)

(使用 Pika Python 客户端)

信息

先决条件

本教程假设 RabbitMQ 已安装并在 localhost 上的标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据，则需要调整连接设置。

哪里寻求帮助

如果您在学习本教程时遇到困难，可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。

先决条件

与其他的 Python 教程一样，我们将使用 Pika RabbitMQ 客户端 1.0.0 版本。

本教程重点介绍

在第二个教程中，我们学习了如何使用工作队列将耗时的任务分配给多个工作进程。

但是，如果我们需要在远程计算机上运行一个函数并等待结果呢？嗯，那又是另一回事了。这种模式通常被称为远程过程调用或RPC。

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

客户端接口

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

fibonacci_rpc = FibonacciRpcClient()
result = fibonacci_rpc.call(4)
print(f"fib(4) is {result}")

关于 RPC 的说明

尽管 RPC 在计算领域是一种相当普遍的模式，但它经常受到批评。当程序员不知道函数调用是本地的还是慢速的 RPC 时，就会出现问题。这样的混淆会导致系统不可预测，并增加调试的复杂性。滥用的 RPC 可能导致难以维护的意大利面条式代码，而不是简化软件。

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

确保明确哪些函数调用是本地的，哪些是远程的。

记录你的系统。明确组件之间的依赖关系。

处理错误情况。当 RPC 服务器长时间关闭时，客户端应该如何反应？

如果不确定，请避免使用 RPC。如果可能，你应该使用异步管道——而不是 RPC 类的阻塞，结果会异步推送到下一个计算阶段。

回调队列

RabbitMQ 中的请求-应答模式涉及服务器和客户端之间的直接交互。

客户端发送请求消息，服务器用响应消息进行答复。

为了接收答复，我们需要在请求中发送一个“回调”队列名称。这样的队列通常是服务器命名的，也可以有一个众所周知的名称（客户端命名）。

然后，服务器将使用该名称通过默认交换机进行答复。

result = channel.queue_declare(queue='', exclusive=True)
callback_queue = result.method.queue

channel.basic_publish(exchange='',
                      routing_key='rpc_queue',
                      properties=pika.BasicProperties(
                            reply_to = callback_queue,
                            ),
                      body=request)

# ... and some code to read a response message from the callback_queue ...

消息属性

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

delivery_mode：将消息标记为持久（值为2）或瞬时（任何其他值）。您可能还记得在第二个教程中提到过此属性。

content_type：用于描述编码的 mime 类型。例如，对于常用的 JSON 编码，通常的做法是将此属性设置为：application/json。

reply_to：通常用于命名一个回调队列。

correlation_id：用于将 RPC 响应与请求关联起来。

总结

我们的 RPC 将按如下方式工作：

客户端启动时，它会创建一个排他的回调队列。
对于 RPC 请求，客户端发送一个带有两个属性的消息：reply_to，设置为回调队列；correlation_id，设置为每个请求的唯一值。
请求被发送到 rpc_queue 队列。
RPC 工作进程（也称为服务器）在该队列上等待请求。当出现请求时，它会执行任务，并使用 reply_to 字段中的队列将带有结果的消息发送回客户端。
客户端等待回调队列上的数据。当出现消息时，它会检查 correlation_id 属性。如果它与请求中的值匹配，则将响应返回给应用程序。

总而言之

rpc_server.py（源代码）

#!/usr/bin/env python
import pika

connection = pika.BlockingConnection(
    pika.ConnectionParameters(host='localhost'))

channel = connection.channel()

channel.queue_declare(queue='rpc_queue')

def fib(n):
    if n == 0:
        return 0
    elif n == 1:
        return 1
    else:
        return fib(n - 1) + fib(n - 2)

def on_request(ch, method, props, body):
    n = int(body)

    print(f" [.] fib({n})")
    response = fib(n)

    ch.basic_publish(exchange='',
                     routing_key=props.reply_to,
                     properties=pika.BasicProperties(correlation_id = \
                                                         props.correlation_id),
                     body=str(response))
    ch.basic_ack(delivery_tag=method.delivery_tag)

channel.basic_qos(prefetch_count=1)
channel.basic_consume(queue='rpc_queue', on_message_callback=on_request)

print(" [x] Awaiting RPC requests")
channel.start_consuming()

服务器代码相当直接。

像往常一样，我们首先建立连接并声明名为 rpc_queue 的队列。
我们声明斐波那契函数。它假定输入是有效的正整数。（不要指望它能处理大数字，这可能是你能找到的最慢的递归实现）。
我们声明一个用于 basic_consume 的回调函数 on_request，这是 RPC 服务器的核心。当收到请求时，它会被执行。它执行工作并将响应发送回去。
我们可能希望运行多个服务器进程。为了在多个服务器之间平均分配负载，我们需要设置 prefetch_count 设置。

rpc_client.py（源代码）

#!/usr/bin/env python
import pika
import uuid


class FibonacciRpcClient(object):

    def __init__(self):
        self.connection = pika.BlockingConnection(
            pika.ConnectionParameters(host='localhost'))

        self.channel = self.connection.channel()

        result = self.channel.queue_declare(queue='', exclusive=True)
        self.callback_queue = result.method.queue

        self.channel.basic_consume(
            queue=self.callback_queue,
            on_message_callback=self.on_response,
            auto_ack=True)

        self.response = None
        self.corr_id = None

    def on_response(self, ch, method, props, body):
        if self.corr_id == props.correlation_id:
            self.response = body

    def call(self, n):
        self.response = None
        self.corr_id = str(uuid.uuid4())
        self.channel.basic_publish(
            exchange='',
            routing_key='rpc_queue',
            properties=pika.BasicProperties(
                reply_to=self.callback_queue,
                correlation_id=self.corr_id,
            ),
            body=str(n))
        while self.response is None:
            self.connection.process_data_events(time_limit=None)
        return int(self.response)


fibonacci_rpc = FibonacciRpcClient()

print(" [x] Requesting fib(30)")
response = fibonacci_rpc.call(30)
print(f" [.] Got {response}")

客户端代码稍微复杂一些。

我们建立连接、通道，并声明一个用于回复的独占 callback_queue。
我们订阅 callback_queue，以便接收 RPC 响应。
on_response 回调函数在每次收到响应时执行，它的作用非常简单：对于每个响应消息，它会检查 correlation_id 是否是我们正在寻找的那个。如果是，它会将响应保存在 self.response 中，然后中断消费循环。
接下来，我们定义主 call 方法，它执行实际的 RPC 请求。
在 call 方法中，我们生成一个唯一的 correlation_id 号并保存它——on_response 回调函数将使用此值来捕获正确的响应。
同样在 call 方法中，我们发布请求消息，其中包含两个属性：reply_to 和 correlation_id。
最后，我们等待直到正确的响应到达，然后将响应返回给用户。

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

python rpc_server.py
# => [x] Awaiting RPC requests

要请求一个斐波那契数，请运行客户端：

python rpc_client.py
# => [x] Requesting fib(30)

所提出的设计并非 RPC 服务的唯一可能实现方式，但它具有一些重要的优势。

如果 RPC 服务器太慢，您可以通过运行另一个服务器来扩展。尝试在新控制台中运行第二个 rpc_server.py。
在客户端，RPC 要求只发送和接收一条消息。不需要像 queue_declare 这样的同步调用。因此，RPC 客户端仅需一次网络往返即可完成一次 RPC 请求。

我们的代码仍然非常简单，并且没有试图解决更复杂（但重要）的问题，例如：

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

如果你想进行实验，可能会发现管理 UI 对于查看队列很有用。

远程过程调用 (RPC)​

(使用 Pika Python 客户端)​

先决条件​

哪里寻求帮助​

先决条件​

本教程重点介绍​

客户端接口​

关于 RPC 的说明​

回调队列​

消息属性​

相关 ID​

总结​

总而言之​

远程过程调用 (RPC)

(使用 Pika Python 客户端)

先决条件

哪里寻求帮助

先决条件

本教程重点介绍

客户端接口

关于 RPC 的说明

回调队列

消息属性

相关 ID

总结

总而言之