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

最近在使用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響應字段結構，那麼我們可以怎麼處理這個問題呢，經過研究和網上的解答，有兩種辦法：

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處理代碼塊
}

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