如何为gRPC的CloseAndRecv设置超时，避免服务器宕机时请求挂起？

问题描述 #

客户端已完成向服务器的流传输，调用由protoc-gen-go-grpc生成的stream.CloseAndRecv()方法获取响应，但服务器宕机时请求会挂起。该方法的实现如下：

func (x *Client) CloseAndRecv() (*Response, error) {
    if err := x.ClientStream.CloseSend(); err != nil {
       return nil, err
    }
    m := new(Response)
    if err := x.ClientStream.RecvMsg(m); err != nil {
       return nil, err
    }
    return m, nil
}

在RecvMsg的实现中未找到显式的超时设置，但这是常见问题，需要可行的解决方案。

解决方案 #

gRPC的超时控制核心依赖Context，底层的RecvMsg会监听Context的状态，一旦上下文超时或被取消就会终止请求。以下是两种实用方案：

方案1：为整个客户端流设置全局超时 #

在创建客户端流时，直接传入带超时的Context，这样包括CloseAndRecv在内的整个流生命周期都会受超时限制：

// 创建10秒超时的上下文，记得defer释放资源
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()

// 初始化客户端流时传入该上下文
stream, err := client.YourStreamingRPCMethod(ctx)
if err != nil {
    // 处理初始化错误
}

// 向服务器发送流数据...
if err := stream.SendMsg(&YourRequest{}); err != nil {
    // 处理发送错误
}

// 调用CloseAndRecv，超时后会自动返回DeadlineExceeded错误
resp, err := stream.CloseAndRecv()
if err != nil {
    if status.Code(err) == codes.DeadlineExceeded {
        // 处理超时逻辑，比如重试、返回提示
    }
    // 处理其他gRPC错误
}

方案2：单独为CloseAndRecv设置超时 #

如果只需要给CloseAndRecv步骤单独加超时（不影响之前的流传输），可以用goroutine配合select实现：

var resp *Response
var recvErr error

// 启动goroutine执行CloseAndRecv
go func() {
    resp, recvErr = stream.CloseAndRecv()
}()

// 监听超时、上下文取消和结果返回
select {
case <-time.After(10 * time.Second):
    // 超时触发，主动关闭流并返回超时错误
    _ = stream.CloseSend()
    // 若有上下文，可主动取消
    cancel()
    return nil, status.Error(codes.DeadlineExceeded, "CloseAndRecv 超时")
case <-stream.Context().Done():
    // 上下文被外部取消，返回对应错误
    return nil, stream.Context().Err()
default:
    // 正常收到响应或错误，返回结果
    return resp, recvErr
}

补充说明 #

RecvMsg中没有显式超时参数，是因为gRPC将超时、取消等控制逻辑统一放到了Context中。底层实现会持续监听Context的Done()通道，一旦触发就立即终止接收并返回错误，无需在方法中单独配置。

内容的提问来源于stack exchange，提问作者fpawel