Реклама мешает? Идти Без рекламы Сегодня 

Форматтер Protocol Buffers (Protobuf)

ДанныеРазработчик

РЕКЛАМА · УДАЛЯТЬ?

ВХОД

Автоматический процесс

ВЫХОД

Клиентская сторона

РЕКЛАМА · УДАЛЯТЬ?

Гид

Форматтер Protocol Buffers (Protobuf)

Protocol Buffers — нейтральный к языку и платформе формат сериализации от Google — обеспечивает работу всего, от микросервисов gRPC до API мобильных приложений. Но файлы .proto быстро становятся неупорядоченными, особенно когда над одними и теми же определениями схем работают несколько разработчиков. Несогласованные отступы, сбитые номера полей и небрежное форматирование делают ревью кода болезненным, а diff-ы — нечитаемыми.

Этот форматтер разбирает ваши файлы .proto на стороне клиента и повторно выдает их с чистым, согласованным форматированием в соответствии с соглашениями о стиле protobuf от Google. Данные не покидают ваш браузер.

Как использовать

Вставьте содержимое вашего файла .proto в поле ввода или загрузите файл .proto напрямую. Выберите предпочитаемый отступ (2 или 4 пробела), выберите версию синтаксиса protobuf и опционально включите сортировку полей по номеру тега. Отформатированный вывод появляется мгновенно с подсветкой синтаксиса, готовый к копированию или загрузке.

РЕКЛАМА · УДАЛЯТЬ?

Функции

Поддержка Proto2 и Proto3 – Обрабатывает обе версии синтаксиса с правилами форматирования, соответствующими версии
Настраиваемый отступ – Выбирайте между отступом в 2 или 4 пробела, чтобы соответствовать стилю вашей команды
Сортировка полей – Опционально меняйте порядок полей сообщения по номеру тега для более чистых схем
Проверка синтаксиса – Обнаруживает распространенные ошибки, такие как несоответствие скобок, недопустимые номера полей и отсутствующие объявления синтаксиса, с отчетом об ошибках на уровне строк
Подсветка синтаксиса – Цветовая подсветка вывода для ключевых слов, типов, строк, комментариев и номеров полей
Обработка на стороне клиента – Определения ваших схем никогда не покидают ваш браузер
Скачать вывод – Экспортируйте отформатированный результат в виде файла .proto

Когда использовать этот инструмент

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

 Часто задаваемые вопросы

В чем разница между синтаксисом proto2 и proto3?

Proto3 упростил язык protobuf, удалив обязательные и опциональные метки полей (все поля по умолчанию опциональны), отказавшись от деклараций значений по умолчанию и удалив расширения в пользу типа Any. Proto3 также добавил поддержку сопоставления JSON и карт как первоклассных функций. Большинство новых проектов должны использовать proto3, если им не нужны специфичные для proto2 функции, такие как обязательные поля или пользовательские значения по умолчанию.
Почему важны номера полей protobuf?

Номера полей в Protocol Buffers используются в двоичном формате передачи для идентификации полей. После того как файл .proto начал использоваться, номера полей никогда не следует изменять или повторно использовать — это нарушает обратную совместимость с существующими сериализованными данными. Номера 1–15 используют один байт при кодировании, поэтому часто используемые поля должны получать низкие номера для эффективности. Диапазон 19000–19999 зарезервирован реализацией protobuf.
Каковы преимущества использования Protocol Buffers по сравнению с JSON?

Protocol Buffers создают значительно меньшие пакеты данных (в 3–10 раз меньше, чем JSON) и быстрее сериализуются и десериализуются, поскольку используют двоичный формат вместо текста. Они также обеспечивают строгую схему, которая выявляет ошибки типов данных на этапе компиляции, а не во время выполнения. Однако JSON остается лучше для удобочитаемых API, браузерных приложений и ситуаций, где гибкость схемы важнее производительности.
Как gRPC использует Protocol Buffers?

gRPC использует Protocol Buffers как язык определения интерфейса (IDL), так и в качестве основного формата сериализации сообщений. Вы определяете методы служб и типы сообщений в файлах .proto, затем используете компилятор protoc для генерации клиентского и серверного кода на вашем целевом языке. gRPC поддерживает четыре шаблона связи: унитарный (один запрос-ответ), потоковая передача на стороне сервера, потоковая передача на стороне клиента и двунаправленная потоковая передача.
Что такое обратная совместимость в схемах protobuf?

Обратная совместимость означает, что код, использующий более новую версию схемы .proto, по-прежнему может читать данные, сериализованные с помощью более старой версии, и наоборот. Чтобы поддерживать это, вы никогда не должны изменять существующие номера полей, никогда не повторно использовать удаленные номера полей (вместо этого используйте ключевое слово reserved) и добавлять только новые опциональные поля. Удаление обязательных полей в proto2 или изменение типов полей нарушает совместимость и может привести к повреждению данных или сбоям при разборе.