SignalR 소개 및 사용법 소개

이 장에서 공유하는 내용은 Signal R 프레임워크를 사용하여 간단한 그룹 채팅 기능을 만드는 것입니다. 이 프로젝트에는 공식 문서가 있으므로(물론 모두 영어로 되어 있음) 주로 .Net의 MVC에서 이 프레임워크를 사용하는 방법을 설명합니다. 이 기사를 공유하는 주요 목적은 친구들이 웹 실시간 통신을 사용해야 할 때 더 많은 솔루션을 제공하는 것입니다. 결국 이는 Microsoft에서 주로 홍보하는 솔루션 중 하나입니다.

SignalR 온라인 소개

ASP.NET SignalR은 애플리케이션에 실시간 웹 기능을 추가하는 프로세스를 단순화하는 ASP.NET 개발자용 라이브러리입니다. 실시간 웹 기능은 클라이언트가 새 데이터를 요청할 때까지 서버가 기다리지 않고 서버 코드가 연결된 클라이언트에 콘텐츠가 제공되는 즉시 콘텐츠를 푸시할 수 있는 기능입니다.

SignalR은 물론 매우 간단하고 사용하기 쉬운 고급 API도 제공하므로 서버가 클라이언트의 JavaScript 함수를 개별적으로 또는 일괄적으로 호출할 수 있으며, 다음과 같은 연결 관리를 수행하는 것이 매우 편리합니다. 서버에 연결하는 클라이언트 또는 연결 끊기 연결, 클라이언트 그룹화 및 클라이언트 인증은 모두 SignalR을 사용하여 매우 쉽게 구현할 수 있습니다.

SignalR은 ASP .NET에 클라이언트와의 실시간 통신을 제공합니다. 물론, 이것은 사용하기 쉽고 충분한 확장성을 가지고 있습니다. 과거에는 사용자가 실시간 데이터 표시를 위해 페이지를 새로 고치거나 Ajax 폴링을 사용해야 했지만 이제는 SignalR을 사용하기만 하면 됩니다. 가장 중요한 것은 프로젝트를 다시 만들 필요가 없으며 기존 ASP .NET 프로젝트를 사용하여 SignalR을 원활하게 사용할 수 있다는 것입니다.

그룹 채팅 인스턴스 효과

먼저 테스트 사례의 효과를 살펴보겠습니다. 온라인 효과 링크는 다음과 같습니다: Godox Chat Room(:1001/home/shenniuchat), 렌더링:

인터페이스는 매우 간단하며 여기서는 주로 사용법을 표시하는 데 사용됩니다.

1. 온라인 사용자 수를 계산합니다.

2. 온라인 인원 수 (이 테스트 케이스는 webSockets 및 longPolling (긴 연결)을 지원합니다)

3. 그룹 채팅 정보

MVC에서 SignalR을 사용하는 방법

먼저 평소대로 MVC 웹 프로젝트를 생성한 다음 Nuget 콘솔 명령: Install-package Microsoft.AspNet.SignalR Add SignalR dependency 자동으로 추가되는 패키지는 다음과 같습니다:

  <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" />

관련 js 파일을 MVC 프로젝트의 Script 폴더에 자동으로 추가합니다:

jquery.signalR-2.2.2.min.js
jquery.signalR-2.2.2.js

그런 다음 프로젝트 수준 A 클래스에서 파일 이름이 Startup.cs인 디렉토리를 만들어야 합니다. 이 디렉토리의 주요 내용은 완료할 수 없습니다.

 1 [assembly: OwinStartup(typeof(Stage.Api.Extend.Startup))] 2 namespace Stage.Api.Extend 3 { 4     public class Startup 5     { 6         public void Configuration(IAppBuilder app) 7         { 8             app.MapSignalR("/chat", new Microsoft.AspNet.SignalR.HubConfiguration 9             {10                 EnableDetailedErrors = true,11                 EnableJavaScriptProxies = true12             });13         }14     }15 }

먼저 위에서 아래로 주의할 점을 분석합니다.

1. OwinStartup(Type) 이 유형은 이 생성자 클래스를 통해 시작 위치를 표시하는 Startup 클래스에 해당합니다.

namespace 3.

public

void 구성(IAppBuilder 앱) 여기서는 먼저 이 메서드를 입력하여 논리 코드를 실행합니다. 4. app.MapSignalR

은 확장된 IAppBuilder 인터페이스 메서드이며 다양한 형태의 표현이 있습니다. 여기서는

public static IAppBuilder MapSignalR(this IAppBuilder builder, string 경로, HubConfiguration을 선택합니다. 구성); 여기서는 MVC 라우팅과 약간 유사해 보입니다. 여기서 주목해야 할 주요 사항은 프런트 엔드 페이지에서 사용해야 하는 Path 매개변수입니다. 백엔드에 필요한 구성은 실제로 다음과 같습니다. 여기에서 완료해야 하는 특정 작업이 있습니다. 비즈니스 논리 처리 클래스

