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

最近在使用grpc協議的時候,因爲採用的是Proto3協議,在查找記錄信息的時候,因爲某些字段會有默認空值,致使在經過協議調用後,返回的json結構中並無這些字段,雖然做爲前端使用沒有太大的問題,可是在更多的使用場景中,咱們更須要知道該服務返回的確切字段,以便於可以作相應處理,尤爲是編譯型語言前端

具體的使用出現場景以下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協議下,會返回以下結果:api

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

此時就會出現空值的Age字段沒有返回到對應的json結構中,而這樣在某些狀況下對前端也是不太友好的,尤爲是APP客戶端,更須要明確的json響應字段結構,那麼咱們能夠怎麼處理這個問題呢,通過研究和網上的解答,有兩種辦法:app

  1. 直接修改通過protoc生成的member.pb.go文件代碼,刪除掉不但願被忽略的字段tag標籤中的omitempty便可,可是*.pb.go通常咱們不建議去修改它,並且咱們會常常去調整grpc微服務協議中的方法或者字段內容,這樣每次protoc以後,都須要咱們去修改,這顯然是不太現實的,所以就有了第二種辦法;
  2. 經過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處理代碼塊
}

寫這篇文章只是爲了吧這個解決方案分享給你們,但願對有此疑問的朋友們有所幫助。jsonp

相關文章
相關標籤/搜索