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

远程过程调用 (RPC)

(使用 Spring AMQP)

信息

前提条件

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

在哪里获得帮助

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

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

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

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

客户端接口

为了说明如何使用 RPC 服务，我们将把我们的配置文件名称从 “发送者” 和 “接收者” 更改为 “客户端” 和 “服务器”。当我们调用服务器时，我们将获得我们调用的参数的斐波那契数。

Integer response = (Integer) template.convertSendAndReceive
    (exchange.getName(), "rpc", start++);
System.out.println(" [.] Got '" + response + "'");

关于 RPC 的注意事项

虽然 RPC 在计算中是一种非常常见的模式，但它经常受到批评。当程序员不清楚函数调用是本地调用还是慢速 RPC 调用时，问题就会出现。这样的混淆会导致系统不可预测，并给调试增加不必要的复杂性。误用 RPC 不但不能简化软件，反而可能导致难以维护的意大利面条式代码。

考虑到这一点，请考虑以下建议

• 确保可以清楚地看出哪些函数调用是本地调用，哪些是远程调用。
• 记录你的系统。明确组件之间的依赖关系。
• 处理错误情况。当 RPC 服务器长时间宕机时，客户端应该如何反应？

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

回调队列

一般来说，通过 RabbitMQ 进行 RPC 很简单。客户端发送请求消息，服务器回复响应消息。为了接收响应，我们需要在请求中发送一个“回调”队列地址。当我们使用上面的 convertSendAndReceive() 方法时，Spring AMQP 的 RabbitTemplate 会为我们处理回调队列。使用 RabbitTemplate 时，无需进行任何其他设置。有关详尽的解释，请参阅 请求/回复消息。

消息属性

AMQP 0-9-1 协议预定义了一组与消息关联的 14 个属性。大多数属性很少使用，但以下属性除外

• deliveryMode：将消息标记为持久性（值为 2）或瞬态（任何其他值）。您可能还记得第二个教程中的这个属性。
• contentType：用于描述编码的 MIME 类型。例如，对于常用的 JSON 编码，最好将此属性设置为：application/json。
• replyTo：通常用于命名回调队列。
• correlationId：用于将 RPC 响应与请求关联起来。

关联 ID

Spring AMQP 允许您专注于您正在使用的消息风格，并隐藏支持此风格所需的消息管道的细节。例如，通常原生客户端会为每个 RPC 请求创建一个回调队列。这非常低效，因此另一种选择是为每个客户端创建一个单独的回调队列。

这引发了一个新问题，在收到该队列中的响应后，不清楚响应属于哪个请求。这时就可以使用 correlationId 属性。Spring AMQP 会自动为每个请求设置一个唯一值。此外，它还会处理将响应与正确的 correlationID 匹配的细节。

Spring AMQP 使 RPC 风格更容易的一个原因是，有时您可能希望忽略回调队列中的未知消息，而不是因错误而失败。这是由于服务器端可能存在竞争条件。虽然不太可能，但 RPC 服务器有可能在向我们发送答案之后，但在为请求发送确认消息之前就死掉。如果发生这种情况，重新启动的 RPC 服务器将再次处理该请求。Spring AMQP 客户端可以优雅地处理重复的响应，并且 RPC 理想情况下应该是幂等的。

总结

我们的 RPC 将像这样工作

• Tut6Config 将设置一个新的 DirectExchange 和一个客户端
• 客户端将利用 convertSendAndReceive 方法，传递交换机名称、路由键和消息。
• 请求被发送到 RPC 队列 tut.rpc。
• RPC 工作者（又名：服务器）正在等待该队列上的请求。当请求出现时，它执行任务并将包含结果的消息发送回客户端，使用来自 replyTo 字段的队列。
• 客户端等待回调队列上的数据。当消息出现时，它会检查 correlationId 属性。如果它与请求中的值匹配，则将响应返回给应用程序。同样，这是通过 RabbitTemplate 自动完成的。

整合在一起

斐波那契任务是一个 @RabbitListener，定义为

