架构与系统设计 / 系统课时
配置 Service Config 重试策略
配置 Service Config 重试策略
这一课把 Unary RPC 的重试从“客户端自己写循环”收敛到 Service Config:先限定方法,再配置尝试次数、退避和可重试状态码,最后用故障注入服务确认客户端确实发生了受控重试。
学习目标
- 能为指定 Unary RPC 写出合法的
retryPolicy。 - 能解释五个核心参数如何共同决定重试次数与等待节奏。
- 能通过服务端实际收到的 attempt 数验证策略是否命中。
先把策略作用域配准
gRPC 的重试策略写在 methodConfig 中。name.service 使用 Proto 里的完整服务名,name.method 写方法名;省略 method 时会作用于该服务的全部方法。透明重试与显式策略重试是两回事:要让业务状态码按既定次数和退避节奏重试,需要显式配置 retryPolicy。
下面只让 grpc.testing.TestService/UnaryCall 对 UNAVAILABLE 执行策略重试:
{
"methodConfig": [
{
"name": [
{
"service": "grpc.testing.TestService",
"method": "UnaryCall"
}
],
"retryPolicy": {
"maxAttempts": 4,
"initialBackoff": "0.05s",
"maxBackoff": "0.2s",
"backoffMultiplier": 2,
"retryableStatusCodes": ["UNAVAILABLE"]
}
}
]
}这份配置的验收标准不是“最终请求成功”这么简单,而是:第一次和第二次返回 UNAVAILABLE 后,客户端都创建新的 attempt;第三次服务端成功后,整个逻辑 RPC 结束。
在 gRPC-Go 中,grpc.WithDefaultServiceConfig 适合本地验证或为 Channel 提供兜底配置。它不是对 resolver 配置的强制覆盖;如果实际 resolver 下发了可用的 Service Config,应以 Channel 最终采用的配置为准。
看懂五个参数
| 参数 | 本例 | 关键语义 |
|---|---|---|
maxAttempts |
4 |
包含第一次调用,因此最多再重试 3 次 |
initialBackoff |
0.05s |
第一次策略重试前的基准退避 |
maxBackoff |
0.2s |
限制指数增长后的基准退避上限 |
backoffMultiplier |
2 |
每轮按倍数放大基准退避 |
retryableStatusCodes |
UNAVAILABLE |
只有命中的失败状态才进入策略重试 |
maxAttempts 必须大于 1,initialBackoff 和 maxBackoff 必须是大于 0 的 Duration,backoffMultiplier 必须大于 0,retryableStatusCodes 不能为空。初始 attempt 计入总次数;退避等待会带随机化,因此不要把 0.05s、0.1s 等理解成每次都精确固定的休眠时间。gRPC-Go 默认还会限制单次调用可执行的最大 attempt 数,可用 Channel 级 WithMaxCallAttempts 调整该上限,但不应把“能调大”当成增加重试的理由。
用故障注入验证策略命中
下面以 gRPC-Go v1.83.2 的 interop 测试 Stub 演示,避免额外展开 Proto 生成流程;业务项目应替换成自己的生成代码。在空目录中准备最小模块:
go mod init retry-demo
go get google.golang.org/grpc@v1.83.2预期结果:
生成 go.mod 和 go.sum,依赖解析成功;下载日志会因本地缓存不同而不同。把下面代码保存为 main.go。服务端前两次故意返回 UNAVAILABLE,第三次成功;客户端只发起一次逻辑调用。注意 Go 原始字符串使用反引号包裹,内部 JSON 的双引号不需要反斜杠转义。
package main
import (
"context"
"fmt"
"net"
"sync/atomic"
"time"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/credentials/insecure"
pb "google.golang.org/grpc/interop/grpc_testing"
"google.golang.org/grpc/status"
)
type retryServer struct {
pb.UnimplementedTestServiceServer
// 统计服务端真正看到的 attempt 数,而不是客户端逻辑调用数。
attempts atomic.Int32
}
func (s *retryServer) UnaryCall(context.Context, *pb.SimpleRequest) (*pb.SimpleResponse, error) {
n := s.attempts.Add(1)
// 前两次故意制造可重试的瞬时失败。
if n <= 2 {
fmt.Printf("server attempt=%d -> UNAVAILABLE\n", n)
return nil, status.Error(codes.Unavailable, "temporary failure")
}
fmt.Printf("server attempt=%d -> OK\n", n)
return &pb.SimpleResponse{}, nil
}
func main() {
// 使用随机本地端口,避免与机器上的固定服务冲突。
lis, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
panic(err)
}
s := grpc.NewServer()
pb.RegisterTestServiceServer(s, &retryServer{})
go func() { _ = s.Serve(lis) }()
defer s.Stop()
// 原始字符串里的 JSON 不转义双引号;策略只匹配 UnaryCall。
serviceConfig := `{"methodConfig":[{"name":[{"service":"grpc.testing.TestService","method":"UnaryCall"}],"retryPolicy":{"maxAttempts":4,"initialBackoff":"0.05s","maxBackoff":"0.2s","backoffMultiplier":2,"retryableStatusCodes":["UNAVAILABLE"]}}]}`
conn, err := grpc.NewClient(
lis.Addr().String(),
grpc.WithTransportCredentials(insecure.NewCredentials()),
grpc.WithDefaultServiceConfig(serviceConfig),
)
if err != nil {
panic(err)
}
defer conn.Close()
client := pb.NewTestServiceClient(conn)
// Deadline 约束整次逻辑 RPC,包括全部 attempt 与退避等待。
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
defer cancel()
if _, err := client.UnaryCall(ctx, &pb.SimpleRequest{}); err != nil {
panic(err)
}
fmt.Println("client result=OK")
}执行程序:
go run .预期输出:
server attempt=1 -> UNAVAILABLE
server attempt=2 -> UNAVAILABLE
server attempt=3 -> OK
client result=OK如果只看到一次 UNAVAILABLE 就结束,优先检查服务名和方法名是否匹配、状态码是否在 retryableStatusCodes 中,以及实际 Channel 是否采用了这份 Service Config。
识别不会继续重试的边界
策略命中并不意味着一定会耗尽 maxAttempts。一旦客户端收到响应 Header,RPC 就会被视为 committed,此后不会再按重试策略创建新的 attempt;整体 Deadline 到期时也会直接终止调用。
因此,生产验收至少同时观察逻辑 RPC 数、服务端 attempt 数、最终状态码和总耗时。把重试配置成可观测、可验证的客户端行为,比单纯把 maxAttempts 调大更重要。