Is github.com/golang/protobuf still maintained?

Yes, but it's in maintenance mode for compatibility. The README recommends new code use `google.golang.org/protobuf`, and versions v1.4+ are implemented atop the newer module, with no active feature development.

How to generate Go code from a .proto file?

Install the protoc-gen-go binary from this module, then run protoc with the --go_out flag. This processes .proto files to produce Go structs and methods, as detailed in the protocol buffers Go tutorial.

What's the difference between golang/protobuf and google.golang.org/protobuf?

golang/protobuf is the older module with a simpler API, while google.golang.org/protobuf is the newer version offering protobuf reflection, better performance, and a modernized API. The newer one is preferred for all new projects.

Can I use protocol buffers with gRPC in Go?

Absolutely. This module provides the serialization backbone for gRPC services in Go, allowing you to define service interfaces and message types in .proto files for efficient inter-service communication.

How to serialize a protobuf message to JSON in Go?

Use the jsonpb package's Marshaler to convert protobuf messages to JSON. It handles protobuf-specific fields like timestamps correctly, though it requires explicit configuration compared to standard JSON marshaling.

What are the well-known types and how do I use them?

Well-known types like Timestamp and Duration have helper packages under ptypes. These provide functions for easy conversion between protobuf messages and Go time or duration types, simplifying common operations.

Open-Awesome

goprotobuf

BSD-3-ClauseGov1.5.4

Go bindings for Google's protocol buffers, providing serialization, deserialization, and message manipulation.

GitHub

10.1k stars1.6k forks0 contributors

What is goprotobuf?

golang/protobuf is a Go module that provides language bindings for Google's protocol buffers. It allows Go developers to serialize structured data into a compact binary format and deserialize it back, enabling efficient data exchange between services. The module includes packages for message manipulation, JSON serialization, and code generation from .proto files.

Target Audience

Go developers building distributed systems, microservices, or any application requiring efficient serialization and data interchange between components.

Value Proposition

It provides official, stable Go support for protocol buffers with comprehensive functionality including binary/JSON serialization and code generation. Developers choose it for its reliability, performance, and seamless integration with the Go ecosystem and gRPC.

Overview

Go support for Google's protocol buffers

Use Cases

Best For

Building microservices that need efficient inter-service communication
Creating APIs with strongly-typed data contracts
Storing structured data in a compact binary format
Generating Go code from .proto schema definitions
Exchanging data between Go services and services in other languages
Implementing gRPC services in Go

Not Ideal For

New projects starting today, as the README explicitly recommends using the newer `google.golang.org/protobuf` module for an updated API and features.
Applications prioritizing human-readable data interchange without tooling overhead, since protocol buffers require JSON conversion via jsonpb rather than native support.
Teams seeking a schema-less or dynamic serialization format like JSON or YAML without code generation, as protobufs mandate strict .proto definitions and generated Go code.

Pros & Cons

Pros

Official Google Support

As the original Go bindings from Google, it provides reliable, stable implementations that faithfully adhere to the protocol buffer specification, ensuring broad compatibility.

Efficient Binary Serialization

Uses a compact binary format for fast data exchange between services, reducing payload size and improving performance in distributed systems like microservices.

Comprehensive Code Generation

The protoc-gen-go binary generates Go packages from .proto files, automating type-safe code and reducing manual errors in data contracts.

JSON Serialization Flexibility

Via the jsonpb package, it allows serialization of protobuf messages to JSON, enabling integration with web APIs and debugging without sacrificing binary efficiency.

Cons

Superseded by Newer Module

The README clearly states this module is legacy and implemented in terms of `google.golang.org/protobuf`, making it less ideal for new code due to missing features like protobuf reflection.

Complex Toolchain Dependency

Requires managing the protoc compiler and plugins for code generation, adding setup complexity compared to pure-Go serialization libraries that work without external tools.

Breaking Changes Risk

The project reserves the right to make breaking changes for security, bugs, or specification updates, as noted in the compatibility section, which could introduce instability in production systems.

Frequently Asked Questions

Related Projects

jsoniter

A high-performance 100% compatible drop-in replacement of "encoding/json"

Stars13,893

Forks1,055

Last commit2 years ago

go-codec

idiomatic codec and rpc lib for msgpack, cbor, json, etc. msgpack.org[Go]

Stars1,952

Forks311

Last commit29 days ago

cbor

CBOR codec (RFC 8949, RFC 8742) with CBOR tags, Go struct tag options (toarray, keyasint, omitempty, omitzero), float64/32/16, big.Int, and fuzz tested.

Stars1,052

Forks77

Last commit3 days ago

csvutil

csvutil provides fast and idiomatic mapping between CSV and Go (golang) values.

Stars1,035

Forks68

Last commit1 year ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub