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 中的请求-应答模式涉及服务器和客户端之间的直接交互。

客户端发送请求消息，服务器用响应消息进行答复。

为了接收答复，我们需要在请求中发送一个“回调”队列名称。这样的队列通常是服务器命名的，也可以有一个众所周知的名称（客户端命名）。

然后，服务器将使用该名称通过默认交换机进行答复。

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 响应与请求关联起来。

总结

我们的 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 对于查看队列很有用。

先决条件​

哪里寻求帮助​

远程过程调用 (RPC)​

(使用 Go RabbitMQ 客户端)​

关于 RPC 的说明​

回调队列​

消息属性​

相关 ID​

总结​

总而言之​

先决条件

哪里寻求帮助

远程过程调用 (RPC)

(使用 Go RabbitMQ 客户端)

关于 RPC 的说明

回调队列

消息属性

相关 ID

总结

总而言之