SSE(Server Sent Events) HTTP服务端推送详解

所谓的SSE(Sever-Sent Event),就是浏览器向服务器发送了一个HTTP请求,保持长连接,服务器不断单向地向浏览器推送“信息”,这么做是为了节省网络资源,不用一直发请求,建立新连接。

  • 优点:SSE和WebSocket相比,最大的优势是便利,服务端不需要第三方组件,开发难度低,SSE和轮询相比它不用处理很多请求,不用每次建立新连接,延迟低。
  • 缺点:如果客户端有很多需要保持很多长连接,这回占用大量内存和连接数。

数据格式

客户端实现

if(typeof(EventSource)!=="undefined") {   //判断是否支持EventSource
      var source = new EventSource('push'); //为http://localhost:8080/sse/push
      source.addEventListener('message', function (e) {
      }
      source.addEventListener('open', function (e) {
      }
      source.addEventListener('error', function (e) {
      }
}

支持默认3种事件,连接一旦建立就会触发open事件,客户端收到服务器发来的数据,就会触发message事件,如果发生通讯错误(如断开连接)就会触发error事件。

默认情况,服务器发来的数据,总是触发message事件,开发者也可以自定义SSE事件,这种情况下,发送回来的数据不会触发message事件。

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

上面的例子中使用foo事件监听。

服务器实现

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

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

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

[field]: value\n

上面的field可以取四个值。

data   //数据项
event //事件项 默认message
id //数据标识符用id字段表示,相当于每一条数据的编号
retry //重连时间

此外,还可以有冒号开头的行,表示注释。通常,服务器每隔一段时间就会向浏览器发送一个注释,保持连接不中断。

: This is a comment

一般发送格式:

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

问题

我们来看一下《颠覆者》中的例子:

@ResponseBody
public String push() {
  Random r = new Random();
  try {
      Thread.sleep(5000L);
  } cache(Exception e) {
      e.printStackTrace();  
    }
    return "data:Testing 1,2,3" + r.nextInt()+"\n\n";
}

问题1:长连接?

这里return之后连接就中断了,怎么反复推送消息?

图1:连接不断地被打开关闭
图2:请求一直再重复发送

问题描述:
我们可以看到每个请求只返回了一次数据,服务器每次发完数据就断开了连接,但SSE默认会自动重连,所以客户端不断地重连(重新发送请求),但这样就类似ajax长轮询,并不减少网络资源占用。

SSE 浏览器默认如果3秒内没有发送任何信息,则开始重连。服务器端可以用retry参数信息,指定通信的最大间隔时间

改进方案:
我们发送消息时,不用return,因为一旦return 连接就断开了,我们应该把数据写入到response中,并用flush方法输出。

 @RequestMapping(value = "/pushImprove")
    @ResponseBody
    public String getStreamDataImprove(HttpServletResponse httpServletResponse) {
        httpServletResponse.setContentType("text/event-stream");
        httpServletResponse.setCharacterEncoding("utf-8");
        String s= "retry:10000\n";
        s += "data:Testing 1,2,3------- "+new Date() +"\n\n";
        while (true) {
            try {
                PrintWriter pw=httpServletResponse.getWriter();
                Thread.sleep(100L);
                pw.write(s);
                pw.flush();
            } catch (IOException | InterruptedException e) {
                e.printStackTrace();
            }
        }
    }

实验结果


图3:连接只打开了一次
图4:请求也只出现了一次

这样就实现了客户端只发送一次请求,服务器不断地单向推送消息,保持长连接。


问题二:如何跳出循环

我们写了while(true)让它保持连接,不停地推送数据,但是浏览器关闭了却没有抛出异常,这里很奇怪为什么连接关闭了还能执行flush方法?这样的话浏览器关闭了,服务器却仍在执行while循环,这种情况显然是不允许的。

问题解决:
查阅了PrintWriter源码后发现,在flush方法中已经对异常做了处理,所以调用时不会抛出异常,我们要检测异常可以调用它的checkError()函数。

 public void flush() {
        try {
            synchronized (lock) {
                ensureOpen();
                out.flush();
            }
        }
        catch (IOException x) {
            trouble = true;
        }
    }

我们关闭浏览器后,服务器下一次要推送时就会抛出异常,这个异常已经在PrintWriter的flush()中被捕捉了,我们只需它的调用checkError(),有错误的话return即可停止执行。

 if(pw.checkError()){
       log.println("客户端断开连接");
       return;
  }

实验结果:


图5:关闭浏览器连接断开

可以看到浏览器关闭了以后,服务器也跳出了这个循环

如果客户端想在不关闭页面的情况下主动关闭连接,只需要设置一个按钮,点击以后调用EventSource.colse()即可关闭连接,服务端推送数据时因为连接已经关闭,就会抛出异常,跳出循环。


问题三:兼容性

SSE并没有在微软的IE和Edge浏览器上实现,可以使用第三方javaScript库实现,在页面引入evensource.js就可以实现。
evensource.js下载地址:
https://github.com/EventSource/eventsource

SSE完整源码

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,185评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,445评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,684评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,564评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,681评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,874评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,025评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,761评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,217评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,545评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,694评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,351评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,988评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,778评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,007评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,427评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,580评论 2 349

推荐阅读更多精彩内容