一、前言
上次我們講到過如何在ASP.NET Core中使用WebSocket,沒有閱讀過的朋友請參考 WebSocket in ASP.NET Core 文章 。這次的主角是SignalR它為我們提供了簡化操作WebSocket的框架。
二、SignalR目前情況
三、集成SignalR
當然ASP.NET Core 1.2離正式發布還有一段時間，目前想集成SignalR都不是現成的方案，我們要通過手動的方式集成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的文件內容如下：
<?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的源，來引用這個程序集。
2.在project.json添加引用
"Microsoft.AspNetCore.SignalR.Server": "0.2.0-*",
"Microsoft.AspNetCore.WebSockets": "1.0.0-*"
可以注意到SignalR的版本是0.2.0的alpha版本，所以后續版本可能變化也會比較大！ 聽說是好重寫的。
值得注意的是，SignalR目前只能在ASP.NET Core 1.1及以上版本上使用，在這個文章中我使用的.NET Core SDK版本為 1.0.0-preview2-003131 ，所以引用有問題的同學可以嘗試把CoreApp版本改為1.1，所有AspNetCore的程序集也都改變為1.1的版本。
3.添加配置代碼
我們需要在Startup類中的 ConfigureServices方法中添加如下代碼：
public void ConfigureServices(IServiceCollection services) { services.AddSignalR(options => { options.Hubs.EnableDetailedErrors = true; }); }
在Startup類中的Configure方法中添加如下代碼：
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); });
最后我們來運行它吧：
四、最后
附上一個可用的Demo：https://github.com/maxzhang1985/AspNetCore.SignalRDemo
GitHub：https://github.com/maxzhang1985/YOYOFx 如果覺還可以請Star下， 歡迎一起交流。
.NET Core 開源學習群： 214741894