（翻译）RabbitMQJavaClient教程（六）RPC

Z时代
2024-01-10
分类：综合

在第二篇教程中我们学习了如何使用工作队列来在多个消费者中间分发耗时的任务。

但是如果我们想要运行远程的服务器上的某个程序并获取它的返回结果要怎么办呢？好吧，那将是一个不同的领域。这种模式通常被称作远程调用，简称为RPC。

在本篇教程中我们将使用RabbitMQ构建一个RPC系统：一个客户端和一个可以弹性扩容的RPC服务端。因为我们没有真实的耗时任务，所以我们将创建一个返回斐波那契数列的假的RPC服务。

客户端接口

为了说明如何使用RPC服务，我们将创建一个简单的客户端类。它将会暴露出一个名为“call”的方法，这个方法将会发送RPC请求并阻塞住等待回复。

FibonacciRpcClient fibonacciRpc = new FibonacciRpcClient();
String result = fibonacciRpc.call("4");
System.out.println( "fib(4) is " + result);

有关RPC的说明
虽然RPC在计算机领域是非常常见的概念，但是它经常被批评。当程序员无法区分方法的调用时本地还是远程的时候，总是会带来问题。这样的混乱会导致系统的响应难以预测，并给调试增加了不必要的复杂性。与简单的软件相比，错误的使用RPC将导致无法维护的“意大利面”代码。
牢记这一点，并考虑以下建议：
确保本地方法调用和远程方法调用可以明显的区分开
好好维护你系统的文档。保证组件之间的依赖关系清晰
完善的错误处理机制。如果RPC服务端长时间挂掉，客户端该如何处理？

回调队列

通常情况下，使用RabbitMQ构建RPC系统是很简单的。客户端发送请求消息，然后服务端回复消息。为了能收到回复消息，我们需要随着请求发送一个“回调”队列的地址。我们可以使用默认队列做这件事（这个队列在java客户端中是排他的）。让我们试一下吧：

callbackQueueName = channel.queueDeclare().getQueue();
BasicProperties props = new BasicProperties
                            .Builder()
                            .replyTo(callbackQueueName)
                            .build();
channel.basicPublish("", "rpc_queue", props, message.getBytes());
// ... then code to read a response message from the callback_queue ...

消息参数配置
AMQP 0-9-1协议预定义了消息的14个参数。大多数参数都很少用，但是下边几个是例外：
deliveryMode：标识着消息需要持久化（当值为2的时候）或者不需要（其他值）。你可能会想起我们在第二篇教程中使用过这个参数。
contentType：用来描述编码的MIME类型。例如，对于经常使用的JSON编码，将此属性设置为“ application/json ”。
replyTo：通常用来命名一个回调队列
correlationId：用来将RPC响应和请求相关联

我们需要导入一个新的包：

import com.rabbitmq.client.AMQP.BasicProperties;

关联ID

在之前的代码中，我们建议为每个RPC请求创建一个回调队列。这是非常低效的，不过幸运的是我们可以有更好的处理方式——每个客户端创建一个队列。

这就会带来一个新的问题，我们无法知道队列中收到的响应对应的是哪个请求。这时候就需要用到“correlationId”参数了。对于每个请求，我们都会设置一个唯一的值。稍后当我们收到消息时，我们会去查看这个参数，然后我们就可以将请求和响应相匹配了。如果我们收到了一个未知的correlationId值，我们可以将它直接丢弃——因为它不属于我们的任何请求。

你可能会问了，为什么我们是忽略回调队列中的未知消息，而不是报错呢？这是由于服务器端可能出现竞态条件。虽然可能性很低，但是在RPC服务端响应我们但还没有回复RabbitMQ确认消息之前，它也是有可能挂掉的。当它重启之后，RPC服务端会再次处理这条消息。这就是为什么在客户端上我们必须优雅地处理重复的响应——理想情况下，RPC应该是幂等的。

总结

我们的RPC将会这样工作：

对于RPC请求，客户端会发送带有两个参数的消息：replyTo—— 设置为仅为该请求创建的匿名排他队列； correlationId——设置为全局唯一的值。

请求消息会被发往“rpc_queue ”队列。

RPC服务端会监听着来自“rpc_queue ”队列的请求。当请求到来时，它执行相应的任务并将结果通过replyTo指定的队列发送会客户端。

客户端监听着响应队列的消息。当消息到来时，它会校验correlationId参数。如果和自己的参数相匹配，他将结果返回给应用。

完整代码

1、斐波那契任务：

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

我们声明了一个斐波那契方法。它假设输入的都是正整数（不要指望这个方法来计算很大的数字，这可能是这个算法最慢的实现了）。

2、RPC服务端的代码：

