在 第二个教程 中，我们学习了如何使用工作队列来在多个工作者之间分配耗时的任务。
但是，如果我们需要在远程计算机上运行一个函数并等待结果呢？好吧，那是另一回事了。这种模式通常称为 Remote Procedure Call (远程过程调用)或 RPC。
在本教程中，我们将使用RabbitMQ来构建RPC系统：客户机和可伸缩RPC服务器。由于我们没有任何值得分发的耗时任务，我们将创建一个返回 Fibonacci 数的虚拟RPC服务。
1、客户端接口
为了说明如何使用 RPC 服务，我们将创建一个简单的 client 类。它将公开一个名为 call 的方法，它发送一个RPC请求和阻塞，直到收到响应：
FibonacciRpcClient fibonacciRpc = new FibonacciRpcClient();
String result = fibonacciRpc.call("4");
System.out.println( "fib(4) is " + result);关于RPC的说明
尽管RPC在计算中是一种非常常见的模式，但它经常受到批评。当程序员不知道函数调用是本地的还是慢速RPC时，就会出现问题。这样的混淆导致了一个不可预测的系统，并增加了不必要的调试复杂性。不需要简化软件，误用RPC会导致难以维护的意大利面条代码。
考虑到这一点，请考虑以下建议：
- 确保很明显哪个函数调用是本地的，哪个是远程的。
- 为你的系统编写文档，使组件之间的依赖关系变得清晰。
- 处理错误情况。当RPC服务器宕机很长时间时，客户机应该如何反应？
当有疑问时避免使用RPC。如果可以，您应该使用异步管道——而不是像rpc那样的阻塞
2、回调队列
一般来说，在 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-type。例如，对于经常使用的JSON编码，将该属性设置为：
application/JSON。 - replyTo：通常用于命名一个回调队列。
- correlationId：将RPC响应与请求关联起来很有用。
我们需要新的引入包：
import com.rabbitmq.client.AMQP.BasicProperties;3、Correlation Id
在上面给出的方法中，我们建议为每个 RPC 请求创建一个回调队列。这是非常低效的，但是幸运的是有一个更好的方法 —— 让我们为每个客户机创建一个回调队列。
这就引出了一个新问题，在这个队列中收到了响应，所以不清楚响应属于哪个请求。这就是我们为什么要使用 correlationId 属性。我们每个请求把它设置为唯一值。稍后，当我们在回调队列中接收一条消息时，我们将查看该属性，基于此，我们将能够根据请求匹配响应。如果我们看到一个未知的 correlationId 值，我们可以安全地丢弃这个消息——它不属于我们的请求。
你可能会问，为什么我们应该忽略回调队列中的未知消息，而不是错误地失败？这是由于服务器端有可能出现竞态条件。尽管不太可能，RPC 服务器可能在发送给我们答案之后就会死亡，但是在向请求发送确认消息之前。如果发生这种情况，重启 RPC 服务器将再次处理请求。这就是为什么在客户端我们必须优雅地处理重复的响应，而 RPC 应该是幂等的。
我们的 RPC 会这样工作：
- 当客户端启动时，它会创建一个匿名的独占回调队列。
- 对于 RPC 请求，客户端发送带有两个属性的消息：replyTo，它被设置为回调队列 和 correlationId它被设置为每个请求的唯一值。
- 请求被发送到一个
rpc_queue队列。 - RPC worker（又名：服务器）监听该队列上的请求。当一个请求出现时，它会执行任务，并通过 replyTo 字段中的队列将结果发送回客户端。
- 客户端等待回调队列上的数据。当一条消息出现时，它会检查
correlationId属性。如果它与请求的值相匹配，它就会返回对应用程序的响应。
合在一起就是：
Fibonacci 任务:
private static int fib(int n) {
if (n == 0) return 0;
if (n == 1) return 1;
return fib(n-1) + fib(n-2);
}我们声明斐波那斐函数。它只假设有效的正整数输入。（不要期望这一项能够为大数字工作，而且它可能是最慢的递归实现）。
我们的RPC服务器 RPCServer.java 的代码是这样的:
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) {
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("192.168.20.128");
factory.setPort(5672);
factory.setUsername("carl");
factory.setPassword("198918");
Connection connection = null;
try {
connection = factory.newConnection();
final 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");
Consumer consumer = new DefaultConsumer(channel) {
@Override
public void handleDelivery(String consumerTag, Envelope envelope, AMQP.BasicProperties properties, byte[] body) throws IOException {
AMQP.BasicProperties replyProps = new AMQP.BasicProperties
.Builder()
.correlationId(properties.getCorrelationId())
.build();
String response = "";
try {
String message = new String(body,"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( "", properties.getReplyTo(), replyProps, response.getBytes("UTF-8"));
channel.basicAck(envelope.getDeliveryTag(), false);
// RabbitMq consumer worker thread notifies the RPC server owner thread
synchronized(this) {
this.notify();
}
}
}
};
channel.basicConsume(RPC_QUEUE_NAME, false, consumer);
// Wait and be prepared to consume the message from RPC client.
while (true) {
synchronized(consumer) {
try {
consumer.wait();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
} catch (IOException | TimeoutException e) {
e.printStackTrace();
}
finally {
if (connection != null)
try {
connection.close();
} catch (IOException _ignore) {}
}
}
}服务器代码相当简单：
- 像往常一样，我们从建立连接、通道和声明队列开始。
- 我们可能想要运行不止一个服务器进程。为了在多个服务器上均匀地分布负载，我们需要通过
channel.basicQos中设置prefetchCount属性。 - 我们使用
basicConsume来访问队列，在那里我们提供一个回调以一个对象（DefaultConsumer）的形式，它将完成工作并发回响应。
我们的 RPC 客户端代码 RPCClient.java:：
public class RPCClient {
private Connection connection;
private Channel channel;
private String requestQueueName = "rpc_queue";
public RPCClient() throws IOException, TimeoutException {
ConnectionFactory factory = new ConnectionFactory();
factory.setHost("192.168.20.128");
factory.setPort(5672);
factory.setUsername("carl");
factory.setPassword("198918");
connection = factory.newConnection();
channel = connection.createChannel();
}
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<String>(1);
String ctag = channel.basicConsume(replyQueueName, true, new DefaultConsumer(channel) {
@Override
public void handleDelivery(String consumerTag, Envelope envelope, AMQP.BasicProperties properties, byte[] body) throws IOException {
if (properties.getCorrelationId().equals(corrId)) {
response.offer(new String(body, "UTF-8"));
}
}
});
String result = response.take();
channel.basicCancel(ctag);
return result;
}
public void close() throws IOException {
connection.close();
}
public static void main(String[] argv) {
RPCClient fibonacciRpc = null;
String response = null;
try {
fibonacciRpc = new RPCClient();
for (int i = 0; i < 32; i++) {
String i_str = Integer.toString(i);
System.out.println(" [x] Requesting fib(" + i_str + ")");
response = fibonacciRpc.call(i_str);
System.out.println(" [.] Got '" + response + "'");
}
}
catch (IOException | TimeoutException | InterruptedException e) {
e.printStackTrace();
}
finally {
if (fibonacciRpc!= null) {
try {
fibonacciRpc.close();
}
catch (IOException _ignore) {}
}
}
}
}客户端代码稍微复杂一点：
- 我们建立一个连接和通道，并声明一个独占的“回调”队列来进行应答。
- 我们订阅了“回调”队列，这样我们就可以接收RPC响应了。
- 我们的
call方法发出实际的 RPC 请求。 - 在这里，我们首先生成一个唯一的 correlationId 号并保存它 —— 我们在 DefaultConsumer 中实现的 handleDelivery 的实现将使用这个值来找到适当的响应。
- 接下来，我们发布请求消息，有两个属性：
replyTo和correlationId。 - 在这个时候，我们可以坐下来等待合适的响应回来。
- 由于我们的消费者交付处理是在一个单独的线程中发生的，所以在响应到来之前，我们需要一些东西来挂起主线程。BlockingQueue 的用法是可能的解决方案之一。这里我们创建ArrayBlockingQueue，容量设置为 1 ，因为我们只需要等待一个响应。
handleDelivery方法做的是非常简单的工作，对于每一个被消耗的响应消息，它会检查是否与我们正在寻找的相关信息。如果是这样，它会将响应放入 BlockingQueue。- 与此同时，主线程正在等待响应，可以从 BlockingQueue 获取它。
- 最后，我们将响应返回给用户。
发送一个客户端请求：
RPCClient fibonacciRpc = new RPCClient();
System.out.println(" [x] Requesting fib(30)");
String response = fibonacciRpc.call("30");
System.out.println(" [.] Got '" + response + "'");
fibonacciRpc.close();首先启动 RPCServer.java 的代码：
# => [x] Awaiting RPC requests运行客户端 RPCClien.java ，请求一个 fibonacci 函数：
[x] Requesting fib(0)
[.] Got '0'
[x] Requesting fib(1)
[.] Got '1'
...
[x] Requesting fib(30)
[.] Got '832040'
[x] Requesting fib(31)
[.] Got '1346269'这里提供的设计并不是RPC服务的唯一可能实现，但是它有一些重要的优点：
- 如果 RPC 服务器太慢，您可以通过运行另一个服务器来扩展。试着在一个新的控制台运行第二个RPCServer。
- 在客户端，RPC只需要发送和接收一条消息。不需要像
queueDeclare这样的同步调用。因此，RPC客户端只需要一个RPC请求的网络往返。
我们的代码仍然非常简单，并没有试图解决更复杂（但很重要）的问题，比如：
- 如果没有服务器运行，客户端应该如何反应？
- 客户端是否应该为RPC提供某种超时？
- 如果服务器出现故障并引发异常，是否应该将其转发给客户端？
- 在处理之前保护无效的传入消息（如检查边界、类型）。
