HTML5 WebSocket

WebSocket — это протокол, который HTML5 стал предоставлять для полнодуплексной связи через одно TCP-соединение.

WebSocket упрощает обмен данными между клиентом и сервером, позволяя серверу активно передавать данные клиенту. В API WebSocket браузеру и серверу нужно выполнить только одно рукопожатие, после чего они могут напрямую создать постоянное соединение и осуществлять двустороннюю передачу данных.

В API WebSocket браузеру и серверу нужно выполнить только действие рукопожатия, после чего между браузером и сервером образуется быстрый канал. Затем они могут напрямую передавать данные друг другу.

Сегодня многие веб-сайты используют Ajax-опрос для реализации push-технологии. Опрос — это когда браузер отправляет HTTP-запросы серверу через определённые интервалы времени (например, каждую 1 секунду), а сервер затем возвращает последние данные в браузер клиента. У этой традиционной модели есть очевидные недостатки: браузеру нужно непрерывно отправлять запросы серверу. Однако HTTP-запросы могут содержать длинные заголовки, а действительно полезные данные могут составлять лишь очень малую часть, что явно расходует много пропускной способности и других ресурсов.

Протокол WebSocket, определённый в HTML5, может лучше экономить ресурсы сервера и пропускную способность, а также позволяет более эффективно обмениваться данными в реальном времени.

Браузер через JavaScript отправляет серверу запрос на установление WebSocket-соединения. После установления соединения клиент и сервер могут напрямую обмениваться данными через TCP-соединение.

Когда вы получаете WebSocket-соединение, вы можете использовать методsend()для отправки данных на сервер и событиеonmessageдля получения данных, возвращаемых сервером.

Следующий API используется для создания объекта WebSocket.

var Socket = new WebSocket(url, [protocol] );

В приведённом выше коде первый параметр url задаёт URL соединения. Второй параметр protocol является необязательным и задаёт допустимые подпротоколы.


Свойства WebSocket

Ниже приведены свойства объекта WebSocket. Предположим, мы создали объект Socket, используя приведённый выше код:

Свойство Описание
Socket.readyState

Атрибут только для чтенияreadyStateУказывает состояние соединения, которое может принимать следующие значения:

  • 0 - Указывает, что соединение ещё не установлено.

  • 1 - Указывает, что соединение установлено и возможна связь.

  • 2 - Указывает, что соединение находится в процессе закрытия.

  • 3 - Указывает, что соединение закрыто или не может быть открыто.

Socket.bufferedAmount

Атрибут только для чтенияbufferedAmountКоличество байтов текста в кодировке UTF-8, помещённых в очередь на отправку с помощью send(), но ещё не отправленных.


События WebSocket

Ниже приведены связанные события объекта WebSocket. Предположим, мы создали объект Socket, используя приведённый выше код:

Event Обработчик события Описание
open Socket.onopen Срабатывает при установке соединения
message Socket.onmessage Срабатывает, когда клиент получает данные от сервера
error Socket.onerror Срабатывает при возникновении ошибки связи
close Socket.onclose Срабатывает при закрытии соединения

Методы WebSocket

Ниже приведены соответствующие методы объекта WebSocket. Предположим, мы создали объект Socket с помощью приведённого выше кода:

Метод Описание
Socket.send()

Отправка данных через соединение

Socket.close()

Закрыть подключение


Примеры WebSocket

Протокол WebSocket по сути является протоколом на основе TCP.

Чтобы установить соединение WebSocket, клиентскому браузеру сначала нужно инициировать HTTP-запрос к серверу. Этот запрос отличается от обычного HTTP-запроса и содержит некоторую дополнительную информацию в заголовках. Дополнительный заголовок "Upgrade: WebSocket" указывает, что это HTTP-запрос на обновление протокола. Сервер анализирует эту дополнительную информацию заголовков и формирует ответное сообщение для отправки клиенту. После этого соединение WebSocket между клиентом и сервером устанавливается, и обе стороны могут свободно передавать информацию по этому каналу соединения. Это соединение будет сохраняться до тех пор, пока клиент или сервер активно не закроет его.

HTML и JavaScript на стороне клиента

В настоящее время большинство браузеров поддерживают интерфейс WebSocket(). Вы можете попробовать пример в следующих браузерах: Chrome, Mozilla, Opera и Safari.

Содержимое файла example_websocket.html

<!DOCTYPE HTML>
<html>
   <head>
   <meta charset="utf-8">
   <title>Example(example.com)</title>
    
      <script type="text/javascript">
         function WebSocketTest()
         {
            if ("WebSocket" in window)
            {
               alert("您的浏览器支持 WebSocket!");
               
               // 打开一个 web socket
               var ws = new WebSocket("ws://localhost:9998/echo");
                
               ws.onopen = function()
               {
                  // Web Socket 已连接上,使用 send() 方法发送数据
                  ws.send("发送数据");
                  alert("数据发送中...");
               };
                
               ws.onmessage = function (evt) 
               { 
                  var received_msg = evt.data;
                  alert("数据已接收...");
               };
                
               ws.onclose = function()
               { 
                  // 关闭 websocket
                  alert("连接已关闭..."); 
               };
            }
            
            else
            {
               // 浏览器不支持 WebSocket
               alert("您的浏览器不支持 WebSocket!");
            }
         }
      </script>
        
   </head>
   <body>
   
      <div id="sse">
         <a href="WebSocketTest().html">运行 WebSocket</a>
      </div>
      
   </body>
</html>

Установка pywebsocket

Перед запуском вышеуказанной программы нам нужно создать сервис, поддерживающий WebSocket. С сайтаpywebsocketскачайте mod_pywebsocket или используйте команду git для загрузки:

git clone https://github.com/googlearchive/pywebsocket
<p>
mod_pywebsocket  需要 python 环境支持</p>
mod_pywebsocket 是一个 Apache HTTP 的 Web Socket扩展,安装步骤如下:</p>

<ul>
<li><p>解压下载的文件。</p></li>
<li><p>进入 <b>pywebsocket</b> 目录。</p></li>
<li><p>执行命令:</p>
<pre>$ python setup.py build
$ sudo python setup.py install
  • Просмотр документации:

    $ pydoc mod_pywebsocket
  • Запустите сервис

    В каталогеpywebsocket/mod_pywebsocketвыполните следующую команду:

    $ sudo python standalone.py -p 9998 -w ../example/
    

    Приведённая выше команда запустит сервис с номером порта 9998, используя -w для указания каталога, в котором находится обработчик echo_wsh.py.

    Теперь мы можем открыть ранее созданный файл example_websocket.html в браузере Chrome. Если ваш браузер поддерживает WebSocket(), нажмите "Запустить WebSocket", и вы увидите всплывающие окна для каждого шага всего процесса. GIF-демонстрация процесса:

    После остановки сервиса появится всплывающее сообщение "Connection closed...".

    Другие расширения