在ASP.NET Core下使用SignalR技术

一、前言

  上次我们讲到过如何在ASP.NET Core中使用WebSocket,没有阅读过的朋友请参考 WebSocket in ASP.NET Core 文章 。这次的主角是SignalR它为我们提供了简化操作WebSocket的框架。

  ASP .NET SignalR 是一个ASP.NET 下的类库,可以在ASP.NET 的Web项目中实现实时通信。什么是实时通信的Web呢?就是让客户端(Web页面)和服务器端可以互相通知消息及调用方法,当然这是实时操作的。WebSockets是HTML5提供的新的API,可以在Web网页与服务器端间建立Socket连接,当WebSockets可用时(即浏览器支持Html5)SignalR使用WebSockets,当不支持时SignalR将使用其它技术来保证达到相同效果。SignalR当然也提供了非常简单易用的高阶API,使服务器端可以单个或批量调用客户端上的JavaScript函数,并且非常 方便地进行连接管理,例如客户端连接到服务器端,或断开连接,客户端分组,以及客户端授权,使用SignalR都非常容易实现。


二、SignalR目前情况

  我们知道在ASP.NET Core 1.0.x 版本中并没有包含SignalR,但是SignalR技术计划集成在ASP.NET Core 1.2版本中,并且它的开发团队还要使用TypeScript对它的javascript客户端进行重写,服务端方面也会贴近ASP.NET Core的开发方式,比如会集成到ASP.NET Core依赖注入框架中。

  目前的情况就是在1.0中无法使用SignalR技术,本文实现的Demo都是在1.1下进行的。


三、集成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的文件内容如下:

        
      
      
      
        
        
        
        
  1. xml version="1.0" encoding="utf-8"?>

  2.    

  3.        

  4.             key="aspnetcidev" value="https://dotnet.myget.org/F/aspnetcore-ci-dev/api/v3/index.json"/>

  5.             key="api.nuget.org" value="https://api.nuget.org/v3/index.json"/>

  6.    

 

  当然我们也可以通过在Visual Studio中设置 NuGet Packages的源,来引用这个程序集。

  2.在project.json添加引用

        
      
      
      
        
        
        
        
  1. "Microsoft.AspNetCore.SignalR.Server": "0.2.0-*",

  2. "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方法中添加如下代码:

        
      
      
      
        
        
        
        
  1. public void ConfigureServices(IServiceCollection services)

  2. {

  3.     services.AddSignalR(options =>

  4.     {

  5.         options.Hubs.EnableDetailedErrors = true;

  6.      });

  7. }

  在Startup类中的Configure方法中添加如下代码:

        
      
      
      
        
        
        
        
  1. app.UseWebSockets();

  2. app.UseSignalR();

  4.添加一个HUB类

  这里我们只实现一个小Demo,一个简单的聊天室,多个人进入可以看到各自发送的信息:

        
      
      
      
        
        
        
        
  1. public class ChatHub : Hub

  2. {

  3.        public static List ConnectedUsers;

  4.        public void Send(string originatorUser, string message)

  5.        {

  6.            Clients.All.messageReceived(originatorUser, message);

  7.        }

  8.        public void Connect(string newUser)

  9.        {

  10.            if (ConnectedUsers == null)

  11.                ConnectedUsers = new List();

  12.            ConnectedUsers.Add(newUser);

  13.            Clients.Caller.getConnectedUsers(ConnectedUsers);

  14.            Clients.Others.newUserAdded(newUser);

  15.        }

  16. }

  5.客户端支持

  在wwwroot目录下创建一个名为chat.html的Html静态文件,内容如下:

        
      
      
      
        
        
        
        
  1. DOCTYPE html>

  2. <html>

  3. <head>

  4.    <title>Awesome Chat Applicationtitle>

  5.    <meta charset="utf-8" />

  6. head>

  7. <body>

  8.    <style type="text/css">

  9.        .userListDiv{ float: right; }

  10.    style>

  11.    <ul id="messages">ul>

  12.    <input type="text" id="messageBox" />

  13.    <input type="button" id="sendMessage" value="Send Message!" />

  14.    <div class="userListDiv">

  15.        <ul id="userList"> ul>

  16.    div>

  17.  

  18.    <script src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-3.1.0.min.js">script>

  19.    <script src="http://ajax.aspnetcdn.com/ajax/signalr/jquery.signalr-2.2.1.min.js">script>

  20.    <script src="signalr/hubs">script>

  21.    <script src="chat.js">script>

  22. body>

  23. html>

  同目录下建立一个chat.js添加要实现功能的脚本:

        
      
      
      
        
        
        
        
  1. var userName = prompt("Enter your name: ");

  2. var chat = $.connection.chatHub;

  3. chat.client.messageReceived = function (originatorUser, message) {

  4.    $("#messages").append('

  5. ' + originatorUser + ': ' + message);

  6. };

  7. chat.client.getConnectedUsers = function (userList) {

  8.    for (var i = 0; i < userList.length; i++)

  9.        addUser(userList[i]);

  10. };

  11. chat.client.newUserAdded = function (newUser) {

  12.    addUser(newUser);

  13. }

  14. $("#messageBox").focus();

  15. $("#sendMessage").click(function () {

  16.    chat.server.send(userName, $("#messageBox").val());

  17.    $("#messageBox").val("");

  18.    $("#messageBox").focus();

  19. });

  20. $("#messageBox").keyup(function (event) {

  21.    if (event.keyCode == 13)

  22.        $("#sendMessage").click();

  23. });

  24. function addUser(user){

  25.    $("#userList").append('

  26. ' + user + '
  27. ');

  28. }

  29. $.connection.hub.logging = true;

  30. $.connection.hub.start().done(function () {

  31.    chat.server.connect(userName);

  32. });

  最后我们来运行它吧:

 在ASP.NET Core下使用SignalR技术_第1张图片

四、最后

  附上一个可用的Demo:https://github.com/maxzhang1985/AspNetCore.SignalRDemo 

  GitHub:https://github.com/maxzhang1985/YOYOFx  如果觉还可以请Star下, 欢迎一起交流。 

  .NET Core 开源学习群: 214741894  

相关文章: 

  • 基于.NET SingalR,LayIM2.0实现的web聊天室

  • Signalr系列之虚拟目录详解与应用中的CDN加速实战

  • ASP.NET SignalR 2.0入门指南

  • SignalR SelfHost实时消息,集成到web中,实现服务器消息推送

  • ASP.NET SignalR 高可用设计

  • WebSocket in ASP.NET Core

  • SignalR的性能监测与服务器的负载测试

原文地址:http://www.cnblogs.com/maxzhang1985/p/6364588.html


.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注

你可能感兴趣的:(在ASP.NET Core下使用SignalR技术)