快捷導(dǎo)航

Asp.net MVC SignalR來做實(shí)時(shí)Web聊天實(shí)例代碼

更新時(shí)間：2017年06月02日 17:01:32 作者：神牛步行3

本篇文章主要介紹了Asp.net SignalR來做實(shí)時(shí)Web聊天實(shí)例代碼，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下

本章和大家分享的內(nèi)容是使用Signal R框架創(chuàng)建個(gè)簡易的群聊功能，主要講解如何在.Net的MVC中使用這個(gè)框架，由于這個(gè)項(xiàng)目有官方文檔（當(dāng)然全英文），后面也不打算寫分享篇了，主要目的是讓朋友們在需要使用Web實(shí)時(shí)通信的時(shí)候有更多一種解決方案，畢竟這是微軟主推的一種解決方案之一。

SignalR網(wǎng)上簡介

ASP.NET SignalR 是為 ASP.NET 開發(fā)人員提供的一個(gè)庫，可以簡化開發(fā)人員將實(shí)時(shí) Web 功能添加到應(yīng)用程序的過程。實(shí)時(shí) Web 功能是指這樣一種功能：當(dāng)所連接的客戶端變得可用時(shí)服務(wù)器代碼可以立即向其推送內(nèi)容，而不是讓服務(wù)器等待客戶端請求新的數(shù)據(jù)。

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

SignalR將與客戶端進(jìn)行實(shí)時(shí)通信帶給了ASP .NET 。當(dāng)然這樣既好用，而且也有足夠的擴(kuò)展性。以前用戶需要刷新頁面或使用Ajax輪詢才能實(shí)現(xiàn)的實(shí)時(shí)顯示數(shù)據(jù)，現(xiàn)在只要使用SignalR，就可以簡單實(shí)現(xiàn)了。最重要的是您無需重新建立項(xiàng)目，使用現(xiàn)有ASP .NET項(xiàng)目即可無縫使用SignalR。

群聊實(shí)例效果

咋們先來看看測試用例的效果吧，效果圖：

界面及其簡單，樣式這里就不考慮了，主要是展示其用法，這里涉及到的功能有：

1. 統(tǒng)計(jì)在線人數(shù)量

2. 顯示在線人數(shù)的昵稱和連接方式（本測試用例支持webSockets和longPolling(長連接)）

3. 群聊信息

MVC中如何使用SignalR

首先，我們平常做法創(chuàng)建MVC的Web項(xiàng)目，然后通過Nuget控制臺(tái)命令： Install-package Microsoft.AspNet.SignalR 加入SignalR的依賴，自動(dòng)添加的包如下：

 <package id="Microsoft.AspNet.SignalR" version="2.2.2" targetFramework="net45" />
 <package id="Microsoft.AspNet.SignalR.Core" version="2.2.2" targetFramework="net45" />
 <package id="Microsoft.AspNet.SignalR.JS" version="2.2.2" targetFramework="net45" />
 <package id="Microsoft.AspNet.SignalR.SystemWeb" version="2.2.2" targetFramework="net45" />

并且自動(dòng)往MVC項(xiàng)目中的Script文件夾中增加相關(guān)的js文件：

jquery.signalR-2.2.2.min.js

jquery.signalR-2.2.2.js

然后，我們需要在項(xiàng)目一級(jí)目錄創(chuàng)建一個(gè)文件名稱為Startup.cs的類，里面主要內(nèi)容補(bǔ)全不下：

[assembly: OwinStartup(typeof(Stage.Api.Extend.Startup))]
namespace Stage.Api.Extend
{
  public class Startup
  {
    public void Configuration(IAppBuilder app)
    {
      app.MapSignalR("/chat", new Microsoft.AspNet.SignalR.HubConfiguration
      {
        EnableDetailedErrors = true,
        EnableJavaScriptProxies = true
      });
    }
  }
}

首先我們從上往下分析注意點(diǎn)：

