Плюсы и минусы протокола MessagePack¶

MessagePack¹ — это бинарный протокол сериализации данных. Строго говоря, он может использоваться не только в связке с SignalR, но и сам по себе. Обладает схоже с JSON структурой, но в отличие от JSON сериализованный таким образом объект не будет “человекочитаемым”. С другой стороны, сериализованные объекты, в силу бинарной природы протокола, будут меньше, следовательно, будут передаваться быстрее.

Включаем MessagePack на сервере¶

MessagePack поставляется в виде отдельного NuGet пакета, поэтому прежде всего его нужно установить:

dotnet add package Microsoft.AspNetCore.SignalR.Protocols.MessagePack

using MessagePack; //Юзинг

.AddMessagePackProtocol(options => {
    options.SerializerOptions = MessagePackSerializerOptions.Standard
        .WithSecurity(MessagePackSecurity.UntrustedData)
        .WithCompression(MessagePackCompression.Lz4Block)
        .WithAllowAssemblyVersionMismatch(true)
        .WithOldSpec()
        .WithOmitAssemblyVersion(true);
});

• SerializerOptions — объект настроек типа MessagePackSerializerOptions;
• WithSecurity — так как нет никакого способа проверить валидность данных до начала десериализации, это может быть возможным вектором атаки. Задавая свойства объекта класса MessagePackSecurity можно тонко настраивать поведение десериализатора с точки зрения безопасности. Также есть два предустановленных объекта — TrustedData для абсолютно доверенных данных и UntrustedData для сомнительных;
• WithCompression — сериализованные данные можно сжать алгоритмом LZ4 для большей компактности. Возможные варианты: None, Lz4Block и Lz4BlockArray. Последний вариант является предпочтительным. Подробнее разница между вариантами освещена в документации;
• WithAllowAssemblyVersionMismatch — можно отключить проверку совпадения версий сборки на клиенте (если версия указана в сообщении) и сервере, или включить, если требуется точное совпадение;
• WithOldSpec — позволяет использовать старые спецификации (?);
• WithOmitAssemblyVersion — отключает указание версии сборки в сообщении.

Включаем MessagePack в JavaScript клиенте¶

На момент написания книги библиотека MessagePack была доступна только при инсталляции через npm:

npm install @microsoft/signalr-protocol-msgpack

<script src="~/lib/signalr/signalr-protocol-msgpack.min.js"></script>

.withHubProtocol(new signalR.protocols.msgpack.MessagePackHubProtocol())

Включаем MessagePack в .NET клиенте¶

добавляем юзинг

using MessagePack

.AddMessagePackProtocol(options => 
{
    options.SerializerOptions = MessagePackSerializerOptions.Standard
        .WithSecurity(MessagePackSecurity.UntrustedData)
        .WithCompression(MessagePackCompression.Lz4Block)
        .WithAllowAssemblyVersionMismatch(true)
        .WithOldSpec()
        .WithOmitAssemblyVersion(true);
})

Включаем MessagePack в Java клиенте¶

Пакеты SignalR MessagePack для Java могут быть найдены в репозитории Maven здесь. Выбираем нужную нам версию пакета и следуем инструкции для используемой нами системы сборки.
После этого добавляем метод withHubProtocol() с указанием объекта протокола MessagePack, вот таким образом:

HubConnection hubConnection = HubConnectionBuilder.create(input)
    .withHubProtocol(new MessagePackHubProtocol())
    .build();

Недостатки протокола MessagePack¶

Первым недостатком протокола будет то, что он недоступен “из коробки”. Для его использования необходимо устанавливать дополнительные пакеты.
Другим недостатком будет то, что этот протокол является регистрозависимым, в отличие от JSON. Это может стать значительной проблемой в случае, когда клиент и сервер написаны на разных языках: в разных языках существуют разные соглашения относительно регистров именования переменных. В .NET это чаще всего PascalCase, а, к примеру, в javaScript это camelCase. Обойти это можно, используя атрибуты для присвоения camelCase-имён свойствам C#-объектов. Подробнее о том, как работает маппинг полей см. в документации³.

Комментарии

Комментарии