Golang是否提供了一种简单的方法来输出可读性强的protobuf格式？

huangapple
go评论131阅读模式
英文:

Does golang provide an easy way to output human readable protobuf

问题

在Golang中，有没有一种好的方法可以获取Protobuf对象的可读字符串表示？类似于https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.DebugString这样的功能？

我正在使用https://github.com/golang/protobuf。

英文:

Is there a good way to get a human readable string representation of protobuf objects in golang? Something equivalent to https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.message#Message.DebugString?

I am using https://github.com/golang/protobuf.

答案1

得分: 17

我相信你正在寻找proto.MarshalTextString。

  1. p := &example.Test{
  2.   Label: proto.String("this"),
  3.   Reps:  []int64{4, 3, 2, 1},
  4.   InnerTest: &example.Test_InnerTest{
  5.     InnerLabel: proto.String("is the end"),
  6.   },
  7. }
  9. fmt.Println(proto.MarshalTextString(p))

你可以在Go包test中看到一个示例。

英文:

I believe you're looking for proto.MarshalTextString.

  1. p := &example.Test{
  2.   Label: proto.String("this"),
  3.   Reps:  []int64{4, 3, 2, 1},
  4.   InnerTest: &example.Test_InnerTest{
  5.     InnerLabel: proto.String("is the end"),
  6.   },
  7. }
  9. fmt.Println(proto.MarshalTextString(p))

You can see an example in the Go package test.

答案2

得分: 4

你可以使用TextMarshaler。使用稍作修改的示例 proto：

  1. p := &example.Test{
  2.     Label: proto.String("this"),
  3.     Reps:  []int64{4, 3, 2, 1},
  4.     InnerTest: &example.Test_InnerTest{
  5.         InnerLabel: proto.String("is the end"),
  6.     },
  7. }
  9. t := proto.TextMarshaler{}
  10. t.Marshal(os.Stdout, p)

输出结果为：

  1. label: "this"
  2. reps: 4
  3. reps: 3
  4. reps: 2
  5. reps: 1
  6. inner_test: <
  7.   inner_label: "is the end"
  8. >
英文:

You can use the TextMarshaler. With a slightly modified example proto:

  1. p := &amp;example.Test{
  2. 	Label: proto.String(&quot;this&quot;),
  3. 	Reps:  []int64{4, 3, 2, 1},
  4. 	InnerTest: &amp;example.Test_InnerTest{
  5. 		InnerLabel: proto.String(&quot;is the end&quot;),
  6. 	},
  7. }
  9. t := proto.TextMarshaler{}
  10. t.Marshal(os.Stdout, p)

Outputs:

  1. label: &quot;this&quot;
  2. reps: 4
  3. reps: 3
  4. reps: 2
  5. reps: 1
  6. inner_test: &lt;
  7.   inner_label: &quot;is the end&quot;
  8. &gt;

答案3

得分: 4

示例一：

  1. package main
  2. import "google.golang.org/protobuf/types/known/structpb"
  4. func example1(x *structpb.Struct) string {
  5.    return x.String()
  6. }

示例二：

  1. package main
  3. import (
  4.    "google.golang.org/protobuf/proto"
  5.    "google.golang.org/protobuf/runtime/protoimpl"
  6. )
  8. func example2(m proto.Message) string {
  9.    return protoimpl.X.MessageStringOf(m)
  10. }

示例三：

  1. package main
  3. import (
  4.    "google.golang.org/protobuf/encoding/protojson"
  5.    "google.golang.org/protobuf/proto"
  6. )
  8. func example3(m proto.Message) string {
  9.    return protojson.Format(m)
  10. }

测试：

  1. package main
  2. import "google.golang.org/protobuf/types/known/structpb"
  4. func main() {
  5.    m, err := structpb.NewStruct(map[string]interface{}{
  6.       "month": 12, "day": 31,
  7.    })
  8.    if err != nil {
  9.       panic(err)
  10.    }
  11.    println(example1(m))
  12.    println(example2(m))
  13.    println(example3(m))
  14. }

结果：

  1. fields:{key:"day" value:{number_value:31}} fields:{key:"month" value:{number_value:12}}
  2. fields:{key:"day" value:{number_value:31}} fields:{key:"month" value:{number_value:12}}
  3. {
  4.   "day": 31,
  5.   "month": 12
  6. }
英文:

Example one:

  1. package main
  2. import &quot;google.golang.org/protobuf/types/known/structpb&quot;
  4. func example1(x *structpb.Struct) string {
  5.    return x.String()
  6. }

Example two:

  1. package main
  3. import (
  4.    &quot;google.golang.org/protobuf/proto&quot;
  5.    &quot;google.golang.org/protobuf/runtime/protoimpl&quot;
  6. )
  8. func example2(m proto.Message) string {
  9.    return protoimpl.X.MessageStringOf(m)
  10. }

Example three:

  1. package main
  3. import (
  4.    &quot;google.golang.org/protobuf/encoding/protojson&quot;
  5.    &quot;google.golang.org/protobuf/proto&quot;
  6. )
  8. func example3(m proto.Message) string {
  9.    return protojson.Format(m)
  10. }

Test:

  1. package main
  2. import &quot;google.golang.org/protobuf/types/known/structpb&quot;
  4. func main() {
  5.    m, err := structpb.NewStruct(map[string]interface{}{
  6.       &quot;month&quot;: 12, &quot;day&quot;: 31,
  7.    })
  8.    if err != nil {
  9.       panic(err)
  10.    }
  11.    println(example1(m))
  12.    println(example2(m))
  13.    println(example3(m))
  14. }

Result:

  1. fields:{key:&quot;day&quot; value:{number_value:31}} fields:{key:&quot;month&quot; value:{number_value:12}}
  2. fields:{key:&quot;day&quot; value:{number_value:31}} fields:{key:&quot;month&quot; value:{number_value:12}}
  3. {
  4.   &quot;day&quot;: 31,
  5.   &quot;month&quot;: 12
  6. }

答案4

得分: 1

你可以使用MarshalToString，如果你需要将你的PB编组为一个结构化消息（JSON格式）以供将来使用。

一个简单的例子：

  1. marshaler := &jsonpb.Marshaler{}
  2. reqString, err := marshaler.MarshalToString(req)
  3. log.Println("@@REQ@@", reqString)

或者参考官方单元测试也可以。

英文:

You can use MarshalToString, if you need to marshal your PB into a structured message(in JSON) for future use.

A simple example:

  1. marshaler := &amp;jsonpb.Marshaler{}
  2. reqString, err := marshaler.MarshalToString(req)
  3. log.Println(&quot;@@REQ@@&quot;, reqString)

Or refer to official unit test is ok.

huangapple
  • 本文由 发表于 2016年2月20日 05:33:05
  • 转载请务必保留本文链接：https://go.coder-hub.com/35515449.html
  • go
  • protocol-buffers
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定