Book Image

Protocol Buffers Handbook

By : Clément Jean
Book Image

Protocol Buffers Handbook

By: Clément Jean

Overview of this book

Explore how Protocol Buffers (Protobuf) serialize structured data and provides a language-neutral, platform-neutral, and extensible solution. With this guide to mastering Protobuf, you'll build your skills to effectively serialize, transmit, and manage data across diverse platforms and languages. This book will help you enter the world of Protocol Buffers by unraveling the intricate nuances of Protobuf syntax and showing you how to define complex data structures. As you progress, you’ll learn schema evolution, ensuring seamless compatibility as your projects evolve. The book also covers advanced topics such as custom options and plugins, allowing you to tailor validation processes to your specific requirements. You’ll understand how to automate project builds using cutting-edge tools such as Buf and Bazel, streamlining your development workflow. With hands-on projects in Go and Python programming, you’ll learn how to practically apply Protobuf concepts. Later chapters will show you how to integrate data interchange capabilities across different programming languages, enabling efficient collaboration and system interoperability. By the end of this book, you’ll have a solid understanding of Protobuf internals, enabling you to discern when and how to use and redefine your approach to data serialization.
Table of Contents (13 chapters)

Using Buf

Important message

For this section, you are going to need Buf CLI. You can find how to install it here: https://buf.build/docs/installation.

The next tool that is important to know is Buf (https://buf.build/). This is mainly a CLI tool that deals with your proto files in some way. It can build them, lint them, format them, check for breaking changes, and so on. It is very interesting because it can help you with every step of the CI/CD pipeline.

Let’s see an example of how to use the CLI. Let’s assume that we have a similar project to what we had in the previous section:

.
├─ go.mod
├─ main.go
└─ proto
   ├─ test.proto
   └─ v1
      └─ test.proto

Now, at the root of the proto files (the proto directory), run the following command:

$ buf mod init

This should create a buf.yaml file in the proto directory...