ASP.NET SignaiR 實(shí)現(xiàn)消息的即時(shí)推送，并使用Push.js實(shí)現(xiàn)通知的示例代碼

更新時(shí)間：2017年01月04日 10:11:44 作者：宋米粒

ASP.NET SignalR 是為 ASP.NET 開發(fā)人員提供的一個(gè)庫，可以簡化開發(fā)人員將實(shí)時(shí) Web 功能添加到應(yīng)用程序的過程。有興趣的可以了解一下。

一.使用背景

1. SignalR是什么？

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ù)。

2.Push.js是什么？【需要瀏覽器支持H5Notifications】

Notifications翻譯過來即是通知。那么Push.js的通知又是什么樣的，見下圖:大多數(shù)在屏幕的右下角出現(xiàn)。

需要允許哦:

3.很多時(shí)候我們只能使用輪詢的方式進(jìn)行數(shù)據(jù)展示的更新和消息推送。于是就想到有沒有一種方式可以完成服務(wù)端數(shù)據(jù)更新時(shí)同步更新客戶端的一種解決方案。

二.開始部署一個(gè) SignalR項(xiàng)目【使用mvc】

1.新建mvc項(xiàng)目

.....................

2.導(dǎo)入程序包【Vs2015】

工具->NuGet包管理器-> 程序包管理控制臺->Install-Package Microsoft.AspNet.SignalR->等待安裝成功

3.新建集線器類

項(xiàng)目->右鍵->添加->新建項(xiàng)->SignalR->SignalR 永久鏈接類->保存->【以MyConnection1為例】MyConnection1

 public class MyConnection1 : PersistentConnection
  {
    /// <summary>
    /// 發(fā)送消息
    /// </summary>
    /// <param name="request"></param>
    /// <param name="connectionId"></param>
    /// <returns></returns>
    protected override Task OnConnected(IRequest request, string connectionId)
    {
      Debug.WriteLine(connectionId);
      return Connection.Send(connectionId, "Welcome!");//單推事列
    }

    /// <summary>
    /// 接受客戶端消息
    /// </summary>
    /// <param name="request"></param>
    /// <param name="connectionId"></param>
    /// <param name="data"></param>
    /// <returns></returns>
    protected override Task OnReceived(IRequest request, string connectionId, string data)
    {
      Debug.WriteLine(data);
      return Connection.Broadcast(data);//廣播
    }
    /// <summary>
    /// 掉線
    /// </summary>
    /// <param name="request"></param>
    /// <param name="connectionId"></param>
    /// <param name="stopCalled"></param>
    /// <returns></returns>
    protected override Task OnDisconnected(IRequest request, string connectionId, bool stopCalled)
    {
      Debug.WriteLine("掉線");
      return base.OnDisconnected(request, connectionId, stopCalled);
    }

    /// <summary>
    /// 重連
    /// </summary>
    /// <param name="request"></param>
    /// <param name="connectionId"></param>
    /// <returns></returns>
    protected override Task OnReconnected(IRequest request, string connectionId)
    {
      Debug.WriteLine("重連");
      return base.OnReconnected(request, connectionId);
    }
  }

4.新建 Owin Startup 類【SignalR遵循Owin標(biāo)準(zhǔn)，Startup則是組件的啟動(dòng)，默認(rèn)會存在Startup類，只需修改即可】

我們在Configuration里面追加以下代碼

public void Configuration(IAppBuilder app)
    {
      app.MapSignalR<MyConnection1>("/myconnection");
    }

解釋:訪問myconnection的時(shí)候，觸發(fā)MyConnection1

5.增加客戶端【h5】

@{
  ViewBag.Title = "Home Page";
  Layout = null;
}
<!DOCTYPE html>
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title></title>
  <meta charset="utf-8" />
</head>
<body>
  <script src="~/Scripts/jquery-1.10.2.js"></script>
  <script src="~/Scripts/jquery.signalR-2.2.1.js"></script>
  <script type="text/javascript">
    var conn = $.connection("/myconnection");

    conn.start().done(function (data) {
      console.log("已連接服務(wù)器,當(dāng)前GUID為" + data.id);
      conn.send("To Admin");//發(fā)送給服務(wù)器
    });

    //接受服務(wù)器的推送
    conn.received(function (data) {
      console.log("服務(wù)器返回消息： " + data);
    });
  </script>
</body>
</html>

6.啟動(dòng)項(xiàng)目打開瀏覽器控制臺，你會發(fā)現(xiàn)見下圖、這就表示你已經(jīng)完成了第一步。

7.下面我們需要準(zhǔn)備 push.js

下載地址 https://github.com/Nickersoft/push.js

8.引用js

<script src="../Js/push.js"></script>

9.新建js推送demo

  function push(data, url, img) {
    var imgurl = img != "" ? img : "../Images/icon.png";
    Push.create("新通知", {
      body: data,
      icon: imgurl,
      requireInteraction: true,
      onClick: function () {
        window.focus();
        this.close();
        window.location.href =url;
      }
    });
  }

解釋:data:為消息內(nèi)容

url：為點(diǎn)擊通知進(jìn)入的鏈接

img: 為通知展示的圖片地址

requireInteraction: 設(shè)置為true時(shí)，除非用戶手動(dòng)關(guān)閉或單擊該通知，否則該通知不會關(guān)閉。需要設(shè)置消失時(shí)間請?zhí)鎿Q該屬性為timeout: 5000 單位毫秒

其他事件請閱讀:https://www.npmjs.com/package/push.js

10.組合兩者

  //實(shí)時(shí)推送
  var conn = $.connection("/myconnection");

  conn.start().done(function (data) {
    console.log("已連接服務(wù)器,當(dāng)前GUID為" + data.id);
  });

  //接受服務(wù)器的推送
  conn.received(function (msg) {
    console.log("服務(wù)器返回消息： " + msg);
    if (msg != "") {
      push(msg, "#", "")
    }
  });

11.效果如下：

12.實(shí)現(xiàn)服務(wù)器的主動(dòng)推送.現(xiàn)只介紹廣播。單推原理一致。

分為廣播及單推兩種模式。

廣播:

 var context = GlobalHost.ConnectionManager.GetConnectionContext<MyConnection1>();//獲取你當(dāng)前的Connection連接
  context.Connection.Broadcast("我是一條新的推送消息！");//廣播推送

單推:

 var context = GlobalHost.ConnectionManager.GetConnectionContext<MyConnection1>();//獲取你當(dāng)前的Connection連接
 context.Connection.Send(connectionId, "Welcome!");//單推事列

connectionId:是服務(wù)端為每個(gè)客戶端分配的GUID