Introduction détaillée au push du serveur HTML5

Dans diverses applications d'architecture BS, on s'attend souvent à ce que le serveur puisse activement transmettre divers messages au client pour obtenir des notifications telles que des e-mails, des messages, des tâches à effectuer, etc.

Le problème avec l'architecture BS elle-même est que le serveur a toujours utilisé un mécanisme de questions-réponses. Cela signifie que si le client n'envoie pas activement de messages au serveur , le serveur n'a aucun moyen de savoir comment envoyer des messages au client.

Avec le développement de diverses technologies et standards tels que HTML et les navigateurs, différents moyens et méthodes ont été générés pour permettre au serveur de transmettre activement des messages. Il s'agit de : AJAX, Comet, ServerSent et WebSocket.

Cet article fournira une explication simple des différentes méthodes techniques mentionnées ci-dessus.

AJAX

Une page normale fonctionne comme ceci dans un navigateur :

L'utilisateur donne au navigateur une adresse à laquelle il doit accéder

Le navigateur accède au serveur en fonction de cette adresse et crée une connexion TCP (requête HTTP) avec le serveur

Le serveur construit un morceau de texte HTML basé sur cette adresse et d'autres données, qui seront écrit dans la connexion TCP, puis fermez la connexion

Le navigateur récupère le texte HTML du serveur, l'analyse et le présente au navigateur pour que l'utilisateur puisse le parcourir

À ce moment, le l'utilisateur clique sur n'importe quel 3499910bf9dac5ae3c52d5ede7383485 sur le site Web. Ou lorsqu'un ff9c23ada1bcecdd1a0fb5d5a0f18437 est déclenché pour soumettre :

Le navigateur utilise les paramètres du formulaire ou les paramètres d'un comme adresse d'accès

créer une connexion TCP avec le serveur

serveur Formulaire du texte HTML, puis fermer la connexion

Le navigateur détruit la page actuellement affichée et présente une nouvelle page à l'utilisateur selon le nouveau texte HTML

Ce que l'on peut facilement constater, c'est qu'au milieu de tout le processus, une fois la connexion établie, la page ne peut plus être maintenue. L'ensemble du processus semble un peu énergique. Peut-être que je veux juste un nouveau Coca, mais vous insistez pour me donner le paquet complet.

À ce stade, nous pouvons jeter un œil au composant XmlHttpRequest. Ce composant nous permet de créer manuellement une requête HTTP et d'envoyer les données souhaitées. Le serveur ne peut également renvoyer que les résultats souhaités. c'est que lorsque nous recevons la réponse du serveur, la page originale n'est pas détruite. C'est comme si j'avais crié "J'ai fini mon café, je veux en avoir à nouveau", et ensuite le serveur m'a apporté une tasse de café au lieu de jeter tous les plats inachevés.

Lorsque nous utilisons AJAX pour implémenter le push du serveur, l'essentiel est que le client continue de demander au serveur "Y a-t-il un message pour moi ?", puis le serveur répond "oui" ou "non". . Sa méthode d'implémentation est également très simple. Il est également très pratique d'utiliser l'appel AJAX encapsulé par le framework jQuery :

