Server-Sent Events

时间  2019-11-12
标签 server sent events 繁體版
原文   原文链接

简介

服务器向客户端推送数据，有不少解决方案。除了“轮询” 和 WebSocket，HTML 5 还提供了 Server-Sent Events（如下简称 SSE）。javascript

通常来讲，HTTP 协议只能客户端向服务器发起请求，服务器不能主动向客户端推送。可是有一种特殊状况，就是服务器向客户端声明，接下来要发送的是流信息（streaming）。也就是说，发送的不是一次性的数据包，而是一个数据流，会接二连三地发送过来。这时，客户端不会关闭链接，会一直等着服务器发过来的新的数据流。本质上，这种通讯就是以流信息的方式，完成一次用时很长的下载。css

SSE 就是利用这种机制，使用流信息向浏览器推送信息。它基于 HTTP 协议，目前除了 IE/Edge，其余浏览器都支持。html

与 WebSocket 的比较

SSE 与 WebSocket 做用类似，都是创建浏览器与服务器之间的通讯渠道，而后服务器向浏览器推送信息。java

整体来讲，WebSocket 更强大和灵活。由于它是全双工通道，能够双向通讯；SSE 是单向通道，只能服务器向浏览器发送，由于 streaming 本质上就是下载。若是浏览器向服务器发送信息，就变成了另外一次 HTTP 请求。jquery

可是，SSE 也有本身的优势。web

  • SSE 使用 HTTP 协议，现有的服务器软件都支持。WebSocket 是一个独立协议。
  • SSE 属于轻量级，使用简单；WebSocket 协议相对复杂。
  • SSE 默认支持断线重连，WebSocket 须要本身实现。
  • SSE 通常只用来传送文本，二进制数据须要编码后传送，WebSocket 默认支持传送二进制数据。
  • SSE 支持自定义发送的消息类型。

所以，二者各有特色，适合不一样的场合。ajax

客户端 API

EventSource 对象

SSE 的客户端 API 部署在EventSource对象上。下面的代码能够检测浏览器是否支持 SSE。spring

if ('EventSource' in window) {
  // ...
}

使用 SSE 时，浏览器首先生成一个EventSource实例，向服务器发起链接。bootstrap

var source = new EventSource(url);

上面的url能够与当前网址同域，也能够跨域。跨域时，能够指定第二个参数，打开withCredentials属性，表示是否一块儿发送 Cookie。跨域

var source = new EventSource(url, { withCredentials: true });

readyState 属性

EventSource实例的readyState属性，代表链接的当前状态。该属性只读，能够取如下值。

  • 0：至关于常量EventSource.CONNECTING，表示链接还未创建，或者断线正在重连。
  • 1：至关于常量EventSource.OPEN，表示链接已经创建，能够接受数据。
  • 2：至关于常量EventSource.CLOSED，表示链接已断，且不会重连。
var source = new EventSource(url);
console.log(source.readyState);

url 属性

EventSource实例的url属性返回链接的网址，该属性只读。

withCredentials 属性

EventSource实例的withCredentials属性返回一个布尔值，表示当前实例是否开启 CORS 的withCredentials。该属性只读，默认是false。

onopen 属性

链接一旦创建，就会触发open事件，能够在onopen属性定义回调函数。

source.onopen = function (event) {
  // ...
};

// 另外一种写法
source.addEventListener('open', function (event) {
  // ...
}, false);

onmessage 属性

客户端收到服务器发来的数据，就会触发message事件，能够在onmessage属性定义回调函数。

source.onmessage = function (event) {
  var data = event.data;
  var origin = event.origin;
  var lastEventId = event.lastEventId;
  // handle message
};

// 另外一种写法
source.addEventListener('message', function (event) {
  var data = event.data;
  var origin = event.origin;
  var lastEventId = event.lastEventId;
  // handle message
}, false);

上面代码中，参数对象event有以下属性。

  • data：服务器端传回的数据（文本格式）。
  • origin： 服务器 URL 的域名部分，即协议、域名和端口，表示消息的来源。
  • astEventId：数据的编号，由服务器端发送。若是没有编号，这个属性为空。

onerror 属性

若是发生通讯错误（好比链接中断），就会触发error事件，能够在onerror属性定义回调函数。

source.onerror = function (event) {
  // handle error event
};

// 另外一种写法
source.addEventListener('error', function (event) {
  // handle error event
}, false);

自定义事件

默认状况下，服务器发来的数据，老是触发浏览器EventSource实例的message事件。开发者还能够自定义 SSE 事件，这种状况下，发送回来的数据不会触发message事件。

source.addEventListener('foo', function (event) {
  var data = event.data;
  var origin = event.origin;
  var lastEventId = event.lastEventId;
  // handle message
}, false);

上面代码中，浏览器对 SSE 的foo事件进行监听。如何实现服务器发送foo事件，请看下文。

close() 方法

close方法用于关闭 SSE 链接。

source.close();

服务器实现

数据格式

服务器向浏览器发送的 SSE 数据，必须是 UTF-8 编码的文本，具备以下的 HTTP 头信息。

Content-Type: text/event-stream
Cache-Control: no-cache
Connection: keep-alive

上面三行之中，第一行的Content-Type必须指定 MIME 类型为event-steam。

每一次发送的信息，由若干个message组成，每一个message之间用\n\n分隔。每一个message内部由若干行组成，每一行都是以下格式。

[field]: value\n

上面的field能够取四个值。

  • data
  • event
  • id
  • retry

此外，还能够有冒号开头的行，表示注释。一般，服务器每隔一段时间就会向浏览器发送一个注释，保持链接不中断。

: This is a comment

下面是一个例子。

: this is a test stream\n\n

data: some text\n\n

data: another message\n
data: with two lines \n\n

data 字段

数据内容用data字段表示。

data:  message\n\n

若是数据很长，能够分红多行，最后一行用\n\n结尾，前面行都用\n结尾。

data: begin message\n
data: continue message\n\n

下面是一个发送 JSON 数据的例子。

data: {\n
data: "foo": "bar",\n
data: "baz", 555\n
data: }\n\n

id 字段

数据标识符用id字段表示，至关于每一条数据的编号。

id: msg1\n
data: message\n\n

浏览器用lastEventId属性读取这个值。一旦链接断线，浏览器会发送一个 HTTP 头，里面包含一个特殊的Last-Event-ID头信息，将这个值发送回来，用来帮助服务器端重建链接。所以，这个头信息能够被视为一种同步机制。

event 字段

event字段表示自定义的事件类型，默认是message事件。浏览器能够用addEventListener()监听该事件。

event: foo\n
data: a foo event\n\n
data: an unnamed event\n\n
event: bar\n
data: a bar event\n\n

上面的代码创造了三条信息。第一条的名字是foo，触发浏览器的foo事件；第二条未取名，表示默认类型，触发浏览器的message事件；第三条是bar，触发浏览器的bar事件。

下面是另外一个例子。

event: userconnect
data: {"username": "bobby", "time": "02:33:48"}

event: usermessage
data: {"username": "bobby", "time": "02:34:11", "text": "Hi everyone."}

event: userdisconnect
data: {"username": "bobby", "time": "02:34:23"}

event: usermessage
data: {"username": "sean", "time": "02:34:36", "text": "Bye, bobby."}

retry 字段

服务器能够用retry字段，指定浏览器从新发起链接的时间间隔。

retry: 10000\n

两种状况会致使浏览器从新发起链接：一种是时间间隔到期，二是因为网络错误等缘由，致使链接出错。

Node 服务器实例

SSE 要求服务器与浏览器保持链接。对于不一样的服务器软件来讲，所消耗的资源是不同的。Apache 服务器，每一个链接就是一个线程，若是要维持大量链接，势必要消耗大量资源。Node 则是全部链接都使用同一个线程，所以消耗的资源会小得多，可是这要求每一个链接不能包含很耗时的操做，好比磁盘的 IO 读写。

下面是 Node 的 SSE 服务器实例

var http = require("http");

http.createServer(function (req, res) {
  var fileName = "." + req.url;

  if (fileName === "./stream") {
    res.writeHead(200, {
      "Content-Type":"text/event-stream",
      "Cache-Control":"no-cache",
      "Connection":"keep-alive",
      "Access-Control-Allow-Origin": '*',
    });
    res.write("retry: 10000\n");
    res.write("event: connecttime\n");
    res.write("data: " + (new Date()) + "\n\n");
    res.write("data: " + (new Date()) + "\n\n");

    interval = setInterval(function () {
      res.write("data: " + (new Date()) + "\n\n");
    }, 1000);

    req.connection.addListener("close", function () {
      clearInterval(interval);
    }, false);
  }
}).listen(8844, "127.0.0.1");

java服务器示例(本身尝试写的)

java (spring mvc)

package com.zhangjinbang.web;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller

public class ChatController {

	@RequestMapping("chat")
	public String chat(){
		return "chat";	
	}
	
	@RequestMapping("chat/sendMsg")
	public void getMsg(HttpServletRequest request,HttpServletResponse response) throws IOException, InterruptedException{
		
		response.setContentType("text/event-stream");
		response.setCharacterEncoding("UTF-8");
		response.setHeader( "Cache-Control", "no-cache" );
		response.setHeader( "Connection", "keep-alive" );
		 
		PrintWriter writer=response.getWriter();
		for(int i=0;i<100;i++){
			writer.write("data:"+System.currentTimeMillis()+"\n\n");
			writer.flush();
			Thread.sleep(1000);
		}
		writer.close();
		
	}
	
}

HTML(bootstrap)

<%@ page language="java" contentType="text/html; charset=utf-8"
	pageEncoding="utf-8"%>
<%@taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<%@taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="fn"%>

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport"
	content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<!-- 上述3个meta标签*必须*放在最前面，任何其余内容都*必须*跟随其后！ -->

<script type="text/javascript"
	src="<c:url value='/resources/js/jquery-3.2.0.min.js'/>"></script>
<script type="text/javascript"
	src="<c:url value='/resources/js/bootstrap.min.js'/>"></script>
<link rel="stylesheet"
	href="<c:url value='/resources/css/bootstrap.min.css'/>">
<link rel="stylesheet" href="<c:url value='/resources/css/style.css'/>">
<link rel="stylesheet" href="<c:url value='/resources/css/chat.css'/>">
<title>未命名-ASMR</title>
</head>
<body class="blackGray">
	<nav class="navbar navbar-inverse navbar-fixed-top">
		<ul class="nav navbar-nav">
			<li role="presentation"><a
				class="dropdown-toggle" data-toggle="dropdown" href="#"
				role="button" aria-haspopup="true" aria-expanded="false">
					slumber <span class="caret"></span>
			</a>
				<ul class="dropdown-menu">
					<c:forEach var="musicType"
						items="${applicationScope.musicTypeList}">
						<li role="presentation"><a
							href="<c:url value="/music/${musicType.id}"></c:url>"><span
								class="glyphicon glyphicon-music"></span> <c:out
									value="${musicType.name}" /></a></li>
					</c:forEach>
				</ul>
			<li role="presentation" class="active"><a href="<c:url value='/chat'/>">聊天</a></li>
			<li role="presentation"><a href="#">关于</a></li>
		</ul>
	</nav>
	<div class="container">
		
		
		<div class="panel panel-primary">
		  <div class="panel-heading">聊天</div>
		  <div class="panel-body">
		  	<h1>得到服务器更新</h1>
			<div id="result"></div>
		    
		  </div>
		  <div class="panel-footer">
		  	<input id="sendMsg" type="text" class="form-control" id="exampleInputEmail1" placeholder="说点什么">
		  </div>
		</div>
	
	</div>
	
	<!--版权信息-->
	<div class="container">
		<p class="text-center">www.zhangjinbang.com</p>
	</div>

<script>
	/*
	document.onkeyup = function (e) {//键盘事件监听回车键
    	var ev = e || event;
    	if(ev.keyCode == 13){
    		
    		$.ajax({
    			url:"/slumber/chat/"+$("#sendMsg").val()
    		})
    	}
    }
	*/
	if(typeof(EventSource)!=="undefined")
	  {
	  var source=new EventSource("/slumber/chat/sendMsg");
	  source.onmessage=function(event)
	    {
	    	document.getElementById("result").innerHTML+=event.data + "<br />";
	    };
	  }
	else
	  {
	       document.getElementById("result").innerHTML="抱歉，您的浏览器不支持 server-sent 事件 ...";
    
	  }
</script>
</body>
</html>

运行效果

输入图片说明

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程