, 새 클래스를 만들고(여기서 이름은

ChatHub) Hub(SignalR 프레임워크에서 제공)을 상속합니다. 그러면 내부 논리 코드는 다음과 같습니다.

 1 public class ChatHub : Hub 2     { 3         // 4         public int Num = 10001; 5         public static List<MoHubUser> _Users = new List<MoHubUser>(); 6  7         /// <summary> 8         /// 添加聊天人 9         /// </summary>10         /// <param name="user"></param>11         public void AddUser(MoHubUser user)12         {13 14             user.Id = Context.ConnectionId;15             if (!_Users.Any(b => b.Id == user.Id))16             {17                 _Users.Add(user);18             }19 20             //Clients.All.newUser(user);21             Clients.All.userList(_Users);22         }23 24         /// <summary>25         /// 发送信息26         /// </summary>27         /// <param name="user"></param>28         /// <param name="message"></param>29         public void SendAll(MoHubUser user, string message)30         {31             Clients.All.addNewMessageToPage(user, message);32         }33 34         /// <summary>35         /// 某个聊天人退出是，通知所有在线人重新加载聊天人数36         /// </summary>37         /// <param name="stopCalled"></param>38         /// <returns></returns>39         public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)40         {41             var user = _Users.SingleOrDefault(x => x.Id == Context.ConnectionId);42             if (user != null)43             {44                 _Users.Remove(user);45                 Clients.All.userList(_Users);46             }47             return base.OnDisconnected(stopCalled);48         }49     }

上面的3个方法分别做了：添加聊天人到List，发送信息到客户端，某个连接失效后通知各个有效的聊天人重新加载信息；这里值得关注的是通过重新 public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled) 方法来实现捕获并移除失效连接（这里是聊天人的信息）;整篇测试用例通过Context.ConnectionId来保证连接的唯一性，只要有新的链接请求，那么服务端就会分配一个唯一串给这个链接，当客户端关闭页面或关闭链接这个是有就能在OnDisconnected方法中捕获到这个失效的链接的ConnectionId，这样就达到了移除失效聊天人的要求了；为了代码的方便性，这里创建了一个聊天人信息类：

1  public class MoHubUser2     {3 4         public string Id { get; set; }5         public string NickName { get; set; }6         public string TransportMethod { get; set; }7     }

