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)

What are protoc plugins?

Once again, before diving into the actual code of the plugin, let us try to understand what protoc plugins are and what they do.

As we saw in the section on custom options, protoc plugins and custom options are generally used together. The custom options provide contextual information, and the plugin gets that information and acts on it. This action, more often than not, is a generation of some sort of code. We have already discussed protovalidate and gRPC-Gateway generating some code that can be used in your business logic.

Even though, in this section, we are going to generate code, it is important to understand that protoc plugins can do other things than generate code.

You can also, for example, generate documentation following the OpenAPI specification with the protoc-gen-openapiv2 provided by gRPC-Gateway. Let’s say you have the following schema:

syntax = "proto3";
import "google/api/annotations.proto";
import &quot...