在ASP.NET Core下使用SignalR技术

时间 2019-11-11

标签 asp.net asp core 使用 signalr 技术栏目 ASP 繁體版

原文原文链接

1、前言

　　上次咱们讲到过如何在ASP.NET Core中使用WebSocket,没有阅读过的朋友请参考 WebSocket in ASP.NET Core 文章。此次的主角是SignalR它为咱们提供了简化操做WebSocket的框架。javascript

　　ASP .NET SignalR 是一个ASP.NET 下的类库，能够在ASP.NET 的Web项目中实现实时通讯。什么是实时通讯的Web呢？就是让客户端（Web页面）和服务器端能够互相通知消息及调用方法，固然这是实时操做的。 WebSockets是HTML5提供的新的API，能够在Web网页与服务器端间创建Socket链接，当WebSockets可用时（即浏览器支持Html5）SignalR使用WebSockets，当不支持时SignalR将使用其它技术来保证达到相同效果。 SignalR固然也提供了很是简单易用的高阶API，使服务器端能够单个或批量调用客户端上的JavaScript函数，而且很是方便地进行链接管理，例如客户端链接到服务器端，或断开链接，客户端分组，以及客户端受权，使用SignalR都很是容易实现。

2、SignalR目前状况

　　咱们知道在ASP.NET Core 1.0.x 版本中并无包含SignalR，可是SignalR技术计划集成在ASP.NET Core 1.2版本中，而且它的开发团队还要使用TypeScript对它的javascript客户端进行重写，服务端方面也会贴近ASP.NET Core的开发方式，好比会集成到ASP.NET Core依赖注入框架中。

　　目前的状况就是在1.0中没法使用SignalR技术，本文实现的Demo都是在1.1下进行的。

3、集成SignalR

　　固然ASP.NET Core 1.2离正式发布还有一段时间，目前想集成SignalR都不是现成的方案，咱们要经过手动的方式集成SignalR。css

　　要在ASP.NET Core中使用SignalR，要先引用Microsoft.AspNetCore.SignalR.Server 、 Microsoft.AspNetCore.WebSockets 的NuGet Package包。html

　　固然上面也说过目前没有ASP.NET Core没有集成SignalR，因此NUGET上也找不到SignalR的程序包，想添加引用咱们就得去MyGet上去找找。java

　　1.添加NuGet源

　　在程序根目录新建一个命为NuGet.Config的文件内容以下：jquery

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <clear/>
            <add key="aspnetcidev" value="https://dotnet.myget.org/F/aspnetcore-ci-dev/api/v3/index.json"/>
            <add key="api.nuget.org" value="https://api.nuget.org/v3/index.json"/>
    </packageSources>
</configuration>

　　固然咱们也能够经过在Visual Studio中设置 NuGet Packages的源，来引用这个程序集。git

　　2.在project.json添加引用

"Microsoft.AspNetCore.SignalR.Server": "0.2.0-*",
"Microsoft.AspNetCore.WebSockets": "1.0.0-*"

　　能够注意到SignalR的版本是0.2.0的alpha版本，因此后续版本可能变化也会比较大！据说是好重写的。
github

　　值得注意的是，SignalR目前只能在ASP.NET Core 1.1及以上版本上使用，在这个文章中我使用的.NET Core SDK版本为 1.0.0-preview2-003131 ，因此引用有问题的同窗能够尝试把CoreApp版本改成1.1，全部AspNetCore的程序集也都改变为1.1的版本。ajax

　　3.添加配置代码

　　咱们须要在Startup类中的 ConfigureServices方法中添加以下代码：json

public void ConfigureServices(IServiceCollection services)
{
     services.AddSignalR(options => 
     {
         options.Hubs.EnableDetailedErrors = true;
      });
}

　　在Startup类中的Configure方法中添加以下代码：api

app.UseWebSockets();
app.UseSignalR();

　　4.添加一个HUB类

　　这里咱们只实现一个小Demo，一个简单的聊天室，多我的进入能够看到各自发送的信息：

public class ChatHub : Hub
{
        public static List<string> ConnectedUsers;

        public void Send(string originatorUser, string message)
        {
            Clients.All.messageReceived(originatorUser, message);
        }

        public void Connect(string newUser)
        {
            if (ConnectedUsers == null)
                ConnectedUsers = new List<string>();

            ConnectedUsers.Add(newUser);
            Clients.Caller.getConnectedUsers(ConnectedUsers);
            Clients.Others.newUserAdded(newUser);
        }
}

　　5.客户端支持

　　在wwwroot目录下建立一个名为chat.html的Html静态文件，内容以下：

<!DOCTYPE html>
<html>
<head>
    <title>Awesome Chat Application</title>
    <meta charset="utf-8" />
</head>
<body>
    <style type="text/css">
        .userListDiv{ float: right; }
    </style>
    <ul id="messages"></ul>
    <input type="text" id="messageBox" />
    <input type="button" id="sendMessage" value="Send Message!" />
    <div class="userListDiv">
        <ul id="userList"> </ul>
    </div>

    <script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-3.1.0.min.js"></script>
    <script src="http://ajax.aspnetcdn.com/ajax/signalr/jquery.signalr-2.2.1.min.js"></script>
    <script src="signalr/hubs"></script>
    <script src="chat.js"></script>
</body>
</html>

　　同目录下创建一个chat.js添加要实现功能的脚本：

var userName = prompt("Enter your name: ");
var chat = $.connection.chatHub;
chat.client.messageReceived = function (originatorUser, message) {
    $("#messages").append('<li><strong>' + originatorUser + '</strong>: ' + message);
};
chat.client.getConnectedUsers = function (userList) {
    for (var i = 0; i < userList.length; i++)
        addUser(userList[i]);
};
chat.client.newUserAdded = function (newUser) {
    addUser(newUser);
}
$("#messageBox").focus();
$("#sendMessage").click(function () {
    chat.server.send(userName, $("#messageBox").val());
    $("#messageBox").val("");
    $("#messageBox").focus();
});
$("#messageBox").keyup(function (event) {
    if (event.keyCode == 13)
        $("#sendMessage").click();
});
function addUser(user){
    $("#userList").append('<li>' + user + '</li>');
}
$.connection.hub.logging = true;
$.connection.hub.start().done(function () {
    chat.server.connect(userName);
});

　　最后咱们来运行它吧：

4、最后

　　附上一个可用的Demo：https://github.com/maxzhang1985/AspNetCore.SignalRDemo

　　GitHub：https://github.com/maxzhang1985/YOYOFx 若是觉还能够请Star下，欢迎一块儿交流。

　　.NET Core 开源学习群： 214741894