到这里后台的聊天室代码就完成了就是这么简单；我们再来看试图中如何来写代码，这里我先给出我的html布局代码：

 1 @{ 2     ViewBag.Title = "神牛聊天室 - SignalR"; 3 } 4 <style type="text/css"> 5     .div_left { 6         width: 70%; 7         float: left; 8     } 9 10     .div_right {11         width: 28%;12         float: left;13     }14 15     .ul {16         list-style: none;17         border: 1px solid #ccc;18         height: 500px;19         overflow-y: scroll;20         color: black;21     }22 23         .ul li {24             padding-top: 5px;25             padding-right: 25px;26         }27 28     .ul_user {29         list-style: none;30     }31 32         .ul_user li {33             padding-top: 5px;34         }35 36     .send {37         position: relative;38         background: #eae7e7;39         border-radius: 5px; /* 圆角 */40         padding-top: 4px;41         padding-left: 5px;42         margin-top: 13px;43     }44 45         .send .arrow {46             position: absolute;47             top: -16px;48             font-size: 0;49             border: solid 8px;50             border-color: #fff #fff #eae7e7 #fff;51         }52 </style>53 <h3>@ViewBag.Title 在线人数：<span id="sapnUserTotal">0</span>人</h3>54 <div class="container text-left">55     <div class="div_left">56         <ul class="ul" id="discussion"></ul>57         <textarea rows="5" class="form-control" id="message" maxlength="500" placeholder="开始聊天. . ." style="max-width: 100%"></textarea><br />58         <input type="button" id="sendmessage" value="发 送" class="btn btn-default" />59         <input type="hidden" id="displayname" />60     </div>61     <div class="div_right">62         <ul id="users" class="ul_user"></ul>63     </div>64 </div>65 66 <script src="~/Scripts/jquery.signalR-2.2.2.min.js"></script>67 @*<script src="~/chat/hubs"></script>*@

客户端这里写法大致有两种选择，一种直接使用生成的代理来操作，一种不用自动生成的代理采用手动创建代理的方式；为了内容的简洁性，这里只简单讲解下自动生成的代理方式，而更多的是分享手动创建代理链接的方式；

使用生成的代理获取链接

首先，我们需要通过Script标签来引用一下自动生成代理的路径：  ，注意啦这里的路径/chat对应的就是咋们在前面Startup.cs文件中配置 app.MapSignalR("/chat" 路径，而后面/hubs固定的写法(至少目前我还没更多的试验过)，只有先应用了这个~/chat/hubs，才能在后面使用生成的代理，先上段代码：

 1  var chat = $.connection.chatHub; 2         chat.client.newUser = function (user) { 3             $("#users").append(' <li><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong></li>'); 4         }; 5  6         chat.client.userList = function (users) { 7             console.log(users); 8             $("#sapnUserTotal").html(users.length); 9             $.each(users, function (i, item) {10                 $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');11             });12         };13         chat.client.addNewMessageToPage = function (user, message) {14             console.log(user);15             $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');16         };17    //connection.hub.start({ transport: ['webSockets', 'longPolling'] }).done(function () {18         //    my.TransportMethod = connection.hub.transport.name;19         //    chat.server.addUser(my);20 21         //    $('#sendmessage').click(function () {22         //        //console.log(chat);23         //        var content = $.trim($('#message').val());24         //        if (content.length <= 0) { $('#message').val('').focus(); return; }25         //        chat.server.sendAll(my, content);26         //        $('#message').val('').focus();27         //    });28         //}).fail(function () {29         //    alert("链接聊天室失败，请重新刷新页面。");30         //});

咋们逐步来解析下代码注意点：

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'] }) 来指定运行的交互协议

以上就是使用生成代理的方式，按照上面的注意点来写应该不是问题；

使用手动创建反向代理来链接

不采用生成的代码的方式，我们只需要修改前端就行了，后台代码不用变或设置不用变动；首先我们把上面说的Script引用自动代理的代码去掉，因为这个时候不需要了，我们还是先上代码：

 1 var my = { NickName: "神牛001", TransportMethod: "" }; 2         var connection = $.hubConnection("/chat/hubs"); 3         var chat = connection.createHubProxy('chatHub'); 4  5         chat.on("userList", function (users) { 6             console.log(users); 7             $("#sapnUserTotal").html(users.length); 8             $("#users").html(""); 9             $.each(users, function (i, item) {10                 $("#users").append(' <li>[' + item.TransportMethod + '] <strong>' + item.NickName + '</strong>(' + item.Id + ')</li>');11             });12         });13 14         chat.on("addNewMessageToPage", function (user, message) {15             console.log(user);16             $("#discussion").append(' <li ><span><strong>' + user.NickName + '[' + user.TransportMethod + ']</strong>：</span><div class="send">' + message + '<div class="arrow"></div></div></li>');17 18             var div = document.getElementById('discussion');19             //div.scrollTop = div.scrollHeight;20             div.scrollTop = 999999;21         });22 23         var nickName = prompt("请输入一个昵称：", my.NickName);24         my.NickName = nickName.length > 0 ? nickName : my.NickName;25         $('#displayname').val(nickName);26         $('#message').focus();27      28 29         connection.start({ transport: ['webSockets', 'longPolling'] }).done(function () {30 31             my.TransportMethod = connection.transport.name;32             //console.log(my.TransportMethod);33             chat.invoke("addUser", my);34 35             $('#sendmessage').click(function () {36                 var content = $.trim($('#message').val());37                 if (content.length <= 0) { $('#message').val('').focus(); return; }38 39                 chat.invoke("sendAll", my, content);40                 $('#message').val('').focus();41             });42         });

다음 사항도 나열됩니다.

var 연결 = $.hubConnection("/chat/hubs"); 링크를 만드세요. 여기의 경로도 백엔드에 해당합니다. app.MapSignalR("/chat" , 경로는 동일하게 유지됩니다 2.

var chat = Connection.createHubProxy('chatHub'); 이름 여기: chatHub는 백엔드 ChatHub 클래스 이름3에 해당합니다. on("xxx", function(){}) 함수를 사용하여 서버가 클라이언트에 알리는 이벤트를 바인딩하고 xxx는 Clients.All.xxx에 해당합니다. xxx

4.

connection.start({ Transport: [

'webSockets', 'longPolling'] }) 허용된 링크 방법을 설정하고 링크를 시작합니다 5 . link.transport.name은 기본적으로 start가 설정되지 않은 경우 webSockets, ForeverFrame, serverSentEvents, longPolling

6과 같은 여러 유형이 있습니다. chat.invoke("xxx", param1, param2)는 다음과 같습니다. Invoke를 통해 매핑됨 Hub 클래스를 상속하는 클래스의 공용 메서드, 여기 인스턴스는

chat.invoke(

"sendAll", my, content)에 해당함 public void SendAll(MoHubUser 사용자, string 메시지) 마지막에 작성

위 사항만 충족된다면 기본 SignalR을 성공적으로 연동하여 사용할 수 있는 부분이 많지만, 경험을 정리한 것입니다. 많은 친구들이 도움이 되었으면 좋겠습니다. 이 글을 쓰고 있는 중 한 친구가 우연히 내 git 오픈소스

LovePicture.Web

프로젝트를 보고 있었고 그들도 Netcore를 사용하여 애플리케이션을 구축하려고 시도한다고 합니다. 내 프로젝트를 예로 들 수 있어서 영광이고 행복합니다. NetCore가 점점 더 영향력을 발휘하고 있다고 생각하시면 감사하겠습니다. 추천드려요, 감사합니다!

위 내용은 SignalR 소개 및 사용법 소개의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!