Home  >  Article  >  Backend Development  >  Detailed explanation of Asp.net MVC SignalR for real-time web chat example code

Detailed explanation of Asp.net MVC SignalR for real-time web chat example code

黄舟
黄舟Original
2017-06-04 09:47:071684browse

This article mainly introduces Asp.net SignalR to use real-time Web chat example code, which has certain reference value. Interested friends can refer to it

The content shared with you in this chapter is to use the Signal R framework to create a simple group chat function. It mainly explains how to use this framework in .Net's MVC. Because of this The project has official documents (all in English of course), and I won’t write a sharing article later. The main purpose is to let friends have more solutions when they need to use Web real-time communication. After all, this is a solution mainly promoted by Microsoft. One of the options.

SignalR OnlineIntroduction

ASP.NET SignalR is a library provided for ASP.NET developers that can Simplify the process for developers to add real-time web functionality to applications. A real-time web feature is a feature where server code can push content to a connected client as soon as it becomes available, rather than having the server wait for the client to request new data.

SignalR of course also provides a very simple and easy-to-use high-level API, so that the server can call the JavaScript function# on the client individually or in batches ##, and it is very convenient to perform connection management, such as client connection to server, or disconnection, client grouping, and client authorization, which are very easy to implement using SignalR.

SignalR brings real-time communication with clients to ASP .NET. Of course, this is easy to use and has sufficient scalability. In the past, users needed to refresh the page or use Ajax polling to achieve real-time display of data. Now they can simply use SignalR. The most important thing is that you don't need to re-create the project, you can use SignalR seamlessly using your existing ASP .NET project.

Group chat instance effect

Let’s take a look at the effect of the test case first, rendering:

The interface is extremely simple. The style will not be considered here. The main purpose is to show its usage. The functions involved here are:

1. Count the number of online people

2. Display the nickname and connection method of the number of people online (this test case supports webSockets and longPolling (long connection))

3. Group chat information

How to use MVC Using SignalR

First, we create an MVC Web project as usual, and then add SignalR through the Nuget console command: Inst

all-package Microsoft.AspNet.SignalR Dependencies, the automatically added packages are as follows:

 
 
 
 

and automatically add related js files to the Script folder in the MVC project:

jquery.signalR-2.2. 2.min.js

jquery.signalR-2.2.2.js

Then, we need to create a class with the file name Startup.cs in the project first-level directory, inside The main content cannot be completed:

[assembly: OwinStartup(typeof(Stage.Api.Extend.Startup))]
namespace Stage.Api.Extend
{
  public class Startup
  {
    public void Configuration(IAppBuilder app)
    {
      app.MapSignalR("/chat", new Microsoft.AspNet.SignalR.HubConfiguration
      {
        EnableDetailedErrors = true,
        EnableJavaScriptProxies = true
      });
    }
  }
}

First we analyze the attention points from top to bottom:

1.

OwinStartup(Type) ConstructorTransfer is a type, and this type corresponds to the Startup class we created, which marks the starting position through this constructor class;

2.

namespace Stage.Api.Extend is me Namespace of the project, this can be defined at will;

3.

public void Configuration(IAppBuilder app) The function is fixed and necessary, here the program will first enter this method Execute the logic code inside;

4.

app.MapSignalR is the extended IAppBuilder interface method. It has many forms of expression. Here I choose public static IAppBuilder MapSignalR(this IAppBuilder builder, string path, HubConfiguration configuration); , here it looks a bit similar to our MVC routing, The main thing to note here is the Path parameter, which needs to be used in the front-end page;

到这里后台需要的配置其实已经就完成了,下面是具体需要操作的业务逻辑处理类,新建一个类(这里我取名为ChatHub)并继承Hub(这是SignalR框架提供),然后里面的逻辑代码如下:

