WebSocket HTML5

WebSocket est un protocole que HTML5 a commencé à fournir pour la communication en duplex intégral sur une seule connexion TCP.

WebSocket simplifie l'échange de données entre le client et le serveur, ce qui permet au serveur de pousser activement des données vers le client. Dans l'API WebSocket, le navigateur et le serveur n'ont besoin que de réaliser une seule poignée de main, après quoi ils peuvent directement créer une connexion persistante et effectuer une transmission de données bidirectionnelle.

Dans l'API WebSocket, le navigateur et le serveur n'ont besoin que d'effectuer une action de poignée de main, puis un canal rapide est formé entre le navigateur et le serveur. Les deux peuvent ensuite directement transmettre des données l'un à l'autre.

De nos jours, de nombreux sites web utilisent l'interrogation Ajax pour mettre en œuvre la technologie push. L'interrogation consiste, pour le navigateur, à envoyer des requêtes HTTP au serveur à des intervalles de temps spécifiques (par exemple, toutes les 1 seconde), puis le serveur renvoie les dernières données au navigateur du client. Ce modèle traditionnel présente des inconvénients évidents : le navigateur doit envoyer en continu des requêtes au serveur. Cependant, les requêtes HTTP peuvent contenir de longs en-têtes, et les données réellement valides peuvent ne représenter qu'une très petite partie, ce qui gaspille clairement beaucoup de bande passante et d'autres ressources.

Le protocole WebSocket défini par HTML5 permet de mieux économiser les ressources du serveur et la bande passante, et de communiquer davantage en temps réel.

Le navigateur envoie une requête pour établir une connexion WebSocket au serveur via JavaScript. Une fois la connexion établie, le client et le serveur peuvent directement échanger des données via la connexion TCP.

Lorsque vous obtenez une connexion WebSocket, vous pouvez utiliser la méthodesend()pour envoyer des données au serveur, et utiliser l'événementonmessagepour recevoir les données renvoyées par le serveur.

L'API suivante est utilisée pour créer un objet WebSocket.

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

Dans le code ci-dessus, le premier paramètre url spécifie l'URL de la connexion. Le second paramètre protocol est facultatif et spécifie les sous-protocoles acceptables.


Propriétés WebSocket

Les éléments suivants sont les propriétés de l'objet WebSocket. Supposons que nous ayons créé l'objet Socket à l'aide du code ci-dessus :

Propriété Description
Socket.readyState

Attribut en lecture seulereadyStateIndique l'état de la connexion, qui peut prendre les valeurs suivantes :

  • 0 - Indique que la connexion n'a pas encore été établie.

  • 1 - Indique que la connexion a été établie et que la communication est possible.

  • 2 - Indique que la connexion est en cours de fermeture.

  • 3 - Indique que la connexion a été fermée ou n'a pas pu être ouverte.

Socket.bufferedAmount

Attribut en lecture seulebufferedAmountLe nombre d'octets de texte UTF-8 qui ont été placés dans la file d'attente pour transmission par send() mais qui n'ont pas encore été envoyés.


Événements WebSocket

Les éléments suivants sont les événements associés à l'objet WebSocket. Supposons que nous ayons créé l'objet Socket à l'aide du code ci-dessus :

Événement Gestionnaire d'événements Description
open Socket.onopen Déclenché lorsque la connexion est établie
message Socket.onmessage Déclenché lorsque le client reçoit des données du serveur
error Socket.onerror Déclenché lorsqu'une erreur de communication se produit
close Socket.onclose Déclenché lorsque la connexion est fermée

Méthodes WebSocket

Voici les méthodes associées à l'objet WebSocket. Supposons que nous ayons créé l'objet Socket à l'aide du code ci-dessus :

Méthode Description
Socket.send()

Envoyer des données à l'aide de la connexion

Socket.close()

Fermer la connexion


Exemples WebSocket

Le protocole WebSocket est essentiellement un protocole basé sur TCP.

Pour établir une connexion WebSocket, le navigateur client doit d'abord initier une requête HTTP vers le serveur. Cette requête est différente d'une requête HTTP classique et contient des informations d'en-tête supplémentaires. L'en-tête supplémentaire "Upgrade: WebSocket" indique qu'il s'agit d'une requête HTTP demandant une mise à niveau de protocole. Le serveur analyse ces informations d'en-tête supplémentaires et génère un message de réponse à renvoyer au client. La connexion WebSocket entre le client et le serveur est alors établie, et les deux parties peuvent librement échanger des informations via ce canal de connexion. Cette connexion persistera jusqu'à ce que le client ou le serveur ferme activement la connexion.

HTML et JavaScript côté client

Actuellement, la plupart des navigateurs prennent en charge l'interface WebSocket(). Vous pouvez essayer l'exemple dans les navigateurs suivants : Chrome, Mozilla, Opera et Safari.

Contenu du fichier 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>

Installer pywebsocket

Avant d'exécuter le programme ci-dessus, nous devons créer un service qui prend en charge WebSocket. Depuispywebsocket, téléchargez mod_pywebsocket, ou utilisez la commande git pour télécharger :

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
  • Voir la documentation :

    $ pydoc mod_pywebsocket
  • Démarrer le service

    Danspywebsocket/mod_pywebsocket, exécutez la commande suivante dans le répertoire :

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

    La commande ci-dessus démarrera un service avec le numéro de port 9998, en utilisant -w pour définir le répertoire où se trouve le gestionnaire echo_wsh.py.

    Nous pouvons maintenant ouvrir le fichier example_websocket.html créé précédemment dans le navigateur Chrome. Si votre navigateur prend en charge WebSocket(), cliquez sur "Run WebSocket" et vous verrez des fenêtres pop-up pour chaque étape de l'ensemble du processus. Démonstration GIF du processus :

    Après l'arrêt du service, "Connection closed..." s'affichera.

    Autres extensions