Учебник. Чат в реальном времени с SignalR 2Tutorial: Real-time chat with SignalR 2

Этом руководстве показано, как использовать SignalR для создания приложения разговора в режиме реального времени.This tutorial shows you how to use SignalR to create a real-time chat application. Добавьте пустой веб-приложения ASP.NET SignalR и создайте страницу HTML для отправки и отображения сообщений.You add SignalR to an empty ASP.NET web application and create an HTML page to send and display messages.

В этом учебнике рассмотрены следующие задачи.In this tutorial, you:

  • Настройка проектаSet up the project
  • Запуск образцаRun the sample
  • Изучите кодExamine the code

Warning

Эта документация не для последней версии SignalR.This documentation isn't for the latest version of SignalR. Взгляните на ASP.NET Core SignalR.Take a look at ASP.NET Core SignalR.

Предварительные требованияPrerequisites

Настройка проектаSet up the Project

В этом разделе показано, как использовать Visual Studio 2017 и SignalR 2 для создания пустой веб-приложения ASP.NET, добавьте SignalR и создание приложения чата.This section shows how to use Visual Studio 2017 and SignalR 2 to create an empty ASP.NET web application, add SignalR, and create the chat application.

  1. В Visual Studio создайте веб-приложения ASP.NET.In Visual Studio, create an ASP.NET Web Application.

    Создание веб-

  2. В новый проект ASP.NET — SignalRChat окне оставьте пустой затем выберите ОК.In the New ASP.NET Project - SignalRChat window, leave Empty selected and select OK.

  3. В обозревателе решений, щелкните правой кнопкой мыши проект и выберите добавить > новый элемент.In Solution Explorer, right-click the project and select Add > New Item.

  4. В Добавление нового элемента — SignalRChatвыберите установленные > Visual C# > Web > SignalR , а затем выберите класс концентратора SignalR (v2).In Add New Item - SignalRChat, select Installed > Visual C# > Web > SignalR and then select SignalR Hub Class (v2).

  5. Назовите класс ChatHub и добавьте его в проект.Name the class ChatHub and add it to the project.

    На этом шаге создается ChatHub.cs файла и добавляет набор файлов сценариев и ссылки на сборки, которые поддерживают SignalR в проект.This step creates the ChatHub.cs class file and adds a set of script files and assembly references that support SignalR to the project.

  6. Замените код в новом ChatHub.cs файл класса следующим кодом:Replace the code in the new ChatHub.cs class file with this code:

    using System;
    using System.Web;
    using Microsoft.AspNet.SignalR;
    namespace SignalRChat
    {
        public class ChatHub : Hub
        {
            public void Send(string name, string message)
            {
                // Call the broadcastMessage method to update clients.
                Clients.All.broadcastMessage(name, message);
            }
        }
    }
    
  7. В обозревателе решений, щелкните правой кнопкой мыши проект и выберите добавить > новый элемент.In Solution Explorer, right-click the project and select Add > New Item.

  8. В Добавление нового элемента — SignalRChat выберите установленные > Visual C# > Web и затем Выберите класс запуска OWIN.In Add New Item - SignalRChat select Installed > Visual C# > Web and then select OWIN Startup Class.

  9. Назовите класс запуска и добавьте его в проект.Name the class Startup and add it to the project.

  10. Замените код по умолчанию в запуска класса следующим кодом:Replace the default code in Startup class with this code:

    using Microsoft.Owin;
    using Owin;
    [assembly: OwinStartup(typeof(SignalRChat.Startup))]
    namespace SignalRChat
    {
        public class Startup
        {
            public void Configuration(IAppBuilder app)
            {
                // Any connection or hub wire up and configuration should go here
                app.MapSignalR();
            }
        }
    }
    
  11. В обозревателе решений, щелкните правой кнопкой мыши проект и выберите добавить > HTML-страницу.In Solution Explorer, right-click the project and select Add > HTML Page.

  12. Имя новой страницы индекс и выберите ОК.Name the new page index and select OK.

  13. В обозревателе решений, щелкните правой кнопкой мыши созданную HTML-страницы и выберите задать в качестве начальной страницы.In Solution Explorer, right-click the HTML page you created and select Set as Start Page.

  14. Замените код по умолчанию в HTML-страницы этот код:Replace the default code in the HTML page with this code:

    <!DOCTYPE html>
    <html>
    <head>
        <title>SignalR Simple Chat</title>
        <style type="text/css">
            .container {
                background-color: #99CCFF;
                border: thick solid #808080;
                padding: 20px;
                margin: 20px;
            }
        </style>
    </head>
    <body>
        <div class="container">
            <input type="text" id="message" />
            <input type="button" id="sendmessage" value="Send" />
            <input type="hidden" id="displayname" />
            <ul id="discussion">
            </ul>
        </div>
        <!--Script references. -->
        <!--Reference the jQuery library. -->
        <script src="Scripts/jquery-3.1.1.min.js" ></script>
        <!--Reference the SignalR library. -->
        <script src="Scripts/jquery.signalR-2.2.1.min.js"></script>
        <!--Reference the autogenerated SignalR hub script. -->
        <script src="signalr/hubs"></script>
        <!--Add script to update the page and send messages.--> 
        <script type="text/javascript">
            $(function () {
                // Declare a proxy to reference the hub. 
                var chat = $.connection.chatHub;
                // Create a function that the hub can call to broadcast messages.
                chat.client.broadcastMessage = function (name, message) {
                    // Html encode display name and message. 
                    var encodedName = $('<div />').text(name).html();
                    var encodedMsg = $('<div />').text(message).html();
                    // Add the message to the page. 
                    $('#discussion').append('<li><strong>' + encodedName
                        + '</strong>:&nbsp;&nbsp;' + encodedMsg + '</li>');
                };
                // Get the user name and store it to prepend to messages.
                $('#displayname').val(prompt('Enter your name:', ''));
                // Set initial focus to message input box.  
                $('#message').focus();
                // Start the connection.
                $.connection.hub.start().done(function () {
                    $('#sendmessage').click(function () {
                        // Call the Send method on the hub. 
                        chat.server.send($('#displayname').val(), $('#message').val());
                        // Clear text box and reset focus for next comment. 
                        $('#message').val('').focus();
                    });
                });
            });
        </script>
    </body>
    </html>
    
  15. В обозревателе решений, разверните сценариев.In Solution Explorer, expand Scripts.

    Библиотеки скрипта для jQuery и SignalR, отображаются в проект.Script libraries for jQuery and SignalR are visible in the project.

    Important

    Диспетчер пакетов может установить более позднюю версию сценариев SignalR.The package manager may have installed a later version of the SignalR scripts.

  16. Убедитесь, что ссылки на скрипты в блоке кода соответствуют версиям файлов сценариев в проекте.Check that the script references in the code block correspond to the versions of the script files in the project.

    Ссылки на скрипты из исходного блока кода:Script references from the original code block:

    <!--Script references. -->
    <!--Reference the jQuery library. -->
    <script src="Scripts/jquery-3.1.1.min.js" ></script>
    <!--Reference the SignalR library. -->
    <script src="Scripts/jquery.signalR-2.2.1.min.js"></script>
    
  17. Если они не совпадают, обновите .html файл.If they don't match, update the .html file.

  18. В строке меню выберите файл > сохранить все.From the menu bar, select File > Save All.

