在ASP.NET 5中使用SignalR

（此文章同时发表在本人微信公众号“dotNET每日精华文章”，欢迎右边二维码来关注。)

题记：SignalR作为ASP.NET中进行Web实时双向通信的组件，在ASP.NET 5中也得到了同步发展。不过，用法和之前还是在细节上有所不同，而资料又相对稀少。本文就是一个简单的入门向导。

通过SignalR，开发人员可以在ASP.NET开发的Web应用中实现服务器和客户端的双向实时通信。服务器可以即时推送内容给在线的客户端。SignalR首选Web Sockets作为底层实现，针对非现代浏览器也可以回退到其他兼容技术。它的特性很丰富，支持链接管理、分组连接和授权控制等。

在ASP.NET 5时代，SignalR也同步升级到SignalR 3.x，不过Javascript的客户端库还是2.x版本。同时，用法和之前在ASP.NET 4.x时代（比如在ASP.NET MVC 5中）还是有点细微的区别，所以导致参考现有文档可能会遇到错误。那么如何在ASP.NET 5的Web应用中使用SignalR 3呢，下面就简单讲解一下步骤：

1，不用说，一开始就是新建一个ASP.NET 5的Web应用程序项目

2，新建成功后。在Solution Explorer中打开“project.json”文件，在“dependencies”中添加"Microsoft.AspNet.SignalR.Server": "3.0.0-rc1-final"，以便引用SignalR的服务端函数库

3，展开“Dependencies”，右击“Bower”节点，选择“Manage Bower Packages…”选项，在Bower包安装界面，切换到“Browse”，搜索“SignalR”并安装。需要注意的是，本文书写的时候只能安装signalr 2.2.0的js函数库，但是不影响使用。

4，创建一个文件夹（比如名为”Hubs“）来包含所有Hub类，建议规范如此，并非强制要求。在Hubs文件夹中添加一个名为ChatHub的类，并继承Microsoft.AspNet.SignalR.Hub。

5，理论上，如果你只打算从服务端往客户端推送消息的话，Hub类里面可以不写任何东西。不过为了实现一个简单的聊天功能，我们还是写点东西，写了两个方法Send和Join供客户端调用。代码如下：

public class ChatHub : Hub
{
    public void Send(string message)
    {
        var name = Context.Request.HttpContext.Session.GetString("name");
        Clients.All.addNewMessageToPage(name, message);
    }

    public void Join(string name)
    {
        Context.Request.HttpContext.Session.SetString("name", name);
    }
}

6，然后在Startup.cs文件中，的”ConfigureServices“中添加2行代码services.AddSignalR();services.AddTransient<ChatHub>();。（第二行代码的目的是后续在Hub外部调用客户端方法的时候，可以方便的进行依赖注入。）接着在”Configure“中添加1行代码app.UseSignalR();

7，在视图文件中实现加入、发送消息、显示消息的界面，代码基本参考了（http://www.asp.net/signalr/overview/getting-started/tutorial-getting-started-with-signalr-and-mvc）中的。我添加了加入聊天的功能。另外，引用自动生成的hub代理js文件的地址由”signalr/hubs“变为了”signalr/js“。这个地址，可以在Startup中配置，不过默认值是这个且和之前不同。

8，要从Hub中发送消息到客户端，需要在服务端的代码中通过依赖注入引用IHubContext<ChatHub>，并直接调用dynamic方法。代码如下：

private readonly IHubContext<ChatHub> _hub;

public HomeController(IHubContext<ChatHub> hub)
{
    _hub = hub;
}

public IActionResult SendMessageToClients(string message)
{
    _hub.Clients.All.sendMessageFromServer(message);
    return Content("<h1>OK</h1>");
}

完整的项目代码共享地址在：https://zyg.blob.core.windows.net/share/ASP.NET%205%20SignalR.zip