Генерация кода gRPC

С возвращением! На прошлом уроке мы научились определять наши структуры данных и сервисы с помощью Protocol Buffers (Protobuf).

Теперь возникает вопрос: как использовать эти определения в нашем любимом языке программирования? Вот тут-то на помощь и приходит генерация кода!

Это процесс автоматического создания исходного кода на основе схемы, который избавляет вас от написания повторяющегося шаблонного кода.

gRPC в значительной степени опирается на сгенерированный код, который часто называют заглушками (stubs) или прокси (proxies). Эти заглушки выступают в роли связующего звена между логикой вашего приложения и базовыми механизмами взаимодействия gRPC.

• Клиентские заглушки: предоставляют методы, которые дублируют сервис, определенный в вашем файле .proto. Когда вы вызываете метод клиентской заглушки, он упаковывает данные, отправляет их по сети и распаковывает полученный ответ.
• Серверные заглушки: определяют интерфейс, которому должна соответствовать реализация вашего сервера. Они отвечают за получение запросов, передачу их в ваш код и отправку ответов обратно.

Магия, стоящая за созданием этих заглушек, заключается в компиляторе Protobuf, более известном как protoc.

protoc — это инструмент командной строки, который считывает ваши .proto-файлы и генерирует исходный код на различных языках программирования на основе указанных вами плагинов.

Это важнейший компонент любого проекта gRPC, поскольку он обеспечивает строгую типизацию и согласованные интерфейсы взаимодействия между различными сервисами и языками.

Общий синтаксис использования protoc выглядит примерно так:

protoc --<ЯЗЫК>_out=. --grpc_out=. my_service.proto

• --<ЯЗЫК>_out=.: этот флаг указывает protoc генерировать классы сообщений Protobuf для конкретного языка (например, --java_out, --python_out) и определяет, куда их поместить (. означает текущую директорию).
• --grpc_out=.: этот флаг, часто используемый со специальным плагином gRPC, генерирует интерфейс службы gRPC и классы заглушек (stub).
• my_service.proto: путь к вашему файлу определения Protobuf.

Перед тем как генерировать код, необходимо установить protoc. Процесс установки зависит от вашей операционной системы:

• Загрузка бинарных файлов: Вы можете скачать предварительно скомпилированные бинарные файлы с официальной страницы релизов Protobuf на GitHub.
• Менеджеры пакетов: В Linux можно использовать apt-get install protobuf-compiler. В macOS — brew install protobuf.
• Сборка из исходного кода: Продвинутые пользователи могут скомпилировать его из исходного кода.

Убедитесь, что protoc добавлен в переменную PATH вашей системы.

Давайте воспользуемся простым файлом greet.proto, чтобы продемонстрировать генерацию кода. Этот файл определяет сервис Greeter и соответствующие ему сообщения:

syntax = "proto3";

package greeter;

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

Это входные данные для нашего компилятора protoc.

Для генерации Java-кода для нашего файла greet.proto обычно используется следующая команда:

protoc \
  --plugin=protoc-gen-grpc-java=/path/to/grpc-java-plugin \
  --java_out=. \
  --grpc_out=. \
  greet.proto

Здесь флаг --plugin явно указывает protoc, где найти плагин gRPC для Java, который необходим для генерации интерфейсов сервисов gRPC.

После запуска protoc вы обнаружите новые файлы Java в указанном выходном каталоге. Для нашего примера greet.proto вы обычно увидите следующее:

• GreeterGrpc.java: содержит абстрактный сервис GreeterImplBase и классы клиентских заглушек (например, GreeterBlockingStub, GreeterFutureStub).
• Greet.java: класс-контейнер, содержащий сгенерированные классы сообщений Protobuf, такие как HelloRequest и HelloReply, а также их построители (builders) и методы доступа (accessors).

Эти файлы обрабатывают все детали сериализации, десериализации и сетевого взаимодействия.

Важно понимать, что сам по себе protoc генерирует только базовые классы сообщений Protobuf.

Для создания специфичных для gRPC сервисных интерфейсов и заглушек (stubs) используются плагины. Например, для Java вам потребуется плагин protoc-gen-grpc-java.

Для каждого языка, поддерживаемого gRPC (Python, Go, C++, Node.js и т. д.), существует свой специфический плагин, который интегрируется с protoc для создания необходимого кода gRPC.

Какие из следующих утверждений о генерации кода gRPC верны?

Отличная работа! Вы изучили фундаментальный процесс генерации кода gRPC:

• Мы поняли, почему заглушки (stubs) необходимы для взаимодействия по gRPC.
• Мы познакомились с компилятором protoc — инструментом, который выполняет генерацию кода.
• Мы узнали, как плагины расширяют возможности protoc для генерации gRPC-кода на разных языках программирования.
• Мы разобрали пример генерации кода на Java из определения .proto.

Далее мы будем использовать этот сгенерированный код для реализации простого унарного gRPC-сервиса и клиента!