Grpc-gateway流式HTTP响应解码失败：JSONPb.Decode返回nil值的排查与解决方法

本文针对使用grpc-gateway处理gRPC流式HTTP响应时，`runtime.jsonpb.Decode`返回nil值的问题，提供详细的排查和解决方法。 问题源于客户端解码时与服务器返回的JSON结构不匹配，以及grpc-gateway版本过低。文章分析了导致`runtime.jsonpb.Decode`失败的三个主要原因：grpc-gateway版本过低、响应结构不匹配和解码目标类型错误，并给出了相应的解决方案，包括升级grpc-gateway版本、修改proto文件定义匹配的message以及正确设置解码目标类型，最终实现正确解码流式HTTP响应数据。 通过本文，读者可以有效解决gRPC流式HTTP响应解码失败的问题，提升gRPC服务开发效率。

Grpc-gateway流式HTTP响应解码故障排查与修复指南

在使用grpc-gateway将gRPC服务转换为HTTP服务时，处理流式HTTP响应经常会遇到解码失败的问题。本文将分析一个典型的案例，并提供相应的解决方案。

问题描述： 客户端通过HTTP请求调用gRPC服务的流式响应方法，服务器端已正确返回JSON格式的流式数据，但客户端使用runtime.jsonpb.Decode解码时，却始终得到nil值。服务器端日志显示响应数据正确：

{"result":{"code":1,"msg":"1111"}}
{"result":{"code":2,"msg":"2222"}}
{"result":{"code":3,"msg":"3333"}}
{"result":{"code":4,"msg":"4444"}}
{"result":{"code":5,"msg":"5555"}}
{"result":{"code":6,"msg":"6666"}}

客户端解码结果为nil，表明解码过程存在问题。

相关代码片段：

proto文件 (./pb/test.proto):

syntax = "proto3";

package pb;

option go_package = "/pb;pb";

import "google/api/annotations.proto";

message Req {
    int32 id = 1;
    string name = 2;
}

message Resp {
    int32 code = 1;
    string msg = 2;
}

service TestService {
    rpc QueryStreamResp(Req) returns (stream Resp) {
        option (google.api.http) = {
            post: "/query-stream-resp"
            body: "*"
        };
    };
}

gRPC服务端代码 (Go):

func (ts *TestService) QueryStreamResp(req *pb.Req, stream pb.TestService_QueryStreamRespServer) error {
    // ... 服务端逻辑 ...
    for _, r := range result {
        log.Printf("resp: %+v", r)
        if err := stream.Send(r); err != nil {
            log.Fatal(err)
        }
        time.Sleep(100 * time.Millisecond)
    }
    // ... 服务端逻辑 ...
    return nil
}

单元测试代码 (Go):

func TestHttpRespStream(t *testing.T) {
    // ... 测试代码 ...
    jsonb := &runtime.JSONPb{}
    decoder := jsonb.NewDecoder(resp.Body)

    for {
        var result *pb.Resp
        err := decoder.Decode(result)
        // ... 测试代码 ...
    }
}

问题解决：

问题根源在于：

1. grpc-gateway版本过低： 建议升级到最新版本的github.com/grpc-ecosystem/grpc-gateway/v2。

2. 响应结构不匹配： grpc-gateway返回的JSON数据包含额外的result字段。需要在proto文件中定义匹配的message：

message HttpResp {
    Resp result = 1;
}

3. 解码目标类型错误： 解码时应使用*pb.HttpResp作为目标类型，并使用&result传递解码目标的地址。修改后的单元测试代码：

var result *pb.HttpResp
err := decoder.Decode(&result)

通过以上三点修改，解码问题即可解决，单元测试将正确打印每个流式响应数据。

今天关于《Grpc-gateway流式HTTP响应解码失败：JSONPb.Decode返回nil值的排查与解决方法》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！