RabbitMQ官方教程6--RPC

说明

在第二个教程中学习了如何使用工作队列在多个工作者之间分配耗时的任务。但是如果我们需要在远程计算机运行一个功能并且要等待他的结果该怎么办？显然这是一个不同的故事。这种模式通常被称为远程过程调用（Remote Procedure Call ）或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非但不能简化软件，反而会导致难以维护的复杂代码。

铭记以上这些，并考虑以下的建议：

确保可以明确区分哪个方法是本地的，哪个方法是远程调用的。

详细记录，明确组件之间的依赖关系。

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

如有疑问请避免使用RPC。如果可能的话，可以使用异步管道（asynchronous pipeline ），而不是类似RPC的阻塞，异步管道会将结果异步推送到下一个计算阶段。

回调队列

通常情况下通过RabbitMQ调用RPC很容易。客户端发送一个请求信息，服务端回复一个响应信息。为了接收响应我们需要在发送请求时携带一个回调队列的地址。

import com.rabbitmq.client.AMQP.BasicProperties;

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 ...

消息属性--Message Properties

AMQP 0-9-1协议为消息预定义了14个属性集，除了以下属性外大多数很少使用：

deliveryMode：标记一个消息是持久的（值为2）还是临时的（其他值）。

contentType：用于描述编码的mime类型（比如常用的JSON类型的值为：application/json）。

replyTo：通常用于命名回调队列。

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

Correlation Id

在上面介绍的方法中我们建议为每个RPC请求创建一个回调队列，但是那是相当低效的，一个更好的方法是为每个客户端创建一个单例的回调队列。这样就会导致一个新的问题，在该队列接收到响应后尚不清楚这个响应属于哪个请求，这时correlationId就派上了用场。我们会为每一个请求设置一个唯一的correlationId，当在回调队列中接收到消息时会查看该属性，并基于该属性将响应与请求匹配起来。如果看到了一个未知的correlationId的值就可以放心的丢弃掉该消息，因为那并不属于我们的请求。
你可能会疑惑为什么我们应该忽略回调队列中的未知消息，而不是通过error来失败。这是由于在服务器端可能存在竞争条件。虽然RPC服务器有可能在向我们发送答案之后，而在发送请求的确认消息之前就挂掉了的可能性不大，但是如果发生这种情况，重新启动的RPC服务器将再次处理请求。这就是为什么在客户端我们必须优雅地处理重复的响应，RPC理想情况下应该是幂等的。

小结

RPC会像这样工作：

对于RPC请求，客户端发送消息时会携带两个属性：replyTo被设置为只为请求创建一个匿名独家队列； correlationId被设置为为每个请求都设置一个唯一值。
请求被发送到 rpc_queue队列。
RPC工作程序（服务端）正在等待该队列上的请求。当请求出现时，它就会开始工作并使用replyTo字段中的队列将结果发送回客户端。
客户端等待回调队列中的数据。当消息出现时会检查correlationId属性，如果它与请求中的值匹配则会将响应返回给应用程序。

完整的代码

RPC服务端代码：https://github.com/rabbitmq/rabbitmq-tutorials/blob/master/java/RPCServer.java

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);

            // 由于我们可能要运行多个服务端进程，为了将负载平均分配到多个服务器，需要设置prefetchCount
            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();
                    }
                }
            };

            // 使用basicConsume访问队列
            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();
                    }
                }
            }
        }
    }
}

RPC客户端代码：https://github.com/rabbitmq/rabbitmq-tutorials/blob/master/java/RPCClient.java

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();
        }
    }

    // 该方法发出实际的RPC请求
    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();

        // 发布具有两个属性（correlationId和replyTo）的请求消息
        channel.basicPublish("", requestQueueName, props, message.getBytes("UTF-8"));

        // 因为我们的消费者交付处理是在一个单独的线程中进行的，所以我们需要在响应到达之前挂起主线程（main）。
        // 使用BlockingQueue是一种可能的解决方案。这里我们创建的ArrayBlockingQueue的容量设置为1，因为我们只需要等待一个响应。
        final BlockingQueue<String> response = new ArrayBlockingQueue<>(1);

        // 消费者的工作很简单，对于每一个响应消息，它都会检查correlationId 是否为我们要寻找的消息。
        // 如果是就将响应放入BlockingQueue
        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();
    }
}