大家好,我是煎魚。
前幾天我們交流了 gogo/protobuf 前兩年開始 Deprecated,作者最終放棄更新的事情,還是挺讓人深思的。
其作者在最終對官方 protobuf 庫最絕望的一個事情,莫過于他朝朝暮暮,但官方一直不愿支持的標簽注入功能。這也是很多人使用 gogo/protobuf 的原因。
如下圖所示:
圖片
我們來看看 gogo/protobuf 擴展(包含自定義結(jié)構(gòu)注入標簽功能),這是 gogo 的王牌功能之一,這是他的介紹:
圖片
其在 gogo.proto[1] 支持了各種各樣的 EnumOptions、FileOptions、MessageOptions、FieldOptions 等。
我們最常見編碼訴求是調(diào)整生成 struct 時字段的 JSON tag,對應 jsontag 的功能:
圖片
Proto 定義示例:
message Person { string name = 1; int32 id = 2 [(gogoproto.jsontag) = "id"]; // Unique ID number for this person. string email = 3; enum PhoneType { MOBILE = 0; HOME = 1; WORK = 2; } message PhoneNumber { string number = 1; PhoneType type = 2; } repeated PhoneNumber phones = 4; google.protobuf.Timestamp last_updated = 5;}
通過 protoc 和 plugin 生成后的 Go 代碼:
type Person struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Id int32 `protobuf:"varint,2,opt,name=id,proto3" json:"id"` Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"` Phones []*Person_PhoneNumber `protobuf:"bytes,4,rep,name=phones,proto3" json:"phones,omitempty"` LastUpdated *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=last_updated,jsnotallow=lastUpdated,proto3" json:"last_updated,omitempty"`}
生成后的結(jié)構(gòu)體中的 Id 字段,json tag 值為 id,沒有了 omitempty。可以解決很多同學在與前端對接時的一些煩惱。
圖片
除此之外還有很多用法,有興趣的同學可以詳細查看 More Canonical Go Structures[2]。
那為什么 golang/protobuf 一直不支持這些 protobuf 的擴展功能特性呢?
圖片
直接明確拒絕,引來社區(qū)大范圍表情反對。(并沒有什么用)。
具體 golang/protobuf 不支持的原因,其項目成員在社區(qū)的多年爭斗下,給出了相對明確的答復。
如下圖所示:
圖片
圖片
說白了,官方覺得這個特性太 Go 語言定制化了,不愿意支持。
雖然現(xiàn)在 gogo 這一個開源項目已經(jīng)進入廢棄階段,但根據(jù) issues 內(nèi)推薦的情況。可以選擇繼續(xù)使用 gogo,或者使用 protoc-go-inject-tag[3] 這一個項目。
簡單例子,Proto 定義:
// file: test.protosyntax = "proto3";package pb;option go_package = "/pb";message IP { // @gotags: valid:"ip" string Address = 1; // Or: string MAC = 2; // @gotags: validate:"omitempty"}
通過 protoc 和 plugin 生成后的 Go 代碼:
type IP struct { // @gotags: valid:"ip" Address string `protobuf:"bytes,1,opt,name=Address,jsnotallow=address" json:"Address,omitempty" valid:"ip"`}
可以明確看懂 json tag 多了 valid:"ip",符合我們在 proto 文件中聲明的注解訴求。
通過兩篇文章梳理下來,對于整個前因后果和功能特性,我們都有了相對全面的學習和了解了。
官方 golang/protobuf 固然有自己的原則,社區(qū)也有自己的需求。開源的項目過大了,長年累月下來會難維護。
可能像 protoc-go-inject-tag 這種較為單一職責的開源庫,會活的更好,也會更好找到新的人銜接。也是一個不錯的方向。
[1]gogo.proto: https://github.com/gogo/protobuf/blob/master/gogoproto/gogo.proto
[2]More Canonical Go Structures: https://github.com/gogo/protobuf/blob/master/extensions.md#more-canonical-go-structures
[3]protoc-go-inject-tag: https://github.com/favadi/protoc-go-inject-tag
本文鏈接:http://www.tebozhan.com/showinfo-26-91372-0.html為什么 Go Protobuf 不支持標簽注入?
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識,若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系,我們將在第一時間刪除處理。郵件:2376512515@qq.com
上一篇: 大型前端應用如何做系統(tǒng)融合?