Использование Protobuf

Данное решение было предложено главным архитектором Egret Ван Цзэ. Адрес открытого исходного кода: https://github.com/WanderWang/protobuf-egret.

В соответствии с принципом удобства и единообразного управления, в способ использования были внесены незначительные изменения.

Требования к формату .proto файла

Каждый протокол в файле proto должен принадлежать одному пакету (package), иначе при генерации .d.ts файлов возникнут ошибки, которые не позволят TypeScript файлам правильно найти эти классы.

Соглашения о структуре каталогов

Protobuf по-прежнему использует подход сторонних библиотек для внедрения, поэтому его следует размещать в каталоге code/thirdparty/. В каталоге protobuf есть три подкаталога: bundles, library и protofile.

• library — каталог библиотеки protobuf, где хранятся исходный код protobuf и файлы .d.ts.
• protofile — каталог, предназначенный для хранения файлов .proto. Файлы в этом каталоге являются промежуточными и не используются непосредственно в проекте.
• bundles — целевой файл после сборки. Это файл, который фактически используется в проекте, и все файлы в нём автоматически генерируются и не требуют изменений.

Способ использования

1. Установите зависимости среды:

npm install protobufjs@6.8.4 -g npm install @egret/protobuf -g

2. Сгенерируйте файл .proto и поместите его в каталог protofile.
3. Откройте командную строку, перейдите в каталог code/thirdparty/ и выполните команду pb-egret generate. После выполнения в каталоге bundles будут созданы целевые файлы.
4. Очистите и скомпилируйте проект в Egret Wing. Целевые файлы будут автоматически созданы в каталоге code/client/modules/protobuf-bundles.
5. Используйте интерфейс и структуру данных из файла .d.ts в каталоге code/client/modules/protobuf-bundles для работы с protobuf.