Запуск образцаRun the Sample

  1. На панели инструментов, включите отладки скриптов и затем нажмите кнопку воспроизведения, чтобы запустить пример в режиме отладки.In the toolbar, turn on Script Debugging and then select the play button to run the sample in Debug mode.

    Введите имя пользователя

  2. Когда откроется браузер, введите имя для вашего удостоверения чата.When the browser opens, enter a name for your chat identity.

  3. Скопируйте URL-адрес из браузера, откройте два других браузеров и вставьте URL-адреса в панели адрес.Copy the URL from the browser, open two other browsers, and paste the URLs into the address bars.

  4. В каждом браузере введите уникальное имя.In each browser, enter a unique name.

  5. Теперь добавьте комментарий и выберите отправки.Now, add a comment and select Send. Повторите, в других браузерах.Repeat that in the other browsers. Комментарии отображаются в режиме реального времени.The comments appear in real-time.

    Note

    Это приложение на простом чате не ведет контекста обсуждения на сервере.This simple chat application does not maintain the discussion context on the server. Концентратор осуществляет широковещательную передачу комментарии для всех текущих пользователей.The hub broadcasts comments to all current users. Пользователи, беседа позже будет видеть сообщения добавлены с момента их присоединения к.Users who join the chat later will see messages added from the time they join.

    См. в разделе, запуск приложения чата в трех различных браузерах.See how the chat application runs in three different browsers. Когда Tom Ананд и Сьюзан отправляют сообщения, все браузеры обновление в режиме реального времени:When Tom, Anand, and Susan send messages, all browsers update in real time:

    Все три браузеры отображают же журнала разговора

  6. В обозревателе решений, проверять документы скриптов узел для запущенного приложения.In Solution Explorer, inspect the Script Documents node for the running application. Файл скрипта с именем концентраторов , библиотека SignalR создает во время выполнения.There's a script file named hubs that the SignalR library generates at runtime. Этот файл управляет обменом данных между jQuery-сценарий и код на стороне сервера.This file manages the communication between jQuery script and server-side code.

    автоматически созданное концентраторов сценария в узел документов скриптов

Изучите кодExamine the Code

Приложение SignalRChat демонстрирует две основные задачи разработки SignalR.The SignalRChat application demonstrates two basic SignalR development tasks. Оно показано, как создать концентратор.It shows you how to create a hub. Сервер использует этот концентратор как объект основного координации.The server uses that hub as the main coordination object. Концентратор использует библиотеку jQuery SignalR для отправки и получения сообщений.The hub uses the SignalR jQuery library to send and receive messages.

