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)

Conventions used

There are a number of text conventions used throughout this book.

Code in text: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: “This should create a buf.yaml file in the proto directory.”

A block of code is set as follows:

syntax = "proto3";
message Encoding {
  int32 i32 = 1;
}

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

type Person_PhoneNumber_Type int32
const (
  Person_PhoneNumber_TYPE_UNSPECIFIED  Person_PhoneNumber_Type = 0
  Person_PhoneNumber_TYPE_MOBILE  Person_PhoneNumber_Type = 1
  Person_PhoneNumber_TYPE_HOME  Person_PhoneNumber_Type = 2
  Person_PhoneNumber_TYPE_WORK  Person_PhoneNumber_Type = 3
)

Any command-line input or output is written as follows:

$ cat int32.txtpb | protoc --encode=Encoding encoding.proto | hexdump –C

Bold: Indicates a new term, an important word, or words that you see onscreen. For instance, words in menus or dialog boxes appear in bold. Here is an example: “The structure of the data is called the data format.”

Tips or important notes

Appear like this.