Поделиться через


Учебник. Резидентное размещение SignalR

Патрик Флетчер

Предупреждение

Эта документация не для последней версии SignalR. Взгляните на ASP.NET Core SignalR.

В этом руководстве показано, как создать локальный сервер SignalR 2 и как подключиться к нему с помощью клиента JavaScript.

Версии программного обеспечения, используемые в этом руководстве

Использование Visual Studio 2012 с этим руководством

Чтобы использовать Visual Studio 2012 с этим руководством, выполните следующие действия.

  • Обновите диспетчер пакетов до последней версии.
  • Установите установщик веб-платформы.
  • В установщике веб-платформы найдите и установите ASP.NET and Web Tools 2013.1 для Visual Studio 2012. При этом будут установлены шаблоны Visual Studio для классов SignalR, таких как Hub.
  • Некоторые шаблоны (например , класс запуска OWIN) будут недоступны; вместо этого используйте файл класса.

Вопросы и комментарии

Оставьте отзыв о том, как вам понравилось это руководство и что мы могли бы улучшить в комментариях в нижней части страницы. Если у вас есть вопросы, которые не связаны напрямую с руководством, вы можете опубликовать их на форуме ASP.NET SignalR или StackOverflow.com.

Общие сведения

Сервер SignalR обычно размещается в ASP.NET приложении в IIS, но он также может быть локальным (например, в консольном приложении или службе Windows) с помощью библиотеки самообслуживания. Эта библиотека, как и вся в SignalR 2, создана на основе OWIN (открытый веб-интерфейс для .NET). OWIN определяет абстракции между веб-серверами .NET и веб-приложениями. OWIN отделяет веб-приложение от сервера, что делает OWIN идеальным для самостоятельного размещения веб-приложения в вашем собственном процессе за пределами IIS.

Ниже приведены причины, по которым не размещаться в СЛУЖБАх IIS:

  • Среды, в которых службы IIS недоступны или нежелательны, например существующая ферма серверов без IIS.
  • Необходимо избегать накладных расходов на производительность служб IIS.
  • Функциональные возможности SignalR необходимо добавить в существующее приложение, которое выполняется в службе Windows, рабочей роли Azure или другом процессе.

Если решение разрабатывается как локальное по соображениям производительности, рекомендуется также протестировать приложение, размещенное в IIS, чтобы определить преимущества производительности.

Это руководство содержит следующие разделы:

Создание сервера