1. OwinStartup(Type) 構(gòu)造函數(shù)傳遞的是一個(gè)類型，而這個(gè)類型對應(yīng)的就是我們創(chuàng)建的Startup類，這個(gè)通過這個(gè)構(gòu)造函數(shù)類標(biāo)記起始位置；

2. namespace Stage.Api.Extend 是我項(xiàng)目的命名空間，這個(gè)可以隨便定義；

3. public void Configuration(IAppBuilder app) 函數(shù)是固定必須的，這里程序會(huì)首先進(jìn)入這個(gè)方法執(zhí)行里面的邏輯代碼；

4. app.MapSignalR 是擴(kuò)展的IAppBuilder接口方法，他有多種表現(xiàn)形式，這里我選擇的是 public static IAppBuilder MapSignalR(this IAppBuilder builder, string path, HubConfiguration configuration); ，這里看有點(diǎn)類似于咋們MVC的路由，這里主要注意的是這個(gè)Path參數(shù)，在前端頁面的時(shí)候需要用到這個(gè)路徑；

到這里后臺(tái)需要的配置其實(shí)已經(jīng)就完成了，下面是具體需要操作的業(yè)務(wù)邏輯處理類，新建一個(gè)類(這里我取名為ChatHub)并繼承Hub(這是SignalR框架提供)，然后里面的邏輯代碼如下：

public class ChatHub : Hub
  {
    //
    public int Num = 10001;
    public static List<MoHubUser> _Users = new List<MoHubUser>();

    /// <summary>
    /// 添加聊天人
    /// </summary>
    /// <param name="user"></param>
    public void AddUser(MoHubUser user)
    {

      user.Id = Context.ConnectionId;
      if (!_Users.Any(b => b.Id == user.Id))
      {
        _Users.Add(user);
      }

      //Clients.All.newUser(user);
      Clients.All.userList(_Users);
    }

    /// <summary>
    /// 發(fā)送信息
    /// </summary>
    /// <param name="user"></param>
    /// <param name="message"></param>
    public void SendAll(MoHubUser user, string message)
    {
      Clients.All.addNewMessageToPage(user, message);
    }

    /// <summary>
    /// 某個(gè)聊天人退出是，通知所有在線人重新加載聊天人數(shù)
    /// </summary>
    /// <param name="stopCalled"></param>
    /// <returns></returns>
    public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
    {
      var user = _Users.SingleOrDefault(x => x.Id == Context.ConnectionId);
      if (user != null)
      {
        _Users.Remove(user);
        Clients.All.userList(_Users);
      }
      return base.OnDisconnected(stopCalled);
    }
  }

上面的3個(gè)方法分別做了：添加聊天人到List，發(fā)送信息到客戶端，某個(gè)連接失效后通知各個(gè)有效的聊天人重新加載信息；這里值得關(guān)注的是通過重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法來實(shí)現(xiàn)捕獲并移除失效連接（這里是聊天人的信息）;整篇測試用例通過Context.ConnectionId來保證連接的唯一性，只要有新的鏈接請求，那么服務(wù)端就會(huì)分配一個(gè)唯一串給這個(gè)鏈接，當(dāng)客戶端關(guān)閉頁面或關(guān)閉鏈接這個(gè)是有就能在OnDisconnected方法中捕獲到這個(gè)失效的鏈接的ConnectionId，這樣就達(dá)到了移除失效聊天人的要求了；為了代碼的方便性，這里創(chuàng)建了一個(gè)聊天人信息類：

public class MoHubUser
  {

    public string Id { get; set; }
    public string NickName { get; set; }
    public string TransportMethod { get; set; }
  }