Концентраторы SignalR в ChatHub.csSignalR Hubs in the ChatHub.cs

В приведенном выше примере кода ChatHub класс является производным от Microsoft.AspNet.SignalR.Hub класса.In the code sample above, the ChatHub class derives from the Microsoft.AspNet.SignalR.Hub class. Наследование от Hub класс является эффективным методом для построения приложения SignalR.Deriving from the Hub class is a useful way to build a SignalR application. Можно создавать открытые методы в классе концентратора и затем использовать их, вызвав их из сценариев на веб-странице.You can create public methods on your hub class and then use those methods by calling them from scripts in a web page.

В коде чата, клиенты вызывают ChatHub.Send метод для отправки нового сообщения.In the chat code, clients call the ChatHub.Send method to send a new message. Концентратор затем отправляет сообщение всем клиентам, вызвав Clients.All.broadcastMessage.The hub then sends the message to all clients by calling Clients.All.broadcastMessage.

Send Метод демонстрирует несколько вещей понятия:The Send method demonstrates several hub concepts:

  • Объявления открытых методов концентратора, таким образом, клиенты могут вызывать их.Declare public methods on a hub so that clients can call them.

  • Используйте Microsoft.AspNet.SignalR.Hub.Clients динамических свойств для взаимодействия со всеми клиентами, подключенных к этому концентратору.Use the Microsoft.AspNet.SignalR.Hub.Clients dynamic property to communicate with all clients connected to this hub.

  • Вызов функции на стороне клиента (например broadcastMessage функции) для обновления клиентов.Call a function on the client (like the broadcastMessage function) to update clients.

    public class ChatHub : Hub
    {
        public void Send(string name, string message)
        {
            // Call the broadcastMessage method to update clients.
            Clients.All.broadcastMessage(name, message);
        }
    }
    

SignalR и jQuery в index.htmlSignalR and jQuery in the index.html

Index.html страницы в примере кода показано, как использовать библиотеку jQuery SignalR для взаимодействия с центром SignalR.The index.html page in the code sample shows how to use the SignalR jQuery library to communicate with a SignalR hub. Код выполняет ряд важных задач.The code carries out many important tasks. Он объявляется прокси-сервер для ссылки на концентратор, объявляет функцию, сервер может обратиться к содержимому Push-уведомлений для клиентов, что он запускает подключение для отправки сообщений в концентратор.It declares a proxy to reference the hub, declares a function that the server can call to push content to clients, and it starts a connection to send messages to the hub.

var chat = $.connection.chatHub;

Note

В JavaScript должно быть camelCase ссылку на класс сервера и его членах.In JavaScript the reference to the server class and its members has to be camelCase. Ссылки на код примера C# ChatHub класс в JavaScript в виде chatHub.The code sample references the C# ChatHub class in JavaScript as chatHub.

В этот блок кода как создать функцию обратного вызова в скрипте.In this code block, you create a callback function in the script.

chat.client.broadcastMessage = function (name, message) {
        // Html encode display name and message. 
        var encodedName = $('<div />').text(name).html();
        var encodedMsg = $('<div />').text(message).html();
        // Add the message to the page. 
        $('#discussion').append('<li><strong>' + encodedName
            + '</strong>:&nbsp;&nbsp;' + encodedMsg + '</li>');
    };

Класс концентратора на сервере вызывает эту функцию для отправки обновлений содержимого для каждого клиента.The hub class on the server calls this function to push content updates to each client. Две строки, HTML-кодирование содержимого перед его отображением являются необязательными и Показать хороший способ предотвратить внедрение скрипта.The two lines that HTML-encode the content before displaying it are optional and show a good way to prevent script injection.

Этот код открывает соединение с концентратором.This code opens a connection with the hub.

$.connection.hub.start().done(function () {
        $('#sendmessage').click(function () {
            // Call the Send method on the hub. 
            chat.server.send($('#displayname').val(), $('#message').val());
            // Clear text box and reset focus for next comment. 
            $('#message').val('').focus();
        });
    });

Note

Такой подход гарантирует, что код устанавливает соединение перед выполнением обработчика событий.This approach ensures that the code establishes a connection before the event handler executes.

Код запускает подключение, а затем передает его функции, чтобы обрабатывать событие щелчка на отправки кнопку в HTML-страницы.The code starts the connection and then passes it a function to handle the click event on the Send button in the HTML page.

Получение кодаGet the code

Скачать завершенный проектDownload Completed Project

Дополнительные ресурсыAdditional resources

Дополнительные сведения о SignalR см. следующие ресурсы:For more about SignalR, see the following resources:

Следующие шагиNext steps

В этом руководстве вы:In this tutorial you:

  • Настройка проектаSet up the project
  • Запустили примерRan the sample
  • Проверить кодExamined the code

Перейдите к следующей статье, чтобы сведения об использовании SignalR и MVC 5.Advance to the next article to learn how to use SignalR and MVC 5.