protojson简介

google.golang.org/protobuf/encoding/protojson 是 Go 语言中的一个库，用于处理 Protocol Buffers（protobuf）和 JSON 之间的转换，遵循https://protobuf.dev/programming-guides/proto3#json实现。
以下是该库的一些主要功能：

• 将 protobuf 消息转换为 JSON 格式：这是通过 Marshal 或 MarshalOptions.Marshal 函数实现的。这些函数接收一个 protobuf 消息并返回一个 JSON 格式的字符串。
  
• 将 JSON 格式的数据转换为 protobuf 消息：这是通过 Unmarshal 或 UnmarshalOptions.Unmarshal 函数实现的。这些函数接收一个 JSON 格式的字符串和一个 protobuf 消息的指针，然后将 JSON 数据解析并填充到 protobuf 消息中。
  
• 自定义 JSON 编码和解码的行为：MarshalOptions 和 UnmarshalOptions 结构体提供了一些选项，可以用来自定义 JSON 编码和解码的行为。例如，可以通过 EmitUnpopulated 选项控制是否输出未设置的字段，通过 UseProtoNames 选项控制是否使用 protobuf 字段的原始名称作为 JSON 字段的键。
  
• 支持 Well-Known Types：该库提供了对 protobuf 的 Well-Known Types 的特殊处理，例如 Timestamp、Duration、Struct、Value 等。
  

接下来我们以下面的 .proto 为例，介绍下如何使用 google.golang.org/protobuf/encoding/protojson ，并简单对比下 proto 、 protojson 和 encoding/json 三者之间的性能对比:

1. syntax = "proto3";
3. package example.pb;
5. option go_package = "./;pb";
7. import "google/protobuf/struct.proto";
9. message Base {
10.     string tx_hash = 1;
11.     int64 timestamp = 2;
12.     google.protobuf.Struct extra = 3;
13.     uint64 block_number = 4;
14.     int32 category = 5;
15.   }
17. message CertGen {
18.     string id = 1;
19.     string issuer = 2;
20.     string name = 3;
21.     string number = 4;
22.     string seal_name = 5;
23.     string seal_number = 6;
24.     string sign_hash = 7;
25.     string date = 8;
26.     Base base = 9;
27. }

复制代码

1. func genData() *pb.CertGen {
2.         data := map[string]interface{}{
3.                 "name":  "1234",
4.                 "age":   12,
5.                 "score": 1345.452434,
6.         }
8.         extra, _ := structpb.NewStruct(data)
9.         base := &pb.Base{
10.                 TxHash:      "1234556",
11.                 Timestamp:   1234566,
12.                 Extra:       extra,
13.                 BlockNumber: 123456,
14.                 Category:    4,
15.         }
17.         return &pb.CertGen{
18.                 Id:         uuid.NewString(),
19.                 Issuer:     uuid.NewString(),
20.                 Name:       uuid.NewString(),
21.                 Number:     uuid.NewString(),
22.                 SealName:   uuid.NewString(),
23.                 SealNumber: uuid.NewString(),
24.                 SignHash:   uuid.NewString(),
25.                 Date:       time.Now().Format(time.DateTime),
26.                 Base:       base,
27.         }
28. }
30. func BenchmarkProto(b *testing.B) {
31.         gen := genData()
33.         for i := 0; i < b.N; i++ {
34.                 proto.Marshal(gen)
35.         }
36. }
38. func BenchmarkProtoJson(b *testing.B) {
39.         gen := genData()
41.         for i := 0; i < b.N; i++ {
42.                 protojson.Marshal(gen)
43.         }
44. }
46. func BenchmarkStdJson(b *testing.B) {
47.         gen := genData()
48.         for i := 0; i < b.N; i++ {
49.                 json.Marshal(gen)
50.         }
51. }

复制代码

结果如下：

1. $ go test -bench=.
2. goos: linux
3. goarch: amd64
4. pkg: example
5. cpu: 12th Gen Intel(R) Core(TM) i7-1260P
6. BenchmarkProto-16                 817065              1412 ns/op
7. BenchmarkProtoJson-16             218583              5372 ns/op
8. BenchmarkStdJson-16               343822              3216 ns/op
9. PASS
10. ok      example       3.554s

复制代码

声明：本作品采用署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)进行许可，使用时请注明出处。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 恋水无意

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！