.net core 3.0 Signalr - 03 使用MessagePack压缩传输内容

## MessagePack基础介绍
Signalr默认使用的是json形式传递数据,但是signalr提供了灵活的扩展,支持MessagePack形式序列化数据,以增加性能降低网络传输的效果,极大的提高响应速度。

先看一个MessagePack自定义序列化的例子,以一个自定义的实体对象为例,可以使用MessagepackObject标记为序列化的对象,同时定义使用属性名作为key(区分大小写),同时可以定义忽略某个属性等、以及自定义key等
``` C#
[MessagePackObject(keyAsPropertyName: true)]
public class OffLineData
{
///

/// 用户Id
///

public string UserId { set; get; }
///

/// 连接Id
///

public string ConnectionId { set; get; }
///

/// 是否该用户的最后一个连接
///

public bool IsLast { set; get; }
[IgnoreMember]
public string Test { set;get;}
}

// 比如对象,new OffLineData(){UserId="1000",ConnectionId="AZDEFASDFASDF",IsLast:true}通过MessagePack序列化后应该会是{UserId:"1000",ConnectionId:"AZDEFASDFASDF",IsLast:true},这个跟常用的json基本相同
```

同时MessagePack还可以定义序列化成数组形式,代码如下
``` C#
[MessagePackObject]
public class OffLineData
{
///

/// 用户Id
///

[Key(0)]
public string UserId { set; get; }
///

/// 连接Id
///

[Key(0)]
public string ConnectionId { set; get; }
///

/// 是否该用户的最后一个连接
///

[Key(0)]
public bool IsLast { set; get; }
}

// 比如对象,new OffLineData(){UserId="1000",ConnectionId="AZDEFASDFASDF",IsLast:true}通过MessagePack序列化后应该会是["10000","AZDEFASDFASDF",true]
```
更多MessagePack的内容可以自行结尾的文档,此处不再过多介绍.

## 为Signalr添加MessagePack支持
- 引入需要的Nuget包
Microsoft.AspNetCore.SignalR.Protocols.MessagePack
- 修改之前的ConfigureServices
``` C#
// 添加Signalr
services.AddSignalR(config =>
{
if (_webEnv.IsDevelopment())
{
config.EnableDetailedErrors = true;
}
})
// 支持MessagePack
.AddMessagePackProtocol();
```
- 前端引入messagepack解析库
由于MessagePack传输是以二进制形式进行传输,降低了带宽,但是同时也增加到了代码的复杂度,原本直接获取数据就可以用的,现在需要先将二进制数据转换成正常数据,好在官方提供了对应的js库*msgpack5*、*signalr-protocol-msgpack*
可以通过vs的包管理工具或者npm安装,然后拷贝需要的文件到项目的lib文件夹,比如我的结构是
``` bash
signalr-protocol-msgpack
|-msgpack5.js
|-msgpack5.min.js
|-signalr-protocol-msgpack.js
|-signalr-protocol-msgpack.min.js
```
前端页面引入这两个js(注意顺序:signalr、msgpack5、signalr-protocol-msgpack)

- 修改js连接对象,支持上MessagePack
``` js
new signalR.HubConnectionBuilder()
.configureLogging(signalR.LogLevel.Error) // 前端控制台的日志级别,根据需要配置
.withUrl(‘http://localhost:50001/notify-hub‘) // 连接地址,这个地址是signalr项目的地址
.withHubProtocol(new signalR.protocols.msgpack.MessagePackHubProtocol()) // 使用Messagepack来解析推送的数据
.withAutomaticReconnect([0, 2000, 5000, 10000, 20000]) // 配置重连的时间
.build();

// 重连的时候触发
connection.onreconnecting(function (info) {
console.info(‘----------------------------------signalr-- onreconnecting‘, info);
});

//连接关闭的回调
connection.onclose(function (err) {
console.info(‘--------------------------------signalr-- onclose‘, err);
});

connection.start().then(function (data) {
console.log(‘已成功连接到signalr服务器‘)
}).catch(function (error) {
console.error(error.toString());
});

```

## 尚未解决问题
发现通过json.net序列化得到的对象,直接传递给MessagePack序列化会报错,没找着解决方法,直接改成字符串传递,然后在前端解析了,有遇到过的大佬欢迎指点下

至此,MessagePack介绍算结束了,更多内容请通过快速导航查看下一篇

## 快速导航

| 标题 | 内容
| :--- | :---
| 索引 | [.net core 3.0 Signalr - 实现一个业务推送系统](https://blogs.xxgtalk.cn/2019/09/20/dotnetcore/signalr/00-introduct/)
| 上一篇 | [.net core 3.0 Signalr - 02 使用强类型的Hub](https://blogs.xxgtalk.cn/2019/09/22/dotnetcore/signalr/02-type-hub/)
| 下一篇 | [.net core 3.0 Signalr - 04 使用Redis做底板来支持横向扩展](/2019/10/01/dotnetcore/signalr/04-redis/)
| 源码地址 | [源码](https://github.com/xiexingen/CTS.Signalr)
| 官方文档 | [官方文档](https://docs.microsoft.com/zh-CN/aspnet/core/?view=aspnetcore-3.0)
| MessagePack-CSharp | [MessagePack-CSharp](https://github.com/neuecc/MessagePack-CSharp)
| MessagePack | [MessagePack](https://msgpack.org/index.html)

![二维码](https://img2018.cnblogs.com/blog/394514/201910/394514-20191005213613187-1330258161.gif)

原文地址:https://www.cnblogs.com/xiexingen/p/11625859.html

时间: 2024-10-08 14:35:52

.net core 3.0 Signalr - 03 使用MessagePack压缩传输内容的相关文章

.net core 3.0 Signalr - 04 使用Redis做底板来支持横向扩展

在实际的系统中,可能需要多台机器部署;然而,Signalr的连接信息是跟站点走的,举个例子 推送系统部署了A.B两个服务器,张三访问A服务器,李四访问B服务器,当张三通过A服务器向李四推送的时候,A服务器上是找不到李四的连接信息的,自然也就推送不过了,这个时候就需要有一个统一协调的玩意,signalr支持多种,Azure.Redis等,本节以Redis作为底板,介绍如何在Signalr中使用Redis作为底板来支持横向扩展. ## 引入Redis - 先引入NuGet包 Microsoft.As

.net core 3.0 Signalr - 实现一个业务推送系统

## 介绍 ASP.NET Core SignalR 是一个开源代码库,它简化了向应用添加实时 Web 功能的过程. 实时 Web 功能使服务器端代码能够即时将内容推送到客户端. SignalR 的适用对象: - 需要来自服务器的高频率更新的应用. 例如:游戏.社交网络.投票.拍卖.地图和 GPS 应用. - 仪表板和监视应用. 示例包括公司仪表板.销售状态即时更新或行程警示. - 协作应用. 协作应用的示例包括白板应用和团队会议软件. - 需要通知的应用. 社交网络.电子邮件.聊天.游戏.行程

.net core 3.0 Signalr - 02 使用强类型的Hub

## 强类型的优缺点 - 优点 强类型的Hub可以避免魔法函数名,相比弱类型更容易维护和发现问题,直接上代码 - 缺点 特么的得多些好几行代码 ## 代码 ### 接口定义 ``` C# /// /// 服务端接口 /// public interface IServerNotifyHub { } /// /// 客户端使用的接口 /// public interface IClientNotifyHub { // 这里我们定义一个统一的客户端通知方法 Task OnNotify(object

.net core 3.0 Signalr - 05 使用jwt将用户跟signalr关联

Signalr是以Group.Connect为核心来进行推送,比如,给某个组.某个连接来推送,但实际场景中,核心应该是某个组.某个人:然而一个人可以对应多个连接(浏览器多个tab页):本节就来介绍下自行管理人.组.连接这些关系 由于signalr连接的时候不那么方便附带header和cookie(因为推送独立成一个子系统了),实际实现中采用以url query的形式附带上token,然后服务器端自定义解析token得到用户信息: ## 服务器端实现 - ConfigureServices中添加服

.net core 3.0 Signalr - 07 业务实现-服务端 自定义管理组、用户、连接

## Hub的管理 - 重写OnConnectedAsync 从连接信息中获取UserId.Groups,ConnectId,并实现这三者的关系,存放于redis中 [代码请查看](https://github.com/xiexingen/CTS.Signalr/blob/master/CTS.Signalr.Server/Hubs/NotifyHub.cs) ``` C# using CTS.Signalr.Server.Cores; using CTS.Signalr.Server.Dtos

.net core 3.0 Signalr - 01 基础篇

因为将signalr作为单独的站点,此处需要建立两个项目,一个专门用于signalr作为推送项目,一个客户端(实际的业务项目) ## 基础知识速览 ### Clients对象属性 | 属性 | 描述 | :--- | :--- | All | 在所有连接的客户端上调用方法 | Caller | 在调用集线器方法的客户端上调用方法 | Others | 除当前连接外的所有连接 ### Clients对象方法 | 方法 | 描述 | :--- | :--- | AllExcept | 在所有连接的客

.net core 3.0 Signalr - 06 业务实现-业务分析

## 业务需求 1. 人-项目关系 一个人可以属于多个项目,一个项目可以有多个人加入,通知的时候,可以通知项目内的所有人,也可以通知部分人或者某个责任人. 2. 登录互斥 同一个人不允许登录两次(不同浏览器或者不同电脑登),后面登录的会将前面登录的人挤下线. 3. 聊天 可以私聊.也可以创建群聊.上线通知(多个连接的情况) 4. 文件下载 用户在界面上选择了多个文件,然后选择批量打包下载,后端后台线程进行压缩.压缩完成后通过signalr通知该用户(的某个连接,比如当前用户开了多个tab页,应该

.net core 3.0 Signalr - 09 待改进&交流

## 个人心得 写博客真的比写代码累,膜拜那些坚持写博客的大佬! 有时候零散的片段比较多,没写之前感觉有千千万万要写的东西,实际写的时候发现, 好像这个没啥说的,然后就帖了个图,或者一笔带过了 ## 待改进&交流 - 使用消息队列替换目前的api调用形式,同时消息队列支持定义推送优先级 - 使用polly来重试失败的调用 - 将连接中传递的userId改成token - 多个客户端同时关闭,IsLast不准确 - 服务器端需要有定时任务去清除redis中的无效数据(看造化) 更多内容请通过快速导

.net core 3.0 Signalr - 08 业务实现-客户端demo

由于signalr作为一个单独的推送系统,跟业务系统是分离开的,所以此处模拟一个业务系统,新建一个.net core app项目 ## 模拟实现一个登录功能 我们的登录很简单,当进入系统,如果检测到用户未登录则跳转到登录页面,用户只需要输入用户名点击登录即算登录成功 - 配置ConfigServices方法 [查看代码](https://github.com/xiexingen/CTS.Signalr/blob/master/CTS.Signalr.Client/Startup.cs#L41-L