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)

Updating the AddressBook

As we are going to work with the application we wrote in Chapter 7, let’s copy it over to the chapter9 directory:

$ cp -R ../chapter7/cmd/addressbook cmd
$ cp -R ../chapter7/pkg/addressbook pkg
$ cp ../chapter7/main.go .
$ cp ../chapter7/proto/addressbook.proto proto

Now, because we were using a Go module name including chapter7, we will need to replace all the occurrences by chapter9. On Linux/Mac, we can run the following command:

$ find . -type f -exec sh -c "sed -i '' -e 's/chapter7/chapter9/g' {}" ";"

And on Windows (Powershell), we can run the following:

$ Get-ChildItem -Recurse -File -Include *.proto,*.go,go.mod | ForEach { (Get-Content $_ | ForEach  { $_ -replace ‘chapter7’, ‘chapter9’ }) | Set-Content $_ }

We are now all set up to start.

The first step is to update our proto file to use our custom option. To do that, we will import our validate.proto...