В этом руководстве вы создадите сервер, размещенный в консольном приложении, но он может размещаться в любом виде процесса, например в службе Windows или рабочей роли Azure. Пример кода для размещения сервера SignalR в службе Windows см. в разделе Самообслуживание SignalR в службе Windows.

  1. Откройте Visual Studio 2013 с правами администратора. Выберите Файл, Создать проект. Выберите Windows в узле Visual C# на панели Шаблоны и выберите шаблон Консольное приложение . Назовите новый проект SignalRSelfHost и нажмите кнопку ОК.

    Снимок экрана: экран

  2. Откройте консоль диспетчера пакетов NuGet, выбрав Сервис>Консоль диспетчера>пакетов NuGet.

  3. В консоли диспетчера пакетов введите следующую команду:

    Install-Package Microsoft.AspNet.SignalR.SelfHost
    

    Эта команда добавляет библиотеки Self-Host SignalR 2 в проект.

  4. В консоли диспетчера пакетов введите следующую команду:

    Install-Package Microsoft.Owin.Cors
    

    Эта команда добавляет библиотеку Microsoft.Owin.Cors в проект. Эта библиотека будет использоваться для междоменной поддержки, которая требуется для приложений, в которых размещается SignalR и клиент веб-страницы в разных доменах. Так как сервер SignalR и веб-клиент будут размещаться на разных портах, это означает, что между доменами необходимо включить обмен данными между этими компонентами.

  5. Замените содержимое файла Program.cs на код, приведенный ниже.

    using System;
    using Microsoft.AspNet.SignalR;
    using Microsoft.Owin.Hosting;
    using Owin;
    using Microsoft.Owin.Cors;
    
    namespace SignalRSelfHost
    {
        class Program
        {
            static void Main(string[] args)
            {
                // This will *ONLY* bind to localhost, if you want to bind to all addresses
                // use http://*:8080 to bind to all addresses. 
                // See http://msdn.microsoft.com/library/system.net.httplistener.aspx 
                // for more information.
                string url = "http://localhost:8080";
                using (WebApp.Start(url))
                {
                    Console.WriteLine("Server running on {0}", url);
                    Console.ReadLine();
                }
            }
        }
        class Startup
        {
            public void Configuration(IAppBuilder app)
            {
                app.UseCors(CorsOptions.AllowAll);
                app.MapSignalR();
            }
        }
        public class MyHub : Hub
        {
            public void Send(string name, string message)
            {
                Clients.All.addMessage(name, message);
            }
        }
    }
    

    Приведенный выше код включает три класса:

    • Программа, включая метод Main , определяющий основной путь выполнения. В этом методе веб-приложение типа Startup запускается по указанному URL-адресу (http://localhost:8080). Если на конечной точке требуется безопасность, можно реализовать SSL. Дополнительные сведения см. в статье How to: Configure a Port with an SSL Certificate (Практическое руководство. Настройка порта с ПОМОЩЬЮ SSL-сертификата ).
    • Запуск, класс, содержащий конфигурацию для сервера SignalR (единственная конфигурация, которую используется в этом руководстве, — вызов UseCors), и вызов MapSignalR, который создает маршруты для всех объектов Hub в проекте.
    • MyHub, класс Концентратор SignalR, который приложение будет предоставлять клиентам. Этот класс имеет один метод Send, который клиенты будут вызывать для трансляции сообщения всем другим подключенным клиентам.
  6. Скомпилируйте и запустите приложение. Адрес, который выполняется на сервере, должен отображаться в окне консоли.

    Снимок экрана: сервер, работающий в окне консоли.

  7. Если выполнение завершается сбоем с исключением System.Reflection.TargetInvocationException was unhandled, необходимо перезапустить Visual Studio с правами администратора.

  8. Прежде чем перейти к следующему разделу, остановите приложение.

Доступ к серверу с помощью клиента JavaScript

В этом разделе вы будете использовать тот же клиент JavaScript из руководства по начало работы. Мы вносим только одно изменение в клиент, которое заключается в явном определении URL-адреса концентратора. При использовании локального приложения сервер не обязательно должен находиться по тому же адресу, что и URL-адрес подключения (из-за обратных прокси-серверов и подсистем балансировки нагрузки), поэтому URL-адрес должен быть определен явно.

  1. В Обозреватель решений щелкните решение правой кнопкой мыши и выберите Добавить, Создать проект. Выберите веб-узел и шаблон веб-приложения ASP.NET . Назовите проект JavascriptClient и нажмите кнопку ОК.

    Снимок экрана: экран

  2. Выберите пустой шаблон и оставьте остальные параметры не выбранными. Выберите Create Project.

    Снимок экрана: экран New A S P dot NET Project (Проект NET) с выбранным пустым шаблоном и выделенным параметром Create Project (Создать проект).

  3. В консоли диспетчера пакетов выберите проект JavascriptClient в раскрывающемся списке Проект по умолчанию и выполните следующую команду:

    Install-Package Microsoft.AspNet.SignalR.JS
    

    Эта команда устанавливает библиотеки SignalR и JQuery, необходимые в клиенте.

  4. Щелкните проект правой кнопкой мыши и выберите Добавить, Создать элемент. Выберите веб-узел и выберите HTML-страница. Назовите страницу Default.html.

    Снимок экрана: экран

  5. Замените содержимое новой HTML-страницы приведенным ниже кодом. Убедитесь, что ссылки на скрипты соответствуют скриптам в папке Scripts проекта.

    <!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-1.6.4.min.js"></script>
        <!--Reference the SignalR library. -->
        <script src="Scripts/jquery.signalR-2.1.0.min.js"></script>
        <!--Reference the autogenerated SignalR hub script. -->
        <script src="http://localhost:8080/signalr/hubs"></script>
        <!--Add script to update the page and send messages.-->
        <script type="text/javascript">
            $(function () {
            //Set the hubs URL for the connection
                $.connection.hub.url = "http://localhost:8080/signalr";
                
                // Declare a proxy to reference the hub.
                var chat = $.connection.myHub;
                
                // Create a function that the hub can call to broadcast messages.
                chat.client.addMessage = 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>
    

    Следующий код (выделенный в примере кода выше) является дополнением, которое вы сделали для клиента, используемого в учебнике Getting Stared (в дополнение к обновлению кода до SignalR версии 2 бета-версии). Эта строка кода явно задает базовый URL-адрес подключения для SignalR на сервере.

    //Set the hubs URL for the connection
    $.connection.hub.url = "http://localhost:8080/signalr";
    
  6. Щелкните решение правой кнопкой мыши и выберите Задать запускаемые проекты.... Выберите переключатель Несколько запускаемых проектов и установите для обоих проектов действиеЗапустить.

    Снимок экрана страниц свойств решения с переключателем

  7. Щелкните правой кнопкой мыши "Default.html" и выберите Пункт "Начальная страница".

  8. Запустите приложение. Будут запущены сервер и страница. Если страница загружается до запуска сервера, может потребоваться перезагрузить веб-страницу (или нажать кнопку Продолжить в отладчике).

  9. В браузере при появлении запроса укажите имя пользователя. Скопируйте URL-адрес страницы на другую вкладку или окно браузера и укажите другое имя пользователя. Вы сможете отправлять сообщения из одной области браузера в другую, как показано в руководстве по начало работы.