Подробный воркшоп по gRPC

Программа воркшопа

Подробно разберём

1. 01

   Разбираем, как устроен Protobuf

   • Погружаемся в проект: настраиваем форматеры и линтеры
   • Чем protobuf лучше JSON и почему он меньше весит в сети
   • Типы, enum, repeated, вложенные сообщения
   • Как не сломать контракт: номера полей, reserved, версии API
   • Как отличить пустую строку от «ничего не передали»

   РезультатОписали контракт сервиса в proto-файле и разобрались, как менять его, не ломая клиентов

   spaceship.proto

   message Spaceship {  string uuid = 1;  SpaceshipInfo info = 2;  reserved 3;  // место под будущее поле  google.protobuf.Timestamp created_at = 4;  google.protobuf.Timestamp updated_at = 5;}

2. 02

   Выясняем, чем gRPC быстрее HTTP

   • Что не так с HTTP/1.1: дорогие TCP-соединения, head-of-line blocking, тяжёлые заголовки
   • Что поменял HTTP/2 и почему gRPC работает на нём
   • Как описывать ручки в proto-файле

   РезультатПонимаешь, что gRPC берёт от HTTP/2 и почему он быстрее

   соединения

   HTTP/1.1

   до 6 TCP-соединений, запросы ждут друг друга

   HTTP/2

   одно соединение, внутри много стримов
3. 03

   Генерируем код: protoc, buf, EasyP

   • Сравниваем protoc, buf и российский EasyP: плюсы и минусы каждого
   • Генерируем код всеми тремя и смотрим, чем отличается результат
   • Линтер для proto-файлов и проверка ломающих изменений
   • Где buf упирается в VPN и как это обойти

   РезультатНастроили одну команду, которая проверяет proto-файл линтером и генерирует из него готовый Go-код для сервера и клиента

   terminal

   $ buf lint && buf generate pkg/proto/spaceship/v1/  spaceship.pb.go  spaceship_grpc.pb.go  spaceship.pb.validate.go  spaceship.pb.gw.go

4. 04

   Поднимаем свой gRPC-сервер

   • Пишем CRUD-сервис на Go
   • Коды ошибок gRPC: not found, invalid argument и другие
   • Reflection и graceful shutdown
   • Продовые вопросы: отдавать ли ошибку при удалении несуществующей записи и что такое soft delete

   РезультатПодняли собственный сервис и разобрались в кодах ошибок gRPC, reflection и аккуратной остановке сервера без потери запросов

   cmd/grpc_server/main.go

   ship, ok := s.spaceships[req.GetUuid()]if !ok {  return nil, status.Errorf(codes.NotFound,    "spaceship %s not found", req.GetUuid())} server.GracefulStop()

5. 05

   Пишем клиента и тестируем ручки

   • Пишем свой gRPC-клиент на Go
   • Дёргаем ручки через gRPCurl или Postman
   • Разбираем ошибку сервера на стороне клиента

   РезультатНаписали Go-клиент, который вызывает все ручки сервиса, и научились проверять любую ручку из терминала

   terminal

   $ grpcurl -plaintext \    -d '{"uuid": "404"}' localhost:50051 \    spaceship.v1.SpaceshipService/Get ERROR:  Code: NotFound  Message: spaceship 404 not found

6. 06

   Подключаем валидацию и интерцепторы

   • Правила валидации прямо в proto: длина строки, email, IP, regexp
   • Интерцепторы: middleware из мира gRPC
   • Выносим валидацию в интерцептор, замеряем время ответа, собираем цепочку

   РезультатПроверки входных данных срабатывают сами на каждую ручку, а время ответа каждой ручки пишется в лог

   cmd/grpc_server/main.go

   server := grpc.NewServer(  grpc.ChainUnaryInterceptor(    interceptor.Validation(),    interceptor.ResponseTime(),  ),) // Create 10µs · Get 1µs

7. 07

   Добавляем REST и Swagger через gRPC-Gateway

   • Фронту нужен REST, а у тебя gRPC: поднимаем оба из одного proto-файла
   • Генерируем OpenAPI-спеку
   • Поднимаем Swagger UI и вызываем ручки прямо из браузера

   РезультатТот же сервис отвечает фронту по REST, а в браузере открывается Swagger, где можно вызвать любую ручку

   localhost · Swagger UI

   POST/api/v1/spaceship

   GET/api/v1/spaceship/{uuid}

   PATCH/api/v1/spaceship/{uuid}

   DELETE/api/v1/spaceship/{uuid}
8. 08

   Настраиваем стриминг событий

   • Три вида стримов и когда какой нужен
   • Серверный стрим: подписка на события в реальном времени
   • Клиент, который слушает стрим

   РезультатКлиент подписывается на изменения и в реальном времени получает события: корабль создан, обновлён, удалён

   grpc_stream_client

   подписка активна, ждём события…← CREATED  Millennium Falcon← UPDATED  Millennium Falcon · price← DELETED  Millennium Falconстрим закрыт клиентом

$ git log --oneline● add streaming● add swagger ui● add grpc gateway● add interceptors  …● add proto file● init module