ASP.NET MＶＣ SignalR 簡單聊天推送筆記
介紹：（抄襲於網絡）
ASP.NET SignalR 是為 ASP.NET 開發人員提供的一個庫，可以簡化開發人員將實時 Web 功能添加到應用程序的過程。實時 Web 功能是指這樣一種功能：當所連接的客戶端變得可用時服務器代碼可以立即向其推送內容，而不是讓服務器等待客戶端請求新的數據。
SignalR當然也提供了非常簡單易用的高階API，使服務器端可以單個或批量調用客戶端上的JavaScript函數，並且非常 方便地進行連接管理，例如客戶端連接到服務器端，或斷開連接，客戶端分組，以及客戶端授權，使用SignalR都非常 容易實現。
SignalR將與客戶端進行實時通信帶給了ASP .NET 。當然這樣既好用，而且也有足夠的擴展性。以前用戶需要刷新頁面或使用Ajax輪詢才能實現的實時顯示數據，現在只要使用SignalR，就可以簡單實現了。最重要的是您無需重新建立項目，使用現有ASP .NET項目即可無縫使用SignalR。
首先，我們平常做法創建MVC的Web項目，然後通過Nuget控制臺命令： Install-package Microsoft.AspNet.SignalR 加入SignalR的依賴，並且自動往MVC項目中的Script文件夾中增加相關的js文件
然後，我們需要在項目一級目錄創建一個OWIN的類文件名稱為 Startup.cs的類，裏面主要內容補全不下：
using System;
using System.Threading.Tasks;
using Microsoft.Owin;
using Owin;
[assembly: OwinStartup(typeof(WebExerciseUI.ServerSignalR.Startup))]
namespace WebExerciseUI.ServerSignalR
{
public class Startup
{
public void Configuration(IAppBuilder app)
{
app.MapSignalR("/chat",new Microsoft.AspNet.SignalR.HubConfiguration {
EnableDetailedErrors=true,
EnableJavaScriptProxies=true
});
}
}
}
首先我們從上往下分析註意點：
1. OwinStartup(Type) 構造函數傳遞的是一個類型，而這個類型對應的就是我們創建的Startup類，這個通過這個構造函數類標記起始位置；
2. namespace Stage.Api.Extend 是我項目的命名空間，這個可以隨便定義；
3. public void Configuration(IAppBuilder app) 函數是固定必須的，這裏程序會首先進入這個方法執行裏面的邏輯代碼；
4. app.MapSignalR 是擴展的IAppBuilder接口方法，他有多種表現形式，這裏我選擇的是 public static IAppBuilder MapSignalR(this IAppBuilder builder, string path, HubConfiguration configuration); ，這裏看有點類似於咋們MVC的路由，這裏主要註意的是這個Path參數，在前端頁面的時候需要用到這個路徑；
到這裏後臺需要的配置其實已經就完成了，下面是具體需要操作的業務邏輯處理類，新建一個類(這裏我取名為ChatHub)並繼承Hub(這是SignalR框架提供)，然後裏面的邏輯代碼如下：
using Microsoft.AspNet.SignalR;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
namespace WebExerciseUI.ServerSignalR
{
public class ChatHub : Hub
{
public static List<ModelUser> userList = new List<ModelUser>();
/// <summary>
/// 添加用戶
/// </summary>
/// <param name="Model"></param>
public void AddUser(ModelUser Model)
{
Model.UserID = Context.ConnectionId;
if (!userList.Any(n => n.UserID == Model.UserID))
{
userList.Add(Model);
}
Clients.All.userList(userList);
}
/// <summary>
/// 發送信息
/// </summary>
/// <param name="Name"></param>
/// <param name="Message"></param>
public void SendAll(ModelUser user, string Message)
{
Clients.All.addMessage(user, Message);
}
/// <summary>
/// 某個聊天人退出是，通知所有在線人重新加載聊天人數
/// </summary>
/// <param name="stopCalled"></param>
/// <returns></returns>
public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
{
var user = userList.SingleOrDefault(n => n.UserID == Context.ConnectionId);
if (user != null)
{
userList.Remove(user);
Clients.All.userList(userList);
}
return base.OnDisconnected(stopCalled);
}
}
}
上面的3個方法分別做了：添加聊天人到List，發送信息到客戶端，某個連接失效後通知各個有效的聊天人重新加載信息；這裏值得關註的是通過重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法來實現捕獲並移除失效連接（這裏是聊天人的信息）;整篇測試用例通過Context.ConnectionId來保證連接的唯一性，只要有新的鏈接請求，那麽服務端就會分配一個唯一串給這個鏈接，當客戶端關閉頁面或關閉鏈接這個是有就能在OnDisconnected方法中捕獲到這個失效的鏈接的ConnectionId，這樣就達到了移除失效聊天人的要求了；為了代碼的方便性，這裏創建了一個聊天人信息類：
namespace WebExerciseUI.ServerSignalR
{
public class ModelUser
{
/// <summary>
/// 用戶ID
/// </summary>
public string UserID { get; set; }
/// <summary>
/// 用戶名稱
/// </summary>
public string UserName { get; set; }
/// <summary>
/// 用戶信息
/// </summary>
public string UserMessage { get; set; }
}
}
到這裏後臺的聊天室代碼就完成了就是這麽簡單；我們再來看試圖中如何來寫代碼，這裏我先給出我的html布局代碼：
@{
Layout = null;
}
<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;
}
.text-left {
margin:auto;
/*text-align:center;*/
width:50%;
}
</style>
<div class="container text-left">
<h3>@ViewBag.Title 在線人數：<span id="sapnUserTotal">0</span>人</h3>
<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="發 送" 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-1.10.2.min.js"></script>
<script src="~/Scripts/jquery.signalR-2.2.3.min.js"></script>
@*<script src="/chat/hubs"></script>*@
<script type="text/javascript">
// 使用生成代理（jq方法） 許調用@*（<script src="/chat/hubs"></script>）*@
////信息推行建立連接
//var chat = $.connection.chatHub;
////實時推送登錄人名稱以及內容
// //chat.client.newUser = function (user) {
// // $("#users").append(‘ <li><strong>‘ + user.UserName + ‘[‘ + user.UserMessage + ‘]</strong></li>‘);
// //};
////實時推送登錄人名稱以及在線人數
// chat.client.userList = function (users) {
// console.log(users);
// $("#users").html("");
// $("#sapnUserTotal").html(users.length);
// $.each(users, function (i, item) {
// $("#users").append(‘ <li>[‘ + item.UserMessage + ‘] <strong>‘ + item.UserName + ‘</strong>(‘ + item.UserID + ‘)</li>‘);
// });
//};
////實時推送發送信息
// chat.client.addMessage = function (user, message) {
// console.log(user);
// $("#discussion").append(‘ <li ><span><strong>‘ + user.UserName + ‘[‘ + user.UserMessage + ‘]</strong>：</span><div class="send">‘ + message + ‘<div class="arrow"></div></div></li>‘);
// };
// //定義傳入參數
// var my = { UserName: "", UserMessage: "" }
// //定義聊天名稱
// var userName = prompt("請輸入一個昵稱：", my.UserName);
// //判斷是否定義用戶名
// if (userName != null && userName != "")
// my.UserName = userName.length > 0 ? userName : my.UserName;
// $(‘#displayname‘).val(userName);
// $(‘#message‘).focus();
// //定義客戶端連接
// $.connection.hub.logging = true;
// var options = { transport: [‘webSockets‘, ‘longPolling‘] };
// window.hubReady = $.connection.hub.start(options);
// window.hubReady.done(function () {
// my.UserMessage = $.connection.hub.transport.name;
// if (my.UserName == null || my.UserName == "")
// return null;
// 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("鏈接聊天室失敗，請重新刷新頁面。");
// });
//不使用生成的代理（jq方法）
//定義名稱
var my = { UserName: "", UserMessage: "" };
//定義連接
var connection = $.hubConnection("/chat/hubs");
var chat = connection.createHubProxy(‘chatHub‘);
//實時推送用戶名稱以及在線人數
chat.on("userList", function (users) {
console.log(users);
$("#sapnUserTotal").html(users.length);
console.log(users.length);
$("#users").html("");
$.each(users, function (i, item) {
$("#users").append(‘ <li>[‘ + item.UserMessage + ‘] <strong>‘ + item.UserName + ‘</strong>(‘ + item.UserID + ‘)</li>‘);
});
});
//實時推送發送信息內容
chat.on("addMessage", function (user, message) {
console.log(user);
$("#discussion").append(‘ <li ><span><strong>‘ + user.UserName + ‘[‘ + user.UserMessage + ‘]</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 userName = prompt("請輸入一個昵稱：", my.UserName);
if (userName != null && userName != "")
my.UserName = userName.length > 0 ? userName : my.UserName;
$(‘#displayname‘).val(userName);
$(‘#message‘).focus();
//建立客戶端連接
connection.start({ transport: [‘webSockets‘, ‘longPolling‘] }).done(function () {
my.UserMessage = connection.transport.name;
//console.log(my.TransportMethod);
if (my.UserName == null || my.UserName=="")
return null;
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();
});
});
</script>
咋們逐步來解析下代碼註意點：
1. var chat = $.connection.chatHub; 這裏的chatHub對應的就是咋們創建的並繼承Hub的ChatHub類，由於js變量開頭都是小寫，所以這裏是chatHub，這句活就表示鏈接到咋們後端了ChatHub類了，然後就可以使用裏面的方法啦（這種有點類似於早期的webform中某種ajax請求的寫法）
2. 通過chat.client.xxx來接收服務端通知的消息，而這個xxx對應的方法名稱和咋們後端的Clients.All.xxx，本章實例對應的是：chat.client.userList = function (users){}對應Clients.All.userList(_Users);這樣後端就能直接通知客戶端的對應方法了；註意這裏我後端Clients.All用的是通知全部客戶端的意思，如果您需要通知指定的鏈接需要用到的是： T Client(string connectionId); 方法
3. chat.client是後端調用客戶端，那相對的chat.server就是客戶端請求服務端，和上面一樣通過chat.server.xxx來指定請求的服務端方法，註意這個時候服務端方法指的是繼承類Hub的子類的公共方法（本篇對應的是：chat.server.sendAll(my, content)對應ChatHub.cs文件中的 public void SendAll(MoHubUser user, string message) 函數）
4. connection.hub.start({ transport: [‘webSockets‘, ‘longPolling‘] }) 來指定運行的交互協議
1. var connection = $.hubConnection("/chat/hubs"); 創建鏈接，這裏的path同樣對應後端的 app.MapSignalR("/chat" ，路徑保持一致
2. var chat = connection.createHubProxy(‘chatHub‘); 來創建反向代理鏈接，這裏的name：chatHub對應的是後端的ChatHub類名稱
3. 通過on("xxx",function(){})函數來綁定服務端通知客戶端的事件，xxx對應Clients.All.xxx中的xxx
4. connection.start({ transport: [‘webSockets‘, ‘longPolling‘] }) 來設置允許的鏈接方式，並開始鏈接
5. connection.transport.name來獲取鏈接的方式名稱，默認start不設置的話有這麽幾種：webSockets，foreverFrame，serverSentEvents，longPolling
6. chat.invoke("xxx", param1, param2)通過invoke來映射繼承類Hub的類的公共方法，這裏實例對應的是： chat.invoke("sendAll", my, content) 對應 public void SendAll(MoHubUser user, string message)
ASP.NET MＶＣ SignalR 簡單聊天推送筆記