为什么 Go Protobuf 不支持标签注入？

大家好，我是煎鱼。

前几天我们交流了 gogo/protobuf 前两年开始 Deprecated，作者最终放弃更新的事情，还是挺让人深思的。

其作者在最终对官方 protobuf 库最绝望的一个事情，莫过于他朝朝暮暮，但官方一直不愿支持的标签注入功能。这也是很多人使用 gogo/protobuf 的原因。

如下图所示：

图片

标签注入是什么功能

我们来看看 gogo/protobuf 扩展（包含自定义结构注入标签功能），这是 gogo 的王牌功能之一，这是他的介绍：

图片

其在 gogo.proto[1] 支持了各种各样的 EnumOptions、FileOptions、MessageOptions、FieldOptions 等。

我们最常见编码诉求是调整生成 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"`
}

生成后的结构体中的 Id 字段，json tag 值为 id，没有了 omitempty。可以解决很多同学在与前端对接时的一些烦恼。

图片

除此之外还有很多用法，有兴趣的同学可以详细查看 More Canonical Go Structures[2]。

为什么官方不支持

那为什么 golang/protobuf 一直不支持这些 protobuf 的扩展功能特性呢？

图片

直接明确拒绝，引来社区大范围表情反对。（并没有什么用）。

具体 golang/protobuf 不支持的原因，其项目成员在社区的多年争斗下，给出了相对明确的答复。

如下图所示：

图片

图片

• 这个功能在 Go 语言中非常实用，官方承认且认可。
• 如果调整或支持此功能，均超出了 golang/protobuf 包的适用范围。因为官方包的定义是不与某一门编程语言强相关。
• 如果 golang/protobuf 实现了这个功能，会出现其他语言无法有效利用此特性的情况。

说白了，官方觉得这个特性太 Go 语言定制化了，不愿意支持。

有什么替代方案

虽然现在 gogo 这一个开源项目已经进入废弃阶段，但根据 issues 内推荐的情况。可以选择继续使用 gogo，或者使用 protoc-go-inject-tag[3] 这一个项目。

简单例子，Proto 定义：

// file: test.proto
syntax = "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 固然有自己的原则，社区也有自己的需求。开源的项目过大了，长年累月下来会难维护。

可能像 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