到這里后臺(tái)的聊天室代碼就完成了就是這么簡單；我們再來看試圖中如何來寫代碼，這里我先給出我的html布局代碼：

 @{
  ViewBag.Title = "神牛聊天室 - SignalR";
}
<style type="text/css">
  .div_left {
    width: 70%;
    float: left;
  }

  .div_right {
    width: 28%;
    float: left;
  }

  .ul {
    list-style: none;
    border: 1px solid #ccc;
    height: 500px;
    overflow-y: scroll;
    color: black;
  }

    .ul li {
      padding-top: 5px;
      padding-right: 25px;
    }

  .ul_user {
    list-style: none;
  }

    .ul_user li {
      padding-top: 5px;
    }

  .send {
    position: relative;
    background: #eae7e7;
    border-radius: 5px; /* 圓角 */
    padding-top: 4px;
    padding-left: 5px;
    margin-top: 13px;
  }

    .send .arrow {
      position: absolute;
      top: -16px;
      font-size: 0;
      border: solid 8px;
      border-color: #fff #fff #eae7e7 #fff;
    }
</style>
<h3>@ViewBag.Title 在線人數(shù)：<span id="sapnUserTotal">0</span>人</h3>
<div class="container text-left">
  <div class="div_left">
    <ul class="ul" id="discussion"></ul>
    <textarea rows="5" class="form-control" id="message" maxlength="500" placeholder="開始聊天. . ." style="max-width: 100%"></textarea><br />
    <input type="button" id="sendmessage" value="發(fā) 送" class="btn btn-default" />
    <input type="hidden" id="displayname" />
  </div>
  <div class="div_right">
    <ul id="users" class="ul_user"></ul>
  </div>
</div>

<script src="~/Scripts/jquery.signalR-2.2.2.min.js"></script>
@*<script src="~/chat/hubs"></script>*@

客戶端這里寫法大致有兩種選擇，一種直接使用生成的代理來操作，一種不用自動(dòng)生成的代理采用手動(dòng)創(chuàng)建代理的方式；為了內(nèi)容的簡潔性，這里只簡單講解下自動(dòng)生成的代理方式，而更多的是分享手動(dòng)創(chuàng)建代理鏈接的方式；

使用生成的代理獲取鏈接

首先，我們需要通過Script標(biāo)簽來引用一下自動(dòng)生成代理的路徑： <script src="~/chat/hubs"></script> ，注意啦這里的路徑/chat對應(yīng)的就是咋們在前面Startup.cs文件中配置 app.MapSignalR("/chat" 路徑，而后面/hubs固定的寫法(至少目前我還沒更多的試驗(yàn)過)，只有先應(yīng)用了這個(gè)~/chat/hubs，才能在后面使用生成的代理，先上段代碼：

var chat = $.connection.chatHub;
    chat.client.newUser = function (user) {
      $("#users").append(' <li><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong></li>');
    };

    chat.client.userList = function (users) {
      console.log(users);
      $("#sapnUserTotal").html(users.length);
      $.each(users, function (i, item) {
        $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
      });
    };
    chat.client.addNewMessageToPage = function (user, message) {
      console.log(user);
      $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');
    };
  //connection.hub.start({ transport: ['webSockets', 'longPolling'] }).done(function () {
    //  my.TransportMethod = connection.hub.transport.name;
    //  chat.server.addUser(my);

    //  $('#sendmessage').click(function () {
    //    //console.log(chat);
    //    var content = $.trim($('#message').val());
    //    if (content.length <= 0) { $('#message').val('').focus(); return; }
    //    chat.server.sendAll(my, content);
    //    $('#message').val('').focus();
    //  });
    //}).fail(function () {
    //  alert("鏈接聊天室失敗，請重新刷新頁面。");
    //});

咋們逐步來解析下代碼注意點(diǎn)：

1. var chat = $.connection.chatHub; 這里的chatHub對應(yīng)的就是咋們創(chuàng)建的并繼承Hub的ChatHub類，由于js變量開頭都是小寫，所以這里是chatHub，這句活就表示鏈接到咋們后端了ChatHub類了，然后就可以使用里面的方法啦（這種有點(diǎn)類似于早期的webform中某種ajax請求的寫法）

2. 通過chat.client.xxx來接收服務(wù)端通知的消息，而這個(gè)xxx對應(yīng)的方法名稱和咋們后端的Clients.All.xxx，本章實(shí)例對應(yīng)的是：chat.client.userList = function (users){}對應(yīng)Clients.All.userList(_Users);這樣后端就能直接通知客戶端的對應(yīng)方法了；注意這里我后端Clients.All用的是通知全部客戶端的意思，如果您需要通知指定的鏈接需要用到的是： T Client(string connectionId); 方法

3. chat.client是后端調(diào)用客戶端，那相對的chat.server就是客戶端請求服務(wù)端，和上面一樣通過chat.server.xxx來指定請求的服務(wù)端方法，注意這個(gè)時(shí)候服務(wù)端方法指的是繼承類Hub的子類的公共方法（本篇對應(yīng)的是：chat.server.sendAll(my, content)對應(yīng)ChatHub.cs文件中的 public void SendAll(MoHubUser user, string message) 函數(shù)）

4. connection.hub.start({ transport: ['webSockets', 'longPolling'] }) 來指定運(yùn)行的交互協(xié)議

以上就是使用生成代理的方式，按照上面的注意點(diǎn)來寫應(yīng)該不是問題；

使用手動(dòng)創(chuàng)建反向代理來鏈接

不采用生成的代碼的方式，我們只需要修改前端就行了，后臺(tái)代碼不用變或設(shè)置不用變動(dòng)；首先我們把上面說的Script引用自動(dòng)代理的代碼去掉，因?yàn)檫@個(gè)時(shí)候不需要了，我們還是先上代碼：

