修复grpc 返回字段为该字段类型的默认值时，不传该字段问题

最新推荐文章于 2024-06-26 17:42:54 发布

原创最新推荐文章于 2024-06-26 17:42:54 发布 · 3.4k 阅读

1 ·

CC 4.0 BY-SA版权

go 同时被 2 个专栏收录

2 篇文章

订阅专栏

grpc

1 篇文章

订阅专栏

本文探讨了在使用Go的gRPC通信中遇到的问题：当返回字段为默认值时，gRPC不会传输该字段，导致客户端数据结构不完整。文章提供了两种解决方法：一是通过自定义JSON序列化方式确保默认值的传输；二是利用grpc-gateway并配置JSONPb选项，以实现对默认值的正确处理。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在使用go 的grpc通信时，会有一个坑，当grpc 返回字段为该字段类型的默认值时，为了节省带宽，不会传输该字段，这对客户端来说，数据结构不严谨，解决办法

grpc :

import (
        pb "github.com/golang/protobuf/jsonpb"
)

func marshalJsonp(pbMsg proto.Message) (msg []byte, err error) {
	m := pb.Marshaler{EmitDefaults: true, OrigName: true}
	var data bytes.Buffer
	err = m.Marshal(&data, pbMsg)
	return data.Bytes(), err
}

grpc-gateway

package main

import (
  "flag"
  "net/http"

  "github.com/golang/glog"
  "golang.org/x/net/context"
  "github.com/grpc-ecosystem/grpc-gateway/runtime"
  "google.golang.org/grpc"
	
  gw "path/to/your_service_package"
)

var (
  echoEndpoint = flag.String("echo_endpoint", "localhost:9090", "endpoint of YourService")
)

func run() error {
  ctx := context.Background()
  ctx, cancel := context.WithCancel(ctx)
  defer cancel()

  mux := runtime.NewServeMux(runtime.WithMarshalerOption(runtime.MIMEWildcard, &runtime.JSONPb{OrigName: true, EmitDefaults: true})
  opts := []grpc.DialOption{grpc.WithInsecure()}
  err := gw.RegisterYourServiceHandlerFromEndpoint(ctx, mux, *echoEndpoint, opts)
  if err != nil {
    return err
  }

  return http.ListenAndServe(":8080", mux)
}

func main() {
  flag.Parse()
  defer glog.Flush()

  if err := run(); err != nil {
    glog.Fatal(err)
  }
}

起作用的就是下面这句配置：

mux := runtime.NewServeMux(runtime.WithMarshalerOption(runtime.MIMEWildcard, &runtime.JSONPb{OrigName: true, EmitDefaults: true})