public int fib(int n) {
    return n == 0 ? 0 : n == 1 ? 1 : (fib(n - 1) + fib(n - 2));
}

我们声明了斐波那契函数。它仅接受有效的正整数输入。（不要指望它能处理大数字，而且它可能是最慢的递归实现）。

我们的 Tut6Config 类的代码如下所示

import org.springframework.amqp.core.Binding;
import org.springframework.amqp.core.BindingBuilder;
import org.springframework.amqp.core.DirectExchange;
import org.springframework.amqp.core.Queue;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Profile({"tut6","rpc"})
@Configuration
public class Tut6Config {

	@Profile("client")
	private static class ClientConfig {

		@Bean
		public DirectExchange exchange() {
			return new DirectExchange("tut.rpc");
		}

		@Bean
		public Tut6Client client() {
	 	 	return new Tut6Client();
		}

	}

	@Profile("server")
	private static class ServerConfig {

		@Bean
		public Queue queue() {
			return new Queue("tut.rpc.requests");
		}

		@Bean
		public DirectExchange exchange() {
			return new DirectExchange("tut.rpc");
		}

		@Bean
		public Binding binding(DirectExchange exchange,
		    Queue queue) {
			return BindingBuilder.bind(queue)
			    .to(exchange)
			    .with("rpc");
		}

		@Bean
		public Tut6Server server() {
			return new Tut6Server();
		}

	}
}

它将我们的配置文件设置为 tut6 或 rpc。它还设置了一个包含 2 个 bean 的客户端配置文件：我们正在使用的 DirectExchange 和 Tut6Client 本身。我们还配置了包含 3 个 bean 的服务器配置文件、tut.rpc.requests 队列、与客户端交换机匹配的 DirectExchange 以及从队列到交换机的绑定，路由键为 rpc。

服务器代码相当简单

• 像往常一样，我们开始使用 @RabbitListener 注释我们的接收器方法，并定义它正在监听的队列。
• 我们的 Fibonacci 方法使用 payload 参数调用 fib() 并返回结果

我们的 RPC 服务器 Tut6Server.java 的代码

package org.springframework.amqp.tutorials.tut6;

import org.springframework.amqp.rabbit.annotation.RabbitListener;

public class Tut6Server {

	@RabbitListener(queues = "tut.rpc.requests")
	// @SendTo("tut.rpc.replies") used when the
	// client doesn't set replyTo.
	public int fibonacci(int n) {
		System.out.println(" [x] Received request for " + n);
		int result = fib(n);
		System.out.println(" [.] Returned " + result);
		return result;
	}

	public int fib(int n) {
		return n == 0 ? 0 : n == 1 ? 1 : (fib(n - 1) + fib(n - 2));
	}

}

客户端代码 Tut6Client 和服务器一样简单

• 我们自动装配了 RabbitTemplate 和 Tut6Config 中定义的 DirectExchange bean。
• 我们使用参数交换机名称、路由键和消息调用 template.convertSendAndReceive。
• 我们打印结果

发出客户端请求很简单

import org.springframework.amqp.core.DirectExchange;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;

public class Tut6Client {

	@Autowired
	private RabbitTemplate template;

	@Autowired
	private DirectExchange exchange;

	int start = 0;

	@Scheduled(fixedDelay = 1000, initialDelay = 500)
	public void send() {
		System.out.println(" [x] Requesting fib(" + start + ")");
		Integer response = (Integer) template.convertSendAndReceive
		    (exchange.getName(), "rpc", start++);
		System.out.println(" [.] Got '" + response + "'");
	}
}

使用在第一个教程中定义的项目设置，使用 start.spring.io 和 Spring Initializr，运行时的准备工作与其他教程相同

./mvnw clean package

我们可以使用以下命令启动服务器

java -jar target/rabbitmq-tutorials.jar \
    --spring.profiles.active=rpc,server \
    --tutorial.client.duration=60000

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

java -jar target/rabbitmq-tutorials.jar \
    --spring.profiles.active=rpc,client

这里介绍的设计不是 RPC 服务的唯一可能实现，但它具有一些重要的优势

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

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

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

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