golang中使用proto3協(xié)議導致的空值字段不顯示的問題處理方案

更新時間：2019年10月16日 11:55:13 作者：夜颩偲雨

這篇文章主要介紹了golang中使用proto3協(xié)議導致的空值字段不顯示的問題處理方案，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

最近在使用grpc協(xié)議的時候，由于采用的是Proto3協(xié)議，在查找記錄信息的時候，由于某些字段會有默認空值，導致在通過協(xié)議調(diào)用后，返回的json結(jié)構(gòu)中并沒有這些字段，雖然作為前端使用沒有太大的問題，但是在更多的使用場景中，我們更需要知道該服務返回的確切字段，以便于能夠做相應處理，尤其是編譯型語言

具體的使用出現(xiàn)場景如下

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調(diào)用該微服務后，在proto3協(xié)議下，會返回如下結(jié)果：

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

此時就會出現(xiàn)空值的Age字段沒有返回到對應的json結(jié)構(gòu)中，而這樣在某些情況下對前端也是不太友好的，尤其是APP客戶端，更需要明確的json響應字段結(jié)構(gòu)，那么我們可以怎么處理這個問題呢，經(jīng)過研究和網(wǎng)上的解答，有兩種辦法：

直接修改經(jīng)過protoc生成的member.pb.go文件代碼，刪除掉不希望被忽略的字段tag標簽中的omitempty即可，但是*.pb.go一般我們不建議去修改它，而且我們會經(jīng)常去調(diào)整grpc微服務協(xié)議中的方法或者字段內(nèi)容，這樣每次protoc之后，都需要我們?nèi)バ薷模@顯然是不太現(xiàn)實的，因此就有了第二種辦法；
通過grpc官方庫中的jsonpb來實現(xiàn),官方在它的設定中有一個結(jié)構(gòu)體用來實現(xiàn)protoc buffer轉(zhuǎn)換為JSON結(jié)構(gòu)，并可以根據(jù)字段來配置轉(zhuǎn)換的要求，結(jié)構(gòu)體如下：

// Marshaler is a configurable object for converting between
// protocol buffer objects and a JSON representation for them.
type Marshaler struct {
  // 是否將枚舉值設定為整數(shù)，而不是字符串類型.
  EnumsAsInts bool
  // 是否將字段值為空的渲染到JSON結(jié)構(gòu)中
  EmitDefaults bool
  //縮進每個級別的字符串
  Indent string
  //是否使用原生的proto協(xié)議中的字段
  OrigName bool
}

了解了這個結(jié)構(gòu)體之后呢，我們就開始對應的使用辦法：

通過Marshaler結(jié)構(gòu)體的Marshal方法，實現(xiàn)了將proto響應的內(nèi)容轉(zhuǎn)化為buffer，最終輸出為JSON結(jié)構(gòu)，從而實現(xiàn)了空值字段的返回

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{})
  //調(diào)用此方法實現(xiàn)轉(zhuǎn)換
  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處理代碼塊
}

寫這篇文章只是為了吧這個解決方案分享給大家，希望對有此疑問的朋友們有所幫助。

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: