RabbitMQ（七）—远程过程调用RPC

在第二篇博文中，我们已经了解到了如何使用工作队列来向多个消费者分散耗时任务。

但是付过我们需要在远程电脑上运行一个方法然后等待结果，该怎么办？这是不同的需求。这个模式通常叫做RPC。

本文我们将使用RabbitMQ构建一个RPC系统：一个客户端和一个可扩展的RPC服务器端。由于我们没有任何真实的耗时任务需要分配，所以我们将创建一个虚拟的RPC服务，可以返回斐波纳契数列。

Client interface（客户端接口）

为了说明RPC服务可以使用，我们创建一个简单的客户端类。暴露一个方法——发送RPC请求，然后阻塞直到获得结果。

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

Callback queue（回调队列）

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协议为消息预定义了一组14个属性。大部分的属性是很少使用的。除了一下几种：

deliveryMode：标记消息传递模式，2-消息持久化，其他值-瞬态。在第二篇文章中还提到过。

contentType：内容类型，用于描述编码的mime-type。例如经常为该属性设置JSON编码。

replyTo：应答，通用的回调队列名称

correlationId：关联ID，方便RPC响应与请求关联

我们需要添加一个新的导入

import com.rabbitmq.client.AMQP.BasicProperties;  

Correlation Id

在上述方法中为每个RPC请求创建一个回调队列。这是很低效的。幸运的是，一个解决方案：可以为每个客户端创建一个单一的回调队列。

新的问题被提出，队列收到一条回复消息，但是不清楚是那条请求的回复。这是就需要使用correlationId属性了。我们要为每个请求设置唯一的值。然后，在回调队列中获取消息，看看这个属性，关联response和request

就是基于这个属性值的。如果我们看到一个未知的correlationId属性值的消息，可以放心的无视它——它不是我们发送的请求。

你可能问道，为什么要忽略回调队列中未知的信息，而不是当作一个失败？这是由于在服务器端竞争条件的导致的。虽然不太可能，但是如果RPC服务器在发送给我们结果后，发送请求反馈前就挂掉了，这有可能会发送未知correlationId属性值的消息。如果发生了这种情况，重启RPC服务器将会重新处理该请求。这就是为什么在客户端必须很好的处理重复响应，RPC应该是幂等的。

Summary（总结）

 我们的RPC的处理流程： 1. 当客户端启动时，创建一个匿名的回调队列。 2. 客户端为RPC请求设置2个属性：replyTo，设置回调队列名字；correlationId，标记request。 3. 请求被发送到rpc_queue队列中。 4. RPC服务器端监听rpc_queue队列中的请求，当请求到来时，服务器端会处理并且把带有结果的消息发送给客户端。接收的队列就是replyTo设定的回调队列。 5. 客户端监听回调队列，当有消息时，检查correlationId属性，如果与request中匹配，那就是结果了。 #完整的实例 RPC服务器端（RPCServer.Java）

/** 
 * RPC服务器端 
 *  
 * @author arron 
 * @date 2015年9月30日 下午3:49:01 
 * @version 1.0 
 */  
public class RPCServer {  

    private static final String RPC_QUEUE_NAME = "rpc_queue";  

    public static void main(String[] args) throws Exception {  
        ConnectionFactory factory = new ConnectionFactory();  
        // 设置MabbitMQ所在主机ip或者主机名  
        factory.setHost("127.0.0.1");  
        // 创建一个连接  
        Connection connection = factory.newConnection();  
        // 创建一个频道  
        Channel channel = connection.createChannel();  

        //声明队列  
        channel.queueDeclare(RPC_QUEUE_NAME, false, false, false, null);  

        //限制：每次最多给一个消费者发送1条消息  
        channel.basicQos(1);  

        //为rpc_queue队列创建消费者，用于处理请求  
        QueueingConsumer consumer = new QueueingConsumer(channel);  
        channel.basicConsume(RPC_QUEUE_NAME, false, consumer);  

        System.out.println(" [x] Awaiting RPC requests");  

        while (true) {  
            QueueingConsumer.Delivery delivery = consumer.nextDelivery();  

            //获取请求中的correlationId属性值，并将其设置到结果消息的correlationId属性中  
            BasicProperties props = delivery.getProperties();  
            BasicProperties replyProps = new BasicProperties.Builder().correlationId(props.getCorrelationId()).build();  
            //获取回调队列名字  
            String callQueueName = props.getReplyTo();  

            String message = new String(delivery.getBody(),"UTF-8");  

            System.out.println(" [.] fib(" + message + ")");  

            //获取结果  
            String response = "" + fib(Integer.parseInt(message));  
            //先发送回调结果  
            channel.basicPublish("", callQueueName, replyProps,response.getBytes());  
            //后手动发送消息反馈  
            channel.basicAck(delivery.getEnvelope().getDeliveryTag(), false);  
        }  
    }  

    /** 
     * 计算斐波列其数列的第n项 
     *  
     * @param n 
     * @return 
     * @throws Exception 
     */  
    private static int fib(int n) throws Exception {  
        if (n < 0)  
            throw new Exception("参数错误，n必须大于等于0");  
        if (n == 0)  
            return 0;  
        if (n == 1)  
            return 1;  
        return fib(n - 1) + fib(n - 2);  
    }  
} 

RPC客户端（RPCClient.java）：

/**  
 *  
 * @author arron 
 * @date 2015年9月30日 下午3:44:43  
 * @version 1.0  
 */  
public class RPCClient {  

    private static final String RPC_QUEUE_NAME = "rpc_queue";  

    private Connection connection;  
    private Channel channel;  
    private String replyQueueName;  
    private QueueingConsumer consumer;  

    public RPCClient() throws Exception {  
        ConnectionFactory factory = new ConnectionFactory();  
        // 设置MabbitMQ所在主机ip或者主机名  
        factory.setHost("127.0.0.1");  
        // 创建一个连接  
        connection = factory.newConnection();  
        // 创建一个频道  
        channel = connection.createChannel();  

        //声明队列  
        channel.queueDeclare(RPC_QUEUE_NAME, false, false, false, null);  

        //为每一个客户端获取一个随机的回调队列  
        replyQueueName = channel.queueDeclare().getQueue();  
        //为每一个客户端创建一个消费者（用于监听回调队列，获取结果）  
        consumer = new QueueingConsumer(channel);  
        //消费者与队列关联  
        channel.basicConsume(replyQueueName, true, consumer);  
    }  

    /** 
     * 获取斐波列其数列的值 
     *  
     * @param message 
     * @return 
     * @throws Exception 
     */  
    public String call(String message) throws Exception{  
        String response = null;  
        String corrId = java.util.UUID.randomUUID().toString();  

        //设置replyTo和correlationId属性值  
        BasicProperties props = new BasicProperties.Builder().correlationId(corrId).replyTo(replyQueueName).build();  

        //发送消息到rpc_queue队列  
        channel.basicPublish("", RPC_QUEUE_NAME, props, message.getBytes());  

        while (true) {  
            QueueingConsumer.Delivery delivery = consumer.nextDelivery();  
            if (delivery.getProperties().getCorrelationId().equals(corrId)) {  
                response = new String(delivery.getBody(),"UTF-8");  
                break;  
            }  
        }  

        return response;   
    }  

    public static void main(String[] args) throws Exception {  
        RPCClient fibonacciRpc = new RPCClient();     
        String result = fibonacciRpc.call("4");  
        System.out.println( "fib(4) is " + result);  
    }  
} 

输出结果：

fib(4) is 3

转载自 http://blog.youkuaiyun.com/xiaoxian8023/article/details/48826857