golang中使用proto3协议导致的空值字段不显示的问题处理方案

脚本专栏 2024/12/25 佚名

3 2 1

最近在使用grpc协议的时候，由于采用的是Proto3协议，在查找记录信息的时候，由于某些字段会有默认空值，导致在通过协议调用后，返回的json结构中并没有这些字段，虽然作为前端使用没有太大的问题，但是在更多的使用场景中，我们更需要知道该服务返回的确切字段，以便于能够做相应处理，尤其是编译型语言

具体的使用出现场景如下

type MemberResponse struct {
  Id int32 `json "id"`
  Phone string `json "phone"`
  Age int8 `json "age"`
}

//获取用户信息的接口
func (m *Member) GetMember(req *proto.MemberRequest, resp * proto.MemberResponse) error {
  resp.Phone = "15112810201"
  resp.Id = 12
  return nil
}

当通过api调用该微服务后，在proto3协议下，会返回如下结果：

{
  "phone" : "15112810201",
  "id"  : 12
}

此时就会出现空值的Age字段没有返回到对应的json结构中，而这样在某些情况下对前端也是不太友好的，尤其是APP客户端，更需要明确的json响应字段结构，那么我们可以怎么处理这个问题呢，经过研究和网上的解答，有两种办法：

直接修改经过protoc生成的member.pb.go文件代码，删除掉不希望被忽略的字段tag标签中的omitempty即可，但是*.pb.go一般我们不建议去修改它，而且我们会经常去调整grpc微服务协议中的方法或者字段内容，这样每次protoc之后，都需要我们去修改，这显然是不太现实的，因此就有了第二种办法；
通过grpc官方库中的jsonpb来实现,官方在它的设定中有一个结构体用来实现protoc buffer转换为JSON结构，并可以根据字段来配置转换的要求，结构体如下：

// Marshaler is a configurable object for converting between
// protocol buffer objects and a JSON representation for them.
type Marshaler struct {
  // 是否将枚举值设定为整数，而不是字符串类型.
  EnumsAsInts bool
  // 是否将字段值为空的渲染到JSON结构中
  EmitDefaults bool
  //缩进每个级别的字符串
  Indent string
  //是否使用原生的proto协议中的字段
  OrigName bool
}

了解了这个结构体之后呢，我们就开始对应的使用办法：

通过Marshaler结构体的Marshal方法，实现了将proto响应的内容转化为buffer，最终输出为JSON结构，从而实现了空值字段的返回

import (
  member "proto/member"
)
var jsonpbMarshaler *jsonpb.Marshaler

func queryHandler(req *http.Requst, resp http.ResponseWriter){
  var (
    _buffer bytes.Buffer
  )
  memberResponse, err := member.GetMember(context.TODO(), &member.MemberRequest{})
  //调用此方法实现转换
  jsonpbMarshaler.Marshal(&_buffer, memberResponse)
  jsonCnt := _buffer.Bytes()
  resp.Header().Set('Content-Type', 'application/json')
  resp.Write(jsonCnt)
  return
}

func main(){
  jsonpbMarshaler = &jsonpb.Marshaler{
    EnumsAsInts : true,
    EmitDefaults: true,
    OrigName  : true
  }
  //其他http处理代码块
}

写这篇文章只是为了吧这个解决方案分享给大家，希望对有此疑问的朋友们有所帮助。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

golang,proto3导致字段不显示,golang,字段不显示,proto3,空值字段不显示

标签：