import com.rabbitmq.client.*;
public class RPCServer {
    private static final String RPC_QUEUE_NAME = "rpc_queue";
    private static int fib(int n) {
        if (n == 0) return 0;
        if (n == 1) return 1;
        return fib(n - 1) + fib(n - 2);
    }
    public static void main(String[] argv) throws Exception {
        ConnectionFactory factory = new ConnectionFactory();
        factory.setHost("localhost");
        try (Connection connection = factory.newConnection();
             Channel channel = connection.createChannel()) {
            channel.queueDeclare(RPC_QUEUE_NAME, false, false, false, null);
            channel.queuePurge(RPC_QUEUE_NAME);
            channel.basicQos(1);
            System.out.println(" [x] Awaiting RPC requests");
            Object monitor = new Object();
            DeliverCallback deliverCallback = (consumerTag, delivery) -> {
                AMQP.BasicProperties replyProps = new AMQP.BasicProperties
                        .Builder()
                        .correlationId(delivery.getProperties().getCorrelationId())
                        .build();
                String response = "";
                try {
                    String message = new String(delivery.getBody(), "UTF-8");
                    int n = Integer.parseInt(message);
                    System.out.println(" [.] fib(" + message + ")");
                    response += fib(n);
                } catch (RuntimeException e) {
                    System.out.println(" [.] " + e.toString());
                } finally {
                    channel.basicPublish("", delivery.getProperties().getReplyTo(), replyProps, response.getBytes("UTF-8"));
                    channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);
                    // RabbitMq consumer worker thread notifies the RPC server owner thread
                    synchronized (monitor) {
                        monitor.notify();
                    }
                }
            };
            channel.basicConsume(RPC_QUEUE_NAME, false, deliverCallback, (consumerTag -> { }));
            // Wait and be prepared to consume the message from RPC client.
            while (true) {
                synchronized (monitor) {
                    try {
                        monitor.wait();
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
    }
}

服务器代码非常简单：

像往常一样，我们建立了connection、channel并声明了队列

我们可能想要创建不止一个服务端进程。为了保证多个服务端之间负载均衡，我们需要通过channel.basicQos设置prefetchCount参数

我们使用basicConsume访问队列，在队列中我们以对象（DeliverCallback）的形式提供回调，该回调将完成工作并将响应发送回去。

3、RPC客户端的代码：

import com.rabbitmq.client.AMQP;
import com.rabbitmq.client.Channel;
import com.rabbitmq.client.Connection;
import com.rabbitmq.client.ConnectionFactory;
import java.io.IOException;
import java.util.UUID;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.TimeoutException;
public class RPCClient implements AutoCloseable {
    private Connection connection;
    private Channel channel;
    private String requestQueueName = "rpc_queue";
    public RPCClient() throws IOException, TimeoutException {
        ConnectionFactory factory = new ConnectionFactory();
        factory.setHost("localhost");
        connection = factory.newConnection();
        channel = connection.createChannel();
    }
    public static void main(String[] argv) {
        try (RPCClient fibonacciRpc = new RPCClient()) {
            for (int i = 0; i < 32; i++) {
                String i_str = Integer.toString(i);
                System.out.println(" [x] Requesting fib(" + i_str + ")");
                String response = fibonacciRpc.call(i_str);
                System.out.println(" [.] Got "" + response + """);
            }
        } catch (IOException | TimeoutException | InterruptedException e) {
            e.printStackTrace();
        }
    }
    public String call(String message) throws IOException, InterruptedException {
        final String corrId = UUID.randomUUID().toString();
        String replyQueueName = channel.queueDeclare().getQueue();
        AMQP.BasicProperties props = new AMQP.BasicProperties
                .Builder()
                .correlationId(corrId)
                .replyTo(replyQueueName)
                .build();
        channel.basicPublish("", requestQueueName, props, message.getBytes("UTF-8"));
        final BlockingQueue<String> response = new ArrayBlockingQueue<>(1);
        String ctag = channel.basicConsume(replyQueueName, true, (consumerTag, delivery) -> {
            if (delivery.getProperties().getCorrelationId().equals(corrId)) {
                response.offer(new String(delivery.getBody(), "UTF-8"));
            }
        }, consumerTag -> {
        });
        String result = response.take();
        channel.basicCancel(ctag);
        return result;
    }
    public void close() throws IOException {
        connection.close();
    }
}

客户端代码要稍微复杂一点：

我们建立了connection、channel

我们的“call”方法发送了实际的RPC请求

我们首先创建了一个唯一的correlationId并保存起来——稍后我们消费者需要用它来匹配正确的响应

然后我们创建了一个排他性的队列用来接收响应并且订阅它

接下来我们发布了一条包含replyTo和correlationId参数的请求消息

现在我们坐下来等待合适的响应到达

由于我们的消费者处理消息是在另一个线程中，所以我们需要使用一些手段在响应到来之前将主线程挂起。“BlockingQueue”就是一种解决方案。这里我们创建了一个容量为1的ArrayBlockingQueue，因为我们只期望收到一条回复。

消费者做的事情很简单，当收到一条响应后，它校验correlationId是否与它的匹配，如果匹配的话就把响应放入BlockingQueue。

与此同时，正在等待回复的主线程会将这条消息从BlockingQueue中取出。

最终我们将响应返回给用户。

4、发起客户端请求

RPCClient fibonacciRpc = new RPCClient();
System.out.println(" [x] Requesting fib(30)");
String response = fibonacciRpc.call("30");
System.out.println(" [.] Got "" + response + """);
fibonacciRpc.close();

本文描述的RPC实现并不是唯一的一种，但它有如下几个优点：