跳至主要内容

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

远程过程调用 (RPC)​

(使用 Spring AMQP)​

info

先决条件​

本教程假设 RabbitMQ 已安装并在localhost 上的标准端口 (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。它还设置了client 配置文件，其中包含 2 个 bean：我们正在使用的DirectExchange 和Tut6Client 本身。我们还使用 3 个 bean 配置了server 配置文件：tut.rpc.requests 队列、DirectExchange（与客户端的交换匹配）以及从队列到交换的绑定，其路由键为rpc。

服务器代码相当简单

  • 像往常一样，我们使用@RabbitListener 注释接收器方法，并定义它正在侦听的队列。
  • 我们的斐波那契方法使用负载参数调用 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 设置某种超时机制？
  • 如果服务器出现故障并抛出异常，是否应该将其转发给客户端？
  • 在处理之前，保护免受无效的传入消息（例如检查边界、类型）。

如果你想尝试，你可以使用管理界面查看队列。

© 2024 RabbitMQ. All rights reserved.