function getMessage(fn) {
    $.ajax({
        url: "Handler.ashx", //一个能够提供消息的页面
        dataType: "text",    //响应类型，可以是JSON，XML等其它类型
        type: "get",         //HTTP请求类型，还可以是post
        success: function (d, s) {
            fn(d);           //得到了正常的响应时，利用回调函数通知外部        },
        complete: function (x, s) {
            setTimeout(function () {
                getMessage(fn);
            }, 5000);       //无论响应成功或失败，在若干秒后再询问一次服务器        }
    });
}

Grâce au code ci-dessus, vous pouvez demander au serveur toutes les 5 secondes s'il y en a. message qui doit être traité.Cette méthode peut obtenir l'effet de push, mais il y aura un problème :

Plus l'intervalle est rapide, meilleure est la rapidité du push et plus la consommation du serveur est importante ;

Plus l'intervalle est lent, plus la rapidité du push est faible, plus la consommation du serveur est faible.

À proprement parler, cette méthode actuelle n'est pas un véritable serveur qui envoie activement des messages, mais en raison du manque de moyens techniques précoces, le round robin AJAX est devenu une méthode très courante.

Ce qui suit est une description détaillée des spécifications des événements push du serveur.

Spécification

La spécification des événements envoyés par le serveur fait partie intégrante de la spécification HTML 5. Pour les documents de spécification spécifiques, voir les ressources de référence. La spécification est relativement simple et se compose principalement de deux parties : la première partie est le protocole de communication entre le côté serveur et le côté navigateur, et la deuxième partie est l'EventSource qui peut être utilisé par JavaScript sur le navigateur. côté objet. Le protocole de communication est un protocole simple basé sur du texte brut. Le type de contenu de la réponse côté serveur est « text/event-stream ». Le contenu du texte de réponse peut être visualisé comme un flux d'événements, composé de différents événements. Chaque événement se compose de deux parties : le type et les données, et chaque événement peut avoir un identifiant facultatif. Le contenu des différents événements est séparé par une ligne vierge (« rn ») contenant uniquement des caractères de retour chariot et de saut de ligne. Les données de chaque événement peuvent être constituées de plusieurs lignes. La liste de codes 1 donne un exemple de réponse côté serveur.

Exemple de réponse côté serveur

data: first event

data: second event
id: 100

event: myevent
data: third event
id: 101

: this is a comment
data: fourth event
data: fourth event continue

Comme indiqué dans le listing de codes 1, chaque événement est séparé par un ligne vierge à séparer. Pour chaque ligne, les deux points (":") avant indiquent le type de la ligne et les deux points après indiquent la valeur correspondante. Les types possibles incluent :

1. Le type est vide, indiquant que la ligne est un commentaire et sera ignorée lors du traitement. Le type

2. est data, indiquant que la ligne contient des données. Les lignes commençant par data peuvent apparaître plusieurs fois. Toutes ces lignes sont des données pour cet événement. Le type de

3. est event, indiquant le type d'événement utilisé dans cette ligne. Lorsque le navigateur reçoit des données, il génère des événements du type correspondant.

4. est de type id, indiquant l'identifiant utilisé par cette ligne pour déclarer l'événement.

5. Le type est retry, ce qui signifie que cette ligne sert à déclarer le temps d'attente du navigateur avant de se reconnecter après la déconnexion de la connexion.

Dans le code ci-dessus, le premier événement contient uniquement la donnée « premier événement » et un événement par défaut sera généré ; l'identifiant du deuxième événement est 100 et la donnée est « deuxième » ; event " ; Le troisième événement générera un événement de type "myevent" ; les données du dernier événement sont "quatrième événementnquatrième événement continuer". Lorsqu'il existe plusieurs lignes de données, les données réelles sont formées en concaténant chaque ligne de données avec des caractères de nouvelle ligne.

Si les données renvoyées par le serveur contiennent un identifiant d'événement, le navigateur enregistrera l'identifiant du dernier événement reçu. Si la connexion au serveur est interrompue, lorsque le navigateur se reconnectera, l'identifiant du dernier événement reçu sera déclaré via l'entête HTTP "Last-Event-ID". Le côté serveur peut déterminer à partir de quel événement démarrer pour poursuivre la connexion grâce à l'identifiant d'événement envoyé par le côté navigateur.

Pour la réponse renvoyée par le serveur, le navigateur doit utiliser l'objet EventSource en JavaScript pour la traiter. EventSource utilise la méthode d'écoute d'événement standard. Il vous suffit d'ajouter la méthode de traitement d'événement correspondante sur l'objet. EventSource fournit trois événements standard, comme indiqué dans le tableau 1.

Tableau 1. Événements standards fournis par l'objet EventSource

tr> tr>

名称	说明	事件处理方法
open	当成功与服务器建立连接时产生	onopen
message	当收到服务器发送的事件时产生	onmessage
error	当出现错误时产生	onerror

Name

Description

Méthode de gestion des événements

ouvrir

Produit lorsqu'une connexion au serveur est établie avec succès

onopen

message

Produit lors de la réception d'un événement envoyé par le serveur

onmessage

erreur

Produit lorsqu'une erreur se produit

onerror

如之前所述，服务器端可以返回自定义类型的事件。对于这些事件，可以使用 addEventListener 方法来添加相应的事件处理方法。代码清单 2 给出了 EventSource 对象的使用示例。

EventSource 对象的使用示例

var es = new EventSource('events');
es.onmessage = function(e) {
    console.log(e.data);
};

es.addEventListener('myevent', function(e) {
    console.log(e.data);
});

如上所示，在指定 URL 创建出 EventSource 对象之后，可以通过 onmessage 和 addEventListener 方法来添加事件处理方法。当服务器端有新的事件产生，相应的事件处理方法会被调用。EventSource 对象的 onmessage 属性的作用类似于 addEventListener( ‘ message ’ )，不过 onmessage 属性只支持一个事件处理方法。在介绍完服务器推送事件的规范内容之后，下面介绍服务器端的实现。

服务器端和浏览器端实现

从上一节中对通讯协议的描述可以看出，服务器端推送事件是一个比较简单的协议。服务器端的实现也相对比较简单，只需要按照协议规定的格式，返回响应内容即可。在开源社区可以找到各种不同的服务器端技术相对应的实现。自己开发的难度也不大。本文使用 Java 作为服务器端的实现语言。相应的实现基于开源的 jetty-eventsource-servlet 项目，见参考资源。下面通过一个具体的示例来说明如何使用 jetty-eventsource-servlet 项目。示例用来模拟一个物体在某个限定空间中的随机移动。该物体从一个随机位置开始，然后从上、下、左和右四个方向中随机选择一个方向，并在该方向上移动随机的距离。服务器端不断改变该物体的位置，并把位置信息推送给浏览器，由浏览器来显示。

服务器端实现

服务器端的实现由两部分组成：一部分是用来产生数据的 org.eclipse.jetty.servlets.EventSource 接口的实现，另一部分是作为浏览器访问端点的继承自 org.eclipse.jetty.servlets.EventSourceServlet 类的 servlet 实现。下面代码给出了 EventSource 接口的实现类。

EventSource 接口的实现类 MovementEventSource

 public class MovementEventSource implements EventSource {
 
 private int width = 800;
 private int height = 600;
 private int stepMax = 5;
 private int x = 0;
 private int y = 0;
 private Random random = new Random();
 private Logger logger = Logger.getLogger(getClass().getName());
 
 public MovementEventSource(int width, int height, int stepMax) {
  this.width = width;
  this.height = height;
  this.stepMax = stepMax;
  this.x = random.nextInt(width);
  this.y = random.nextInt(height);
 }

 @Override
 public void onOpen(Emitter emitter) throws IOException {
  query(emitter); //开始生成位置信息
 }

 @Override
 public void onResume(Emitter emitter, String lastEventId)
   throws IOException {
  updatePosition(lastEventId); //更新起始位置
  query(emitter);  //开始生成位置信息
 }
 
 //根据Last-Event-Id来更新起始位置
 private void updatePosition(String id) {
  if (id != null) {
   String[] pos = id.split(",");
   if (pos.length > 1) {
    int xPos = -1, yPos = -1;
    try {
     xPos = Integer.parseInt(pos[0], 10);
     yPos = Integer.parseInt(pos[1], 10);
    } catch (NumberFormatException e) {
     
    }
    if (isValidMove(xPos, yPos)) {
     x = xPos;
     y = yPos;
    }
   }
  }
 }
 
 private void query(Emitter emitter) throws IOException {
  emitter.comment("Start sending movement information.");
  while(true) {
   emitter.comment("");
   move(); //移动位置
   String id = String.format("%s,%s", x, y);
   emitter.id(id); //根据位置生成事件标识符
   emitter.data(id); //发送位置信息数据
   try {
    Thread.sleep(2000);
   } catch (InterruptedException e) {
    logger.log(Level.WARNING, \
               "Movement query thread interrupted. Close the connection.", e);
    break;
   }
  }
  emitter.close(); //当循环终止时，关闭连接
 }

 @Override
 public void onClose() {
  
 }
 
 //获取下一个合法的移动位置
 private void move() {
  while (true) {
   int[] move = getMove();
   int xNext = x + move[0];
   int yNext = y + move[1];
   if (isValidMove(xNext, yNext)) {
    x = xNext;
    y = yNext;
    break;
   }
  }
 }

 //判断当前的移动位置是否合法
 private boolean isValidMove(int x, int y) {
  return x >= 0 && x <= width && y >=0 && y <= height;
 }
 
 //随机生成下一个移动位置
 private int[] getMove() {
  int[] xDir = new int[] {-1, 0, 1, 0};
  int[] yDir = new int[] {0, -1, 0, 1};
  int dir = random.nextInt(4);
  return new int[] {xDir[dir] * random.nextInt(stepMax), \
     yDir[dir] * random.nextInt(stepMax)};
 }
}

类 MovementEventSource 需要实现 EventSource 接口的 onOpen、onResume 和 onClose 方法，其中 onOpen 方法在浏览器端的连接打开的时候被调用，onResume 方法在浏览器端重新建立连接时被调用，onClose 方法则在浏览器关闭连接的时候被调用。onOpen 和 onResume 方法都有一个 EventSource.Emitter 接口类型的参数，可以用来发送数据。EventSource.Emitter 接口中包含的方法包括 data、event、comment、id 和 close 等，分别对应于通讯协议中各种不同类型的事件。而 onResume 方法还额外包含一个参数 lastEventId，表示通过 Last-Event-ID 头发送过来的最近一次事件的标识符。

MovementEventSource 类中事件生成的主要逻辑在 query 方法中。该方法中包含一个无限循环，每隔 2 秒钟改变一次位置，同时把更新之后的位置通过 EventSource.Emitter 接口的 data 方法发送给浏览器端。每个事件都有对应的标识符，而标识符的值就是位置本身。如果连接断开之后，浏览器重新进行连接，可以从上一次的位置开始继续移动该物体。

与 MovementEventSource 类对应的 servlet 实现比较简单，只需要继承自 EventSourceServlet 类并覆写 newEventSource 方法即可。在 newEventSource 方法的实现中，需要返回一个 MovementEventSource 类的对象，如下所示。每当浏览器端建立连接时，该 servlet 会创建一个新的 MovementEventSource 类的对象来处理该请求。

servlet 实现类 MovementServlet

 public class MovementServlet extends EventSourceServlet { 

 @Override 
 protected EventSource newEventSource(HttpServletRequest request, 
 String clientId) { 
 return new MovementEventSource(800, 600, 20); 
 } 
 }

在服务器端实现中，需要注意的是要添加相应的 servlet 过滤器支持。这是 jetty-eventsource-servlet 项目所依赖的 Jetty Continuations 框架的要求，否则的话会出现错误。添加过滤器的方式是在 web.xml 文件中添加代码如下所示的配置内容。

Jetty Continuations 所需 servlet 过滤器的配置

 <filter> 
    <filter-name>continuation</filter-name> 
    <filter-class>org.eclipse.jetty.continuation.ContinuationFilter</filter-class> 
 </filter> 
 <filter-mapping> 
    <filter-name>continuation</filter-name> 
    <url-pattern>/sse/*</url-pattern> 
 </filter-mapping>

浏览器端实现

浏览器端的实现也比较简单，只需要创建出 EventSource 对象，并添加相应的事件处理方法即可。下面代码给出了相应的实现。在页面中使用一个方块表示物体。当接收到新的事件时，根据事件数据中给出的坐标信息，更新方块在页面上的位置。

浏览器端的实现代码

 var es = new EventSource('sse/movement'); 
 es.addEventListener('message', function(e) { 
     var pos = e.data.split(','), x = pos[0], y = pos[1]; 
     $('#box').css({ 
         left : x + 'px', 
         top : y + 'px' 
         }); 
     });

在介绍完基本的服务器端和浏览器端实现之后，下面介绍比较重要的 IE 的支持。

IE 支持

使用浏览器原生的 EventSource 对象的一个比较大的问题是 IE 并不提供支持。为了在 IE 上提供同样的支持，一般有两种办法。第一种办法是在其他浏览器上使用原生 EventSource 对象，而在 IE 上则使用简易轮询或 COMET 技术来实现；另外一种做法是使用 polyfill 技术，即使用第三方提供的 JavaScript 库来屏蔽浏览器的不同。本文使用的是 polyfill 技术，只需要在页面中加载第三方 JavaScript 库即可。应用本身的浏览器端代码并不需要进行改动。一般推荐使用第二种做法，因为这样的话，在服务器端只需要使用一种实现技术即可。

在 IE 上提供类似原生 EventSource 对象的实现并不简单。理论上来说，只需要通过 XMLHttpRequest 对象来获取服务器端的响应内容，并通过文本解析，就可以提取出相应的事件，并触发对应的事件处理方法。不过问题在于 IE 上的 XMLHttpRequest 对象并不支持获取部分的响应内容。只有在响应完成之后，才能获取其内容。由于服务器端推送事件使用的是一个长连接。当连接一直处于打开状态时，通过 XMLHttpRequest 对象并不能获取响应的内容，也就无法触发对应的事件。更具体的来说，当 XMLHttpRequest 对象的 readyState 为 3（READYSTATE_INTERACTIVE）时，其 responseText 属性是无法获取的。

为了解决 IE 上 XMLHttpRequest 对象的问题，就需要使用 IE 8 中引入的 XDomainRequest 对象。XDomainRequest 对象的作用是发出跨域的 AJAX 请求。XDomainRequest 对象提供了 onprogress 事件。当 onprogress 事件发生时，可以通过 responseText 属性来获取到响应的部分内容。这是 XDomainRequest 对象和 XMLHttpRequest 对象的最大不同，也是使用 XDomainRequest 对象来实现类似原生 EventSource 对象的基础。在使用 XDomainRequest 对象打开与服务器端的连接之后，当服务器端有新的数据产生时，可以通过 XDomainRequest 对象的 onprogress 事件的处理方法来进行处理，对接收到的数据进行解析，根据数据的内容触发相应的事件。

不过由于 XDomainRequest 对象本来的目的是发出跨域 AJAX 请求，考虑到跨域访问的安全性问题，XDomainRequest 对象在使用时的限制也比较严格。这些限制会影响到其作为 EventSource 对象的实现方式。具体的限制和解决办法如下所示：

1. 服务器端的响应需要包含 Access-Control-Allow-Origin 头，用来声明允许从哪些域访问该 URL。“*”表示允许来自任何域的访问，不推荐使用该值。一般使用与当前应用相同的域，限制只允许来自当前域的访问。

2. XDomainRequest 对象发出的请求不能包含自定义的 HTTP 头，这就限制了不能使用 Last-Event-ID 头来声明浏览器端最近一次接收到的事件的标识符。只能通过 HTTP 请求的其他方式来传递该标识符，如 GET 请求的参数或 POST 请求的内容体。

3. XDomainRequest 对象的请求的内容类型（Content-Type）只能是“text/plain”。这就意味着，当使用 POST 请求时，服务器端使用的框架，如 servlet，不会对 POST 请求的内容进行自动解析，无法使用 HttpServletRequest 类的 getParameter 方法来获取 POST 请求的内容。只能在服务器端对原始的请求内容进行解析，获取到其中的参数的值。

4. XDomainRequest 对象发出的请求中不包含任何与用户认证相关的信息，包括 cookie 等。这就意味着，如果服务器端需要认证，则需要通过 HTTP 请求的其他方式来传递用户的认证信息，比如 session 的 ID 等。

由于 XDomainRequest 对象的这些限制，服务器端的实现也需要作出相应的改动。这些改动包括返回 Access-Control-Allow-Origin 头；对于浏览器端发送的“text/plain”类型的参数进行解析；处理请求中包含的用户认证相关的信息。

本文的示例使用的 polyfill 库是 GitHub 上的 Yaffle 开发的 EventSource 项目，具体的地址见参考资源。在使用该 polyfill 库，并对服务器端的实现进行修改之后，就可以在 IE 8 及以上的浏览器中使用服务器推送事件。如果需要支持 IE 7，则只能使用简易轮询或 COMET 技术。本文的示例代码见参考资源。

小结

Si vous devez transférer des données du serveur vers le navigateur, les technologies basées sur la norme de spécification HTML 5 qui peuvent être utilisées incluent WebSocket et les événements push du serveur. Les développeurs peuvent choisir la technologie appropriée en fonction des besoins spécifiques de leur application. Si vous avez simplement besoin de transmettre des données côté serveur, la spécification des événements de transmission du serveur est plus simple et plus facile à mettre en œuvre. Cet article fournit une introduction détaillée au contenu des spécifications des événements push du serveur, des implémentations côté serveur et côté navigateur, ainsi qu'une analyse détaillée de la façon de prendre en charge les navigateurs IE.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!