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)

Maps

Finally, we can talk about how maps are encoded in Protobuf. In Chapter 3 on Protobuf text format, I briefly mentioned that a map is a list of objects that contains the key and value fields. In this section, we are going to dive deeper into this and see how maps are encoded.

First, let’s not take for granted that a map is a list of objects. Let’s investigate that. We can define a message containing a map field (map/encoding.proto):

syntax = "proto3";
message Encoding {
  map<string, int32> m = 1;
}

Now, to see how this translates internally, we can turn that proto file into a descriptor file. Protoc has a flag called --descriptor_set_out for doing that. Let’s create a descriptor file called encoding.desc:

$ protoc --descriptor_set_out=encoding.desc encoding.proto

This file contains a binary of FileDescriptorSet, which is a message defined in the descriptor.proto file provided with protoc. Now, we can decode this descriptor...