public class ChatHub : Hub
  {
    //
    public int Num = 10001;
    public static List _Users = new List();

    /// 
    /// 添加聊天人
    /// 
    /// 
    public void AddUser(MoHubUser user)
    {

      user.Id = Context.ConnectionId;
      if (!_Users.Any(b => b.Id == user.Id))
      {
        _Users.Add(user);
      }

      //Clients.All.newUser(user);
      Clients.All.userList(_Users);
    }

    /// 
    /// 发送信息
    /// 
    /// 
    /// 
    public void SendAll(MoHubUser user, string message)
    {
      Clients.All.addNewMessageToPage(user, message);
    }

    /// 
    /// 某个聊天人退出是,通知所有在线人重新加载聊天人数
    /// 
    /// 
    /// 
    public override System.Threading.Tasks.Task OnDisconnected(bool stopCalled)
    {
      var user = _Users.SingleOrDefault(x => x.Id == Context.ConnectionId);
      if (user != null)
      {
        _Users.Remove(user);
        Clients.All.userList(_Users);
      }
      return base.OnDisconnected(stopCalled);
    }
  }

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

public class MoHubUser
  {

    public string Id { get; set; }
    public string NickName { get; set; }
    public string TransportMethod { get; set; }
  }

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

 @{
  ViewBag.Title = "神牛聊天室 - SignalR";
}

@ViewBag.Title 在线人数:0


      @**@

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

      使用生成的代理获取链接

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

      var chat = $.connection.chatHub;
          chat.client.newUser = function (user) {
            $("#users").append(' 
    • ' + user.NickName + '[' + user.TransportMethod + ']
    • '); }; chat.client.userList = function (users) { console.log(users); $("#sapnUserTotal").html(users.length); $.each(users, function (i, item) { $("#users").append('
    • [' + item.TransportMethod + '] ' + item.NickName + '(' + item.Id + ')
    • '); }); }; chat.client.addNewMessageToPage = function (user, message) { console.log(user); $("#discussion").append('
    • ' + user.NickName + '[' + user.TransportMethod + ']

      ' + message + '

    • '); }; //connection.hub.start({ transport: ['webSockets', 'longPolling'] }).done(function () { // my.TransportMethod = connection.hub.transport.name; // 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("链接聊天室失败,请重新刷新页面。"); //});

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

      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引用自动代理的代码去掉,因为这个时候不需要了,我们还是先上代码:

      var my = { NickName: "神牛001", TransportMethod: "" };
          var connection = $.hubConnection("/chat/hubs");
          var chat = connection.createHubProxy('chatHub');
      
          chat.on("userList", function (users) {
            console.log(users);
            $("#sapnUserTotal").html(users.length);
            $("#users").html("");
            $.each(users, function (i, item) {
              $("#users").append(' 
    • [' + item.TransportMethod + '] ' + item.NickName + '(' + item.Id + ')
    • '); }); }); chat.on("addNewMessageToPage", function (user, message) { console.log(user); $("#discussion").append('
    • ' + user.NickName + '[' + user.TransportMethod + ']

      ' + message + '

    • '); var p = document.getElementById('discussion'); //p.scrollTop = p.scrollHeight; p.scrollTop = 999999; }); var nickName = prompt("请输入一个昵称:", my.NickName); my.NickName = nickName.length > 0 ? nickName : my.NickName; $('#displayname').val(nickName); $('#message').focus(); connection.start({ transport: ['webSockets', 'longPolling'] }).done(function () { my.TransportMethod = connection.transport.name; //console.log(my.TransportMethod); 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(); }); });

      同样列出如下注意点:

      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'] }) To set the allowed link method and start the link

      5. connection.transport .name to get the name of the link. If start is not set by default, there are several types: webSockets, foreverFrame, serverSentEvents, longPolling

      6. chat.invoke("xxx", param1, param2) is mapped through invoke The public method of the class that inherits the Hub class, the instance here corresponds to: chat.invoke("sendAll", my, content) corresponds to public void SendAll(MoHubUser user, string message)

      Write at the end

      The above is the detailed content of Detailed explanation of Asp.net MVC SignalR for real-time web chat example code. For more information, please follow other related articles on the PHP Chinese website!

      Statement:
      The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn