詳解在ASP.NET Core下使用SignalR技術

更新時間：2017年02月04日 16:18:20 作者：YOYOFx

本篇文章主要介紹了在ASP.NET Core下使用SignalR技術，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

一、前言

上次我們講到過如何在ASP.NET Core中使用WebSocket 。這次的主角是SignalR它為我們提供了簡化操作WebSocket的框架。

ASP .NET SignalR 是一個ASP.NET 下的類庫，可以在ASP.NET 的Web項目中實現(xiàn)實時通信。什么是實時通信的Web呢？就是讓客戶端（Web頁面）和服務器端可以互相通知消息及調(diào)用方法，當然這是實時操作的。WebSockets是HTML5提供的新的API，可以在Web網(wǎng)頁與服務器端間建立Socket連接，當WebSockets可用時（即瀏覽器支持Html5）SignalR使用WebSockets，當不支持時SignalR將使用其它技術來保證達到相同效果。

SignalR當然也提供了非常簡單易用的高階API，使服務器端可以單個或批量調(diào)用客戶端上的JavaScript函數(shù)，并且非常方便地進行連接管理，例如客戶端連接到服務器端，或斷開連接，客戶端分組，以及客戶端授權，使用SignalR都非常容易實現(xiàn)。

二、SignalR目前情況

我們知道在ASP.NET Core 1.0.x 版本中并沒有包含SignalR，但是SignalR技術計劃集成在ASP.NET Core 1.2版本中，并且它的開發(fā)團隊還要使用TypeScript對它的javascript客戶端進行重寫，服務端方面也會貼近ASP.NET Core的開發(fā)方式，比如會集成到ASP.NET Core依賴注入框架中。

目前的情況就是在1.0中無法使用SignalR技術，本文實現(xiàn)的Demo都是在1.1下進行的。

三、集成SignalR

當然ASP.NET Core 1.2離正式發(fā)布還有一段時間，目前想集成SignalR都不是現(xiàn)成的方案，我們要通過手動的方式集成SignalR。

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

當然上面也說過目前沒有ASP.NET Core沒有集成SignalR，所以NUGET上也找不到SignalR的程序包，想添加引用我們就得去MyGet上去找找。

1.添加NuGet源

在程序根目錄新建一個命為NuGet.Config的文件內(nèi)容如下：

<?xml version="0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear/>
      <add key="aspnetcidev" value="https://dotnetmygetorg/F/aspnetcore-ci-dev/api/v3/indexjson"/>
      <add key="apinugetorg" value="https://apinugetorg/v3/indexjson"/>
  </packageSources>
</configuration>

當然我們也可以通過在Visual Studio中設置 NuGet Packages的源，來引用這個程序集。

2.在project.json添加引用

"MicrosoftAspNetCoreSignalRServer": "0-*",
"MicrosoftAspNetCoreWebSockets": "0-*"

可以注意到SignalR的版本是0.2.0的alpha版本，所以后續(xù)版本可能變化也會比較大！聽說是好重寫的。

值得注意的是，SignalR目前只能在ASP.NET Core 1.1及以上版本上使用，在這個文章中我使用的.NET Core SDK版本為 1.0.0-preview2-003131 ，所以引用有問題的同學可以嘗試把CoreApp版本改為1.1，所有AspNetCore的程序集也都改變?yōu)?.1的版本。

3.添加配置代碼

我們需要在Startup類中的 ConfigureServices方法中添加如下代碼：

public void ConfigureServices(IServiceCollection services)
{
   servicesAddSignalR(options => 
   {
     optionsHubsEnableDetailedErrors = true;
   });
}

在Startup類中的Configure方法中添加如下代碼：

appUseWebSockets();
appUseSignalR();

4.添加一個HUB類

這里我們只實現(xiàn)一個小Demo，一個簡單的聊天室，多個人進入可以看到各自發(fā)送的信息：

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

    public void Send(string originatorUser, string message)
    {
      ClientsAllmessageReceived(originatorUser, message);
    }

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

      ConnectedUsersAdd(newUser);
      ClientsCallergetConnectedUsers(ConnectedUsers);
      ClientsOthersnewUserAdded(newUser);
    }
}

5.客戶端支持

在wwwroot目錄下創(chuàng)建一個名為chat.html的Html靜態(tài)文件，內(nèi)容如下：

<!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://ajaxaspnetcdncom/ajax/jQuery/jquery-minjs"></script>
  <script src="http://ajaxaspnetcdncom/ajax/signalr/jquerysignalr-minjs"></script>
  <script src="signalr/hubs"></script>
  <script src="chatjs"></script>
</body>
</html>

同目錄下建立一個chat.js添加要實現(xiàn)功能的腳本：

var userName = prompt("Enter your name: ");
var chat = $connectionchatHub;
chatclientmessageReceived = function (originatorUser, message) {
  $("#messages")append('<li><strong>' + originatorUser + '</strong>: ' + message);
};
chatclientgetConnectedUsers = function (userList) {
  for (var i = 0; i < userListlength; i++)
    addUser(userList[i]);
};
chatclientnewUserAdded = function (newUser) {
  addUser(newUser);
}
$("#messageBox")focus();
$("#sendMessage")click(function () {
  chatserversend(userName, $("#messageBox")val());
  $("#messageBox")val("");
  $("#messageBox")focus();
});
$("#messageBox")keyup(function (event) {
  if (eventkeyCode == 13)
    $("#sendMessage")click();
});
function addUser(user){
  $("#userList")append('<li>' + user + '</li>');
}
$connectionhublogging = true;
$connectionhubstart()done(function () {
  chatserverconnect(userName);
});

最后我們來運行它吧：