var my = { NickName: "神牛001", TransportMethod: "" };
    var connection = $.hubConnection("/chat/hubs");
    var chat = connection.createHubProxy('chatHub');

    chat.on("userList", function (users) {
      console.log(users);
      $("#sapnUserTotal").html(users.length);
      $("#users").html("");
      $.each(users, function (i, item) {
        $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');
      });
    });

    chat.on("addNewMessageToPage", function (user, message) {
      console.log(user);
      $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');

      var div = document.getElementById('discussion');
      //div.scrollTop = div.scrollHeight;
      div.scrollTop = 999999;
    });

    var nickName = prompt("請輸入一個(gè)昵稱：", my.NickName);
    my.NickName = nickName.length > 0 ? nickName : my.NickName;
    $('#displayname').val(nickName);
    $('#message').focus();
   

    connection.start({ transport: ['webSockets', 'longPolling'] }).done(function () {

      my.TransportMethod = connection.transport.name;
      //console.log(my.TransportMethod);
      chat.invoke("addUser", my);

      $('#sendmessage').click(function () {
        var content = $.trim($('#message').val());
        if (content.length <= 0) { $('#message').val('').focus(); return; }

        chat.invoke("sendAll", my, content);
        $('#message').val('').focus();
      });
    });

同樣列出如下注意點(diǎn)：

1. var connection = $.hubConnection("/chat/hubs"); 創(chuàng)建鏈接，這里的path同樣對應(yīng)后端的 app.MapSignalR("/chat" ，路徑保持一致

2. var chat = connection.createHubProxy('chatHub'); 來創(chuàng)建反向代理鏈接，這里的name：chatHub對應(yīng)的是后端的ChatHub類名稱

3. 通過on("xxx",function(){})函數(shù)來綁定服務(wù)端通知客戶端的事件，xxx對應(yīng)Clients.All.xxx中的xxx

4. connection.start({ transport: ['webSockets', 'longPolling'] }) 來設(shè)置允許的鏈接方式，并開始鏈接

5. connection.transport.name來獲取鏈接的方式名稱，默認(rèn)start不設(shè)置的話有這么幾種：webSockets，foreverFrame，serverSentEvents，longPolling

6. chat.invoke("xxx", param1, param2)通過invoke來映射繼承類Hub的類的公共方法，這里實(shí)例對應(yīng)的是： chat.invoke("sendAll", my, content) 對應(yīng) public void SendAll(MoHubUser user, string message)

寫在最后

到此如果滿足以上注意點(diǎn)，那么基本SignalR就能鏈接使用成功了，注意點(diǎn)比較多不過都是總結(jié)的經(jīng)驗(yàn)，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: