SignalR使用笔记

最近项目要求添加一个给用户发送消息的功能,就决定使用SignalR。翻到了以前学习SignalR的学习笔记,基本是官方文档的简版整理,便于快速阅览和实现。

1. nuget添加signalr引用:

a. install-package Microsoft.AspNet.SignalR

b. silverlight安装时startup中找不到IAppBuilder接口: Update-Package Owin -Reinstall

2. 新建hub集线器类

SignalR使用笔记_第1张图片

a. 添加调用客户端方法,调用的js方法在运行时解析,signalr将方法名称和参数值发送到客户端。如果客户端有与该名称匹配的方法,则调用该方法,并把参数值传递给该方法。如果没有找到匹配的方法,则不会报错。方法名称匹配不区分大小写。

SignalR使用笔记_第2张图片
i. js使用驼峰命名方式:第一个字母小写,调用服务端方法时会自动转换成c#命名方式(第一个字母大写)。指定集线器名称时,应该与客户端js调用方法名称一致。

1)

2)

b. 可以定义多个集线器。与在单个类中定义所有集线器功能相比,多个集线器没有性能差异。

c. 强类型集线器

i. SignalR使用笔记_第3张图片

d. 客户端调用服务端方法与调用本地js方法相同,可以获取复杂类型的json格式返回值。

e. 同步/异步方法

i. SignalR使用笔记_第4张图片
ii. SignalR使用笔记_第5张图片
iii. js:SignalR使用笔记_第6张图片

f. 异步调用客户端方法时,不会等待客户端方法执行完成,会继续执行下面的代码:

i. SignalR使用笔记_第7张图片

g. 重载:如果要定义方法的重载,每个重载中的参数数必须不同。如果您通过指定不同的参数类型来区分重载,则Hub类将编译,但是当客户端尝试调用其中一个重载时,SignalR服务将在运行时抛出异常。

h. 从集线器方法调用报告进度(SignalR 2.1版本)。要实现进度报告,IProgress 请为客户端可以访问的集线器方法定义一个参数:

i. SignalR使用笔记_第8张图片

i. 调用客户端方法:

i. SignalR使用笔记_第9张图片
ii. SignalR使用笔记_第10张图片
iii. 不能从客户端方法中获取返回值,以下代码不起作用:

1)

iv. 字符串变量作为方法名称

1) SignalR使用笔记_第11张图片

j. 获取连接的客户端:

i. 所有连接的客户端

1)

ii. 只有主叫客户端。

1)

iii. 所有客户端,除了主叫客户端。

1)

iv. 由连接ID标识的特定客户端。

1)

v. 所有连接的客户端,除了指定的客户端,由连接ID标识。

1)

vi. 指定组中的所有连接的客户端。

1)

vii. 指定组中的所有连接的客户端,除了指定的客户端,由连接ID标识。

1)

viii. 指定组中的所有连接的客户端,除了主叫客户端。

1)

ix. 由userId标识的特定用户。

1)

2) 默认情况下,这是IPrincipal.Identity.Name,但是可以通过向全局主机注册IUserIdProvider的实现来更改。

x. 连接ID列表中的所有客户端和组。

1)

xi. 组列表。

1)

xii. 按用户连接id。

1)

xiii. 用户名列表(在SignalR 2.1中引入)。

1)

k. 获取有关客户端的信息

i. 主叫客户端的连接ID。连接ID是由SignalR分配的GUID(您不能在自己的代码中指定值)。每个连接都有一个连接ID,如果应用程序中有多个Hub,则所有Hub都使用相同的连接ID。

1)

ii. HTTP标头数据。

1)

iii. 查询字符串数据。

1)

iv. Cookies

1)

v. 用户信息

vi. 请求的HttpContext对象

1)

3. 创建owin启动类

a. SignalR使用笔记_第12张图片

b. 添加路由,如果要将SignalR功能添加到ASP.NET MVC应用程序,请确保在其他路由之前添加SignalR路由。

i. SignalR使用笔记_第13张图片
ii. 指定URL的服务器代码。默认情况下,客户端用于连接到Hub的路由URL为“/ signalr”,该URL用于自动生成的JavaScript文件。

1)

2) SignalR使用笔记_第14张图片

iii. 指定URL的JavaScript客户端代码(使用生成的代理)

1)

iv. 指定URL的JavaScript客户端代码(不带生成的代理)

1)

v. 指定URL的.NET客户端代码

1)

c. 如何自定义Hubs管道。SignalR使您可以将自己的代码注入Hub管道。以下示例显示了一个自定义集线器管道模块,用于记录从客户端接收的每个传入方法调用和在客户机上调用的传出方法调用:

i. SignalR使用笔记_第15张图片
ii. 在Startup.cs文件中将模块注册到Hub管道中运行

1)

4. 添加html页面

a. 代码:

i. SignalR使用笔记_第16张图片
ii. SignalR使用笔记_第17张图片

5. 启用日志记录,在启动之前加上$.connection.hub.logging = true;

a.

你可能感兴趣的:(SignalR使用笔记)