如何将 protoc-gen-go gzipped FileDescriptorProto 显示为纯文本？

今天golang学习网给大家带来了《如何将 protoc-gen-go gzipped FileDescriptorProto 显示为纯文本？》，其中涉及到的知识点包括等等，无论你是小白还是老手，都适合看一看哦~有好的建议也欢迎大家在评论留言，若是看完有所收获，也希望大家能多多点赞支持呀！一起加油学习~

protoc-gen-go 在生成的 go 文件末尾生成类似以下内容：

var fileDescriptor_13c75530f718feb4 = []byte{
    // 2516 bytes of a gzipped FileDescriptorProto
    0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xbc, 0x59, 0xdf, 0x6f, 0x1c, 0x47,
...
}

我想以纯文本形式阅读它以进行调试。如何做到这一点？

为什么我想要它 - 一个不应该不会在这个生成的文件中产生变化的小变化确实，我正在弄清楚为什么（而且很难调试，因为它只是一个二进制 blob）。

解决方案

我编写了这样的代码来解析和打印 blob。

关键逻辑其实来自https://github.com/grpc/grpc-go/blob/759de4dd00c25745b6f3d7a9fdfb32beaf1d838e/reflection/serverreflection.go#L202-L226

package main

import (
    "bytes"
    "compress/gzip"
    "encoding/json"
    "fmt"

    "io/ioutil"

    proto "github.com/golang/protobuf/proto"
    dpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
    _ [here write path to your generated go source]
    // include the line above if you want to use proto.FileDescriptor,
    // leave if you just copy-paste the bytes below
)

func main() {
    // here write the path that is used in the generated file
    // in init(), as an argument to proto.RegisterFile 
    // (or just copypaste the bytes instead of using proto.FileDescriptor)
    bytes := proto.FileDescriptor(XXX)

    fd, err := decodeFileDesc(bytes)
    if err != nil {
        panic(err)
    }
    b, err := json.MarshalIndent(fd,"","  ")
    if err != nil {
        panic(err)
    }
    fmt.Println(string(b))
}

// decompress does gzip decompression.
func decompress(b []byte) ([]byte, error) {
    r, err := gzip.NewReader(bytes.NewReader(b))
    if err != nil {
        return nil, fmt.Errorf("bad gzipped descriptor: %v", err)
    }
    out, err := ioutil.ReadAll(r)
    if err != nil {
        return nil, fmt.Errorf("bad gzipped descriptor: %v", err)
    }
    return out, nil
}

func decodeFileDesc(enc []byte) (*dpb.FileDescriptorProto, error) {
    raw, err := decompress(enc)
    if err != nil {
        return nil, fmt.Errorf("failed to decompress enc: %v", err)
    }

    fd := new(dpb.FileDescriptorProto)
    if err := proto.Unmarshal(raw, fd); err != nil {
        return nil, fmt.Errorf("bad descriptor: %v", err)
    }
    return fd, nil
}

这会以 json 形式打印 proto 文件中的数据。

正如 marc gravell 在另一个答案的评论中提到的，gzip 压缩是不确定的，因此同一个 proto 文件可以在两台不同的计算机上创建不同的 gzip 压缩 filedescriptorproto。

a filedescriptorproto 不是纯文本；它不包含原始模式作为文本，而是：它是由 descriptor.proto 定义的 filedescriptorproto 的 protobuf 二进制编码实例，包含原始模式的处理后的含义 .

所以；您可以将该有效负载反序列化（一旦解压缩）作为 filedescriptorproto，并使用“go”中可用的任何反射/元数据 api 以某种文本形式获取它。如果 protobuf 的 go 实现包含 protobuf json（而不是二进制）api，您可以在 filedescriptorproto 实例上调用 write-json api。注意：并非所有 protobuf 实现都实现 json api。

终于介绍完啦！小伙伴们，这篇关于《如何将 protoc-gen-go gzipped FileDescriptorProto 显示为纯文本？》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布Golang相关知识，快来关注吧！