README
¶
Protocol Buffer and gRPC Reflection
This repo provides reflection APIs for protocol buffers (also known as "protobufs" for short)
and gRPC. The core of reflection in protobufs is the
descriptor.
A descriptor is itself a protobuf message that describes a .proto source file or any element
therein. So a collection of descriptors can describe an entire schema of protobuf types, including
RPC services.
Descriptors: The Language Model of Protocol Buffers
import "github.com/jhump/protoreflect/desc"
The desc package herein introduces a Descriptor interface and implementations of it that
correspond to each of the descriptor types. These new types are effectively smart wrappers around
the generated protobuf types
that make them much more useful and easier to use.
You can construct descriptors from file descriptor sets (which can be generated by protoc), and
you can also load descriptors for messages and services that are linked into the current binary.
"What does it mean for messages and services to be linked in?" you may ask. It means your binary
imports a package that was generated by protoc. When you generate Go code from your .proto
sources, the resulting package has descriptor information embedded in it. The desc package allows
you to easily extract those embedded descriptors.
Descriptors can also be acquired directly from .proto source files (using the protoparse sub-package)
or by programmatically constructing them (using the builder sub-package).
import "github.com/jhump/protoreflect/desc/protoparse"
The protoparse package allows for parsing of .proto source files into rich descriptors. Without
this package, you must invoke protoc to either generate a file descriptor set file or to generate
Go code (which has descriptor information embedded in it). This package allows reading the source
directly without having to invoke protoc.
import "github.com/jhump/protoreflect/desc/protoprint"
The protoprint package allows for printing of descriptors to .proto source files. This is
effectively the inverse of the protoparse package. Combined with the builder package, this
is a useful tool for programmatically generating protocol buffer sources.
import "github.com/jhump/protoreflect/desc/builder"
The builder package allows for programmatic construction of rich descriptors. Descriptors can
be constructed programmatically by creating trees of descriptor protos and using the desc package
to link those into rich descriptors. But constructing a valid tree of descriptor protos is far from
trivial.
So this package provides generous API to greatly simplify that task. It also allows for converting rich descriptors into builders, which means you can programmatically modify/tweak existing descriptors.
Dynamic Messages and Stubs
import "github.com/jhump/protoreflect/dynamic"
The dynamic package provides a dynamic message implementation. It implements proto.Message but
is backed by a message descriptor and a map of fields->values, instead of a generated struct. This
is useful for acting generically with protocol buffer messages, without having to generate and link
in Go code for every kind of message. This is particularly useful for general-purpose tools that
need to operate on arbitrary protocol buffer schemas. This is made possible by having the tools load
descriptors at runtime.
import "github.com/jhump/protoreflect/dynamic/grpcdynamic"
There is also sub-package named grpcdynamic, which provides a dynamic stub implementation. The stub can
be used to issue RPC methods using method descriptors instead of generated client interfaces.
gRPC Server Reflection
import "github.com/jhump/protoreflect/grpcreflect"
The grpcreflect package provides an easy-to-use client for the
gRPC reflection service,
making it much easier to query for and work with the schemas of remote services.
It also provides some helper methods for querying for rich service descriptors for the services registered in a gRPC server.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package codec contains a reader/write type that assists with encoding and decoding protobuf's binary representation.
|
Package codec contains a reader/write type that assists with encoding and decoding protobuf's binary representation. |
|
Package desc contains "rich descriptors" for protocol buffers.
|
Package desc contains "rich descriptors" for protocol buffers. |
|
builder
Package builder contains a means of building and modifying proto descriptors programmatically.
|
Package builder contains a means of building and modifying proto descriptors programmatically. |
|
protoparse
Package protoparse provides functionality for parsing *.proto source files into descriptors that can be used with other protoreflect packages, like dynamic messages and dynamic GRPC clients.
|
Package protoparse provides functionality for parsing *.proto source files into descriptors that can be used with other protoreflect packages, like dynamic messages and dynamic GRPC clients. |
|
protoparse/ast
Package ast defines types for modeling the AST (Abstract Syntax Tree) for the protocol buffers source language.
|
Package ast defines types for modeling the AST (Abstract Syntax Tree) for the protocol buffers source language. |
|
protoprint
Package protoprint provides a mechanism to generate protobuf source code from descriptors.
|
Package protoprint provides a mechanism to generate protobuf source code from descriptors. |
|
sourceinfo
Package sourceinfo provides the ability to register and query source code info for file descriptors that are compiled into the binary.
|
Package sourceinfo provides the ability to register and query source code info for file descriptors that are compiled into the binary. |
|
Package dynamic provides an implementation for a dynamic protobuf message.
|
Package dynamic provides an implementation for a dynamic protobuf message. |
|
grpcdynamic
Package grpcdynamic provides a dynamic RPC stub.
|
Package grpcdynamic provides a dynamic RPC stub. |
|
msgregistry
Package msgregistry contains a registry of known message and enum types.
|
Package msgregistry contains a registry of known message and enum types. |
|
Package grpcreflect provides GRPC-specific extensions to protobuf reflection.
|
Package grpcreflect provides GRPC-specific extensions to protobuf reflection. |
|
Package internal contains some code that should not be exported but needs to be shared across more than one of the protoreflect sub-packages.
|
Package internal contains some code that should not be exported but needs to be shared across more than one of the protoreflect sub-packages. |