RabbitMQ 教程 - 远程过程调用 (RPC)
先决条件
本教程假定您已安装 RabbitMQ 并使其在 localhost 的标准端口 (5672) 上运行。如果您使用不同的主机、端口或凭据，则需要调整连接设置。
在哪里获得帮助
如果您在学习本教程时遇到问题，可以通过 GitHub Discussions 或 RabbitMQ 社区 Discord 联系我们。
远程过程调用 (RPC)
（使用 Go RabbitMQ 客户端）
在第二个教程中，我们学习了如何使用工作队列在多个工作进程之间分配耗时任务。
但是，如果我们需要在远程计算机上运行一个函数并等待结果呢？嗯，那是另一回事了。这种模式通常被称为远程过程调用或 RPC。
在本教程中，我们将使用 RabbitMQ 构建一个 RPC 系统：一个客户端和一个可扩展的 RPC 服务器。由于我们没有任何值得分配的耗时任务，我们将创建一个虚拟的 RPC 服务，该服务返回斐波那契数。
关于 RPC 的注意事项
虽然 RPC 在计算中是一种非常常见的模式，但它经常受到批评。当程序员不知道函数调用是本地调用还是慢速 RPC 时，问题就会出现。诸如此类的混淆会导致系统不可预测，并增加不必要的调试复杂性。误用 RPC 不但不能简化软件，反而可能导致无法维护的意大利面条式代码。
考虑到这一点，请考虑以下建议
- 确保可以明显区分哪些函数调用是本地调用，哪些是远程调用。
- 记录您的系统。明确组件之间的依赖关系。
- 处理错误情况。当 RPC 服务器长时间宕机时，客户端应如何反应？
如有疑问，请避免使用 RPC。如果可以，您应该使用异步管道 - 结果会被异步推送到下一个计算阶段，而不是像 RPC 那样阻塞。
回调队列
通常，通过 RabbitMQ 进行 RPC 很简单。客户端发送请求消息，服务器回复响应消息。为了接收响应，我们需要在请求中发送“回调”队列地址。我们可以使用默认队列。让我们试一下
q, err := ch.QueueDeclare(
"", // name
false, // durable
false, // delete when unused
true, // exclusive
false, // noWait
nil, // arguments
)
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
err = ch.PublishWithContext(ctx,
"", // exchange
"rpc_queue", // routing key
false, // mandatory
false, // immediate
amqp.Publishing{
ContentType: "text/plain",
CorrelationId: corrId,
ReplyTo: q.Name,
Body: []byte(strconv.Itoa(n)),
})
消息属性
AMQP 0-9-1 协议预定义了一组 14 个与消息关联的属性。大多数属性很少使用，以下属性除外
persistent：将消息标记为持久性（值为true）或瞬态（false）。您可能还记得第二个教程中的这个属性。content_type：用于描述编码的 mime 类型。例如，对于常用的 JSON 编码，最好将此属性设置为：application/json。reply_to：通常用于命名回调队列。correlation_id：用于将 RPC 响应与请求关联起来。
关联 ID
为每个 RPC 请求创建一个回调队列效率低下。更好的方法是为每个客户端创建一个单独的回调队列。
这引发了一个新问题，在收到该队列中的响应后，不清楚该响应属于哪个请求。这时就需要使用 correlation_id 属性。我们将为每个请求将其设置为唯一值。稍后，当我们在回调队列中收到消息时，我们将查看此属性，并根据该属性，我们将能够将响应与请求匹配。如果我们看到未知的 correlation_id 值，我们可以安全地丢弃该消息 - 它不属于我们的请求。
您可能会问，为什么我们应该忽略回调队列中未知的消息，而不是抛出错误？这是因为服务器端可能存在竞争条件。虽然不太可能，但 RPC 服务器有可能在向我们发送答案之后，但在发送请求的确认消息之前就死掉了。如果发生这种情况，重新启动的 RPC 服务器将再次处理该请求。这就是为什么在客户端，我们必须优雅地处理重复的响应，并且 RPC 最好是幂等的。
总结
我们的 RPC 将像这样工作
- 当客户端启动时，它会创建一个独占的回调队列。
- 对于 RPC 请求，客户端发送一条消息，其中包含两个属性：
reply_to，设置为回调队列，以及correlation_id，为每个请求设置为唯一值。 - 请求被发送到
rpc_queue队列。 - RPC 工作进程（又名：服务器）正在该队列上等待请求。当出现请求时，它会完成工作并将包含结果的消息发送回客户端，使用来自
reply_to字段的队列。 - 客户端在回调队列上等待数据。当出现消息时，它会检查
correlation_id属性。如果它与请求中的值匹配，则将响应返回给应用程序。
将所有内容放在一起
斐波那契函数
func fib(n int) int {
if n == 0 {
return 0
} else if n == 1 {
return 1
} else {
return fib(n-1) + fib(n-2)
}
}
我们声明我们的斐波那契函数。它仅假定有效的正整数输入。（不要期望它能处理大数字，而且它可能是最慢的递归实现）。
我们的 RPC 服务器代码 rpc_server.go 看起来像这样
package main
import (
"context"
"log"
"strconv"
"time"
amqp "github.com/rabbitmq/amqp091-go"
)
func failOnError(err error, msg string) {
if err != nil {
log.Panicf("%s: %s", msg, err)
}
}
func fib(n int) int {
if n == 0 {
return 0
} else if n == 1 {
return 1
} else {
return fib(n-1) + fib(n-2)
}
}
func main() {
conn, err := amqp.Dial("amqp://guest:guest@localhost:5672/")
failOnError(err, "Failed to connect to RabbitMQ")
defer conn.Close()
ch, err := conn.Channel()
failOnError(err, "Failed to open a channel")
defer ch.Close()
q, err := ch.QueueDeclare(
"rpc_queue", // name
false, // durable
false, // delete when unused
false, // exclusive
false, // no-wait
nil, // arguments
)
failOnError(err, "Failed to declare a queue")
err = ch.Qos(
1, // prefetch count
0, // prefetch size
false, // global
)
failOnError(err, "Failed to set QoS")
msgs, err := ch.Consume(
q.Name, // queue
"", // consumer
false, // auto-ack
false, // exclusive
false, // no-local
false, // no-wait
nil, // args
)
failOnError(err, "Failed to register a consumer")
var forever chan struct{}
go func() {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
for d := range msgs {
n, err := strconv.Atoi(string(d.Body))
failOnError(err, "Failed to convert body to integer")
log.Printf(" [.] fib(%d)", n)
response := fib(n)
err = ch.PublishWithContext(ctx,
"", // exchange
d.ReplyTo, // routing key
false, // mandatory
false, // immediate
amqp.Publishing{
ContentType: "text/plain",
CorrelationId: d.CorrelationId,
Body: []byte(strconv.Itoa(response)),
})
failOnError(err, "Failed to publish a message")
d.Ack(false)
}
}()
log.Printf(" [*] Awaiting RPC requests")
<-forever
}
服务器代码非常简单明了
- 像往常一样，我们首先建立连接、通道并声明队列。
- 我们可能希望运行多个服务器进程。为了在多个服务器之间平均分配负载，我们需要在通道上设置
prefetch设置。 - 我们使用
Channel.Consume来获取 Go 通道，我们从该通道接收来自队列的消息。然后我们进入 goroutine，在其中完成工作并将响应发送回去。
我们的 RPC 客户端代码 rpc_client.go
package main
import (
"context"
"log"
"math/rand"
"os"
"strconv"
"strings"
"time"
amqp "github.com/rabbitmq/amqp091-go"
)
func failOnError(err error, msg string) {
if err != nil {
log.Panicf("%s: %s", msg, err)
}
}
func randomString(l int) string {
bytes := make([]byte, l)
for i := 0; i < l; i++ {
bytes[i] = byte(randInt(65, 90))
}
return string(bytes)
}
func randInt(min int, max int) int {
return min + rand.Intn(max-min)
}
func fibonacciRPC(n int) (res int, err error) {
conn, err := amqp.Dial("amqp://guest:guest@localhost:5672/")
failOnError(err, "Failed to connect to RabbitMQ")
defer conn.Close()
ch, err := conn.Channel()
failOnError(err, "Failed to open a channel")
defer ch.Close()
q, err := ch.QueueDeclare(
"", // name
false, // durable
false, // delete when unused
true, // exclusive
false, // noWait
nil, // arguments
)
failOnError(err, "Failed to declare a queue")
msgs, err := ch.Consume(
q.Name, // queue
"", // consumer
true, // auto-ack
false, // exclusive
false, // no-local
false, // no-wait
nil, // args
)
failOnError(err, "Failed to register a consumer")
corrId := randomString(32)
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
err = ch.PublishWithContext(ctx,
"", // exchange
"rpc_queue", // routing key
false, // mandatory
false, // immediate
amqp.Publishing{
ContentType: "text/plain",
CorrelationId: corrId,
ReplyTo: q.Name,
Body: []byte(strconv.Itoa(n)),
})
failOnError(err, "Failed to publish a message")
for d := range msgs {
if corrId == d.CorrelationId {
res, err = strconv.Atoi(string(d.Body))
failOnError(err, "Failed to convert body to integer")
break
}
}
return
}
func main() {
rand.Seed(time.Now().UTC().UnixNano())
n := bodyFrom(os.Args)
log.Printf(" [x] Requesting fib(%d)", n)
res, err := fibonacciRPC(n)
failOnError(err, "Failed to handle RPC request")
log.Printf(" [.] Got %d", res)
}
func bodyFrom(args []string) int {
var s string
if (len(args) < 2) || os.Args[1] == "" {
s = "30"
} else {
s = strings.Join(args[1:], " ")
}
n, err := strconv.Atoi(s)
failOnError(err, "Failed to convert arg to integer")
return n
}
现在是查看我们的完整示例源代码的好时机，请查看 rpc_client.go 和 rpc_server.go。
我们的 RPC 服务现在已准备就绪。我们可以启动服务器
go run rpc_server.go
# => [x] Awaiting RPC requests
要请求斐波那契数，请运行客户端
go run rpc_client.go 30
# => [x] Requesting fib(30)
此处介绍的设计不是 RPC 服务的唯一可能实现，但它具有一些重要的优势
- 如果 RPC 服务器太慢，您可以通过运行另一个服务器来扩展。尝试在新控制台中运行第二个
rpc_server.go。 - 在客户端，RPC 仅需要发送和接收一条消息。因此，RPC 客户端对于单个 RPC 请求只需要一次网络往返。
我们的代码仍然非常简单，并没有尝试解决更复杂（但很重要）的问题，例如
- 如果没有服务器运行，客户端应该如何反应？
- 客户端是否应该为 RPC 设置某种超时？
- 如果服务器发生故障并引发异常，是否应该将其转发给客户端？
- 在处理之前防止无效的传入消息（例如，检查边界、类型）。
如果您想进行实验，您可能会发现管理 UI 对于查看队列很有用。