Snapshot of gogo/protobuf: 5.7k★, Go, Backend. [Deprecated] Protocol Buffers for Go with Gadgets
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
gogoprotobuf is a fork of golang/protobuf with extra code generation features.
This code generation is used to achieve:
fast marshalling and unmarshalling
more canonical Go structures
goprotobuf compatibility
less typing by optionally generating extra helper code
peace of mind by optionally generating test and benchmark code
other serialization formats
Keeping track of how up to date gogoprotobuf is relative to golang/protobuf is done in this
issue
Release v1.3.0
The project has updated to release v1.3.0. Check out the release notes here.
With this new release comes a new internal library version. This means any newly generated *pb.go files generated with the v1.3.0 library will not be compatible with the old library version (v1.2.1). However, current *pb.go files (generated with v1.2.1) should still work with the new library.
Please make sure you manage your dependencies correctly when upgrading your project. If you are still using v1.2.1 and you update your dependencies, one of which could include a new *pb.go (generated with v1.3.0), you could get a compile time error.
Our upstream repo, golang/protobuf, also had to go through this process in order to update their library version.
Here is a link explaining hermetic builds.
Users
These projects use gogoprotobuf:
etcd - blog - sample proto file
spacemonkey - blog
badoo - sample proto file
mesos-go - sample proto file
heka - the switch from golang/protobuf to gogo/protobuf when it was still on code.google.com
cockroachdb - sample proto file
go-ipfs - sample proto file
rkive-go - sample proto file
dropbox
srclib - sample proto file
adyoulike
cloudfoundry - sample proto file
kubernetes - go2idl built on top of gogoprotobuf
dgraph - release notes - benchmarks
centrifugo - release notes - blog
docker swarmkit - sample proto file
nats.io - go-nats-streaming
tidb - Communication between tidb and tikv
protoactor-go - vanity command that also generates actors from service definitions
containerd - vanity command with custom field names that conforms to the golang convention.
nakama
proteus
carbonzipper stack
sendgrid
zero-os/0-stor
go-spacemesh
cortex - sample proto file
Apache SkyWalking APM - Istio telemetry receiver based on Mixer bypass protocol
Hyperledger Burrow - a permissioned DLT framework
IOV Weave - a blockchain framework - sample proto files
Please let us know if you are using gogoprotobuf by posting on our GoogleGroup.
Mentioned
Cloudflare - go serialization talk - Albert Strasheim
GopherCon 2014 Writing High Performance Databases in Go by Ben Johnson
alecthomas' go serialization benchmarks
Go faster with gogoproto - Agniva De Sarker
Evolution of protobuf (Gource Visualization) - Landon Wilkins
Creating GopherJS Apps with gRPC-Web - Johan Brandhorst
So you want to use GoGo Protobuf - Johan Brandhorst
Advanced gRPC Error Usage - Johan Brandhorst
gRPC Golang Course on Udemy - Stephane Maarek
Preparing for GopherCon UK 2022
Getting Started
There are several ways to use gogoprotobuf, but for all you need to install go and protoc.
After that you can choose:
Speed
More Speed and more generated code
Most Speed and most customization
Installation
To install it, you must first have Go (at least version 1.6.3 or 1.9 if you are using gRPC) installed (see http://golang.org/doc/install).
Latest patch versions of 1.12 and 1.15 are continuously tested.
Next, install the standard protocol buffer implementation from https://github.com/google/protobuf.
Most versions from 2.3.1 should not give any problems, but 2.6.1, 3.0.2 and 3.14.0 are continuously tested.
Speed
Install the protoc-gen-gofast binary
go get github.com/gogo/protobuf/protoc-gen-gofast
Use it to generate faster marshaling and unmarshaling go code for your protocol buffers.
protoc --gofast_out=. myproto.proto
This does not allow you to use any of the other gogoprotobuf extensions.
More Speed and more generated code
Fields without pointers cause less time in the garbage collector.
More code generation results in more convenient methods.
Other binaries are also included:
protoc-gen-gogofast (same as gofast, but imports gogoprotobuf)
protoc-gen-gogofaster (same as gogofast, without XXX_unrecognized, less pointer fields)
protoc-gen-gogoslick (same as gogofaster, but with generated string, gostring and equal methods)
Installing any of these binaries is easy. Simply run:
go get github.com/gogo/protobuf/proto
go get github.com/gogo/protobuf/{binary}
go get github.com/gogo/protobuf/gogoproto
These binaries allow you to use gogoprotobuf extensions. You can also use your own binary.
To generate the code, you also need to set the include path properly.
Note that in the protoc command, {binary} does not contain the initial prefix of "protoc-gen".
Most Speed and most customization
Customizing the fields of the messages to be the fields that you actually want to use removes the need to copy between the structs you use and structs you use to serialize.
gogoprotobuf also offers more serialization formats and generation of tests and even more methods.
Please visit the extensions page for more documentation.
Install protoc-gen-gogo:
go get github.com/gogo/protobuf/proto
go get github.com/gogo/protobuf/jsonpb
go get github.com/gogo/protobuf/protoc-gen-gogo
go get github.com/gogo/protobuf/gogoproto
GRPC
It works the same as golang/protobuf, simply specify the plugin.
Here is an example using gofast:
protoc --gofast_out=plugins=grpc:. my.proto
See https://github.com/gogo/grpc-example for an example of using gRPC with gogoprotobuf and the wider grpc-ecosystem.
License
This software is licensed under the 3-Clause BSD License
("BSD License 2.0", "Revised BSD License", "New BSD License", or "Modified BSD License").
The most recent commit recorded on gogo/protobuf was 3.3 years ago, based on the GitHub push timestamp. The repository has 798 forks — one of the better signals of community interest.
How does gogo/protobuf compare to other Backend projects?
gogo/protobuf is tracked by TopGit in the Backend category, with 5.7k GitHub stars and written in Go. Browse the Backend topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does gogo/protobuf have?
gogo/protobuf has 5.7k GitHub stars — refresh the page for the live number, or check github.com/gogo/protobuf. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is gogo/protobuf?
gogo/protobuf (gogo/protobuf) is a Go project on GitHub. From the project's own README: [Deprecated] Protocol Buffers for Go with Gadgets
What language is gogo/protobuf written in?
gogo/protobuf is written primarily in Go. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is gogo/protobuf associated with?
GitHub's repository topics for gogo/protobuf: "go", "golang", "grpc", "protobuf", "protocol-buffers". TopGit's editorial category is Backend.
Why is gogo/protobuf categorized under Backend?
TopGit places gogo/protobuf in the Backend category based on its GitHub topics and description (tagged: "go", "golang", "grpc"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Want a second opinion on protobuf?
Ask an AI that can read this page — one click and you get its take on protobuf.