Server-Sent Events

簡介

服務器向客戶端推送數據，有不少解決方案。除了「輪詢」 和 WebSocket，HTML 5 還提供了 Server-Sent Events（如下簡稱 SSE）。

通常來講，HTTP 協議只能客戶端向服務器發起請求，服務器不能主動向客戶端推送。可是有一種特殊狀況，就是服務器向客戶端聲明，接下來要發送的是流信息（streaming）。也就是說，發送的不是一次性的數據包，而是一個數據流，會接二連三地發送過來。這時，客戶端不會關閉鏈接，會一直等着服務器發過來的新的數據流。本質上，這種通訊就是以流信息的方式，完成一次用時很長的下載。

SSE 就是利用這種機制，使用流信息向瀏覽器推送信息。它基於 HTTP 協議，目前除了 IE/Edge，其餘瀏覽器都支持。

與 WebSocket 的比較

SSE 與 WebSocket 做用類似，都是創建瀏覽器與服務器之間的通訊渠道，而後服務器向瀏覽器推送信息。

整體來講，WebSocket 更強大和靈活。由於它是全雙工通道，能夠雙向通訊；SSE 是單向通道，只能服務器向瀏覽器發送，由於 streaming 本質上就是下載。若是瀏覽器向服務器發送信息，就變成了另外一次 HTTP 請求。

可是，SSE 也有本身的優勢。

• SSE 使用 HTTP 協議，現有的服務器軟件都支持。WebSocket 是一個獨立協議。
• SSE 屬於輕量級，使用簡單；WebSocket 協議相對複雜。
• SSE 默認支持斷線重連，WebSocket 須要本身實現。
• SSE 通常只用來傳送文本，二進制數據須要編碼後傳送，WebSocket 默認支持傳送二進制數據。
• SSE 支持自定義發送的消息類型。

所以，二者各有特色，適合不一樣的場合。

客戶端 API

EventSource 對象

SSE 的客戶端 API 部署在EventSource對象上。下面的代碼能夠檢測瀏覽器是否支持 SSE。

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

使用 SSE 時，瀏覽器首先生成一個EventSource實例，向服務器發起鏈接。

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>

運行效果