后端主动向前端推送消息 Server-Sent Events

后端主动向前端推送消息 Server-Sent Events

后端向前端推送消息的常见方式有 websocket、轮询等方式。还有一种方式:Server-Sent Event (简称SSE)。

SSE本质

 严格说,HTTP 协议无法做到服务器主动推送消息。但是,有一种变通方法,就是服务器向客户端声明,接下来要发送的是流消息(streaming)。

也就是说,发送的不是一次性的数据包,而是一个数据流,会连续不断地发送过来。这时,客户端不会关闭连接,会一直等着服务器发送新的数据流,视频播放就是这样的例子。本质上,这种通信就是以流信息的方式,完成一次用时很长的下载。

SSE 就是利用这种机制,使用流消息向浏览器推送信息,它基于 HTTP 协议。

 SSE特点

SSE 与 WebSocket 作用相似,都是建立浏览器与服务器之间的通信渠道,然后服务器向浏览器推送消息。

SSE 是单向通道,只能服务器向浏览器发送,因为流信息本质上就是下载。

SSE的优点如下:

SSE 使用 HTTP 协议;WebSocket 是一个独立协议。

SSE 属于轻量级,使用简单;WebSocket 协议相对复杂。

SSE 默认支持断线重试;WebSocket 需要自己实现。

SSE 一般只用来传送文本,二进制数据需要编码后传送;WebSocket 默认支持传送二进制数据。

SSE 支持自定义发送的消息类型。

客户端

 SSE客户端 API 部署在 EventSource 对象上。

// SSE 的客户端 API 部署在 EventSource 对象上if('EventSource'in window) {

        // 浏览器支持 SSE    }

    // 使用 SSE 时,浏览器首先生成一个 EventSource 实例,向服务器发起连接varurl = "http://127.0.0.1:8080/subscribe";

    /* 上面的 url 可以与当前网址同域,也可以跨域。

    * 跨域时,可以指定第二个参数,打开 withCredentials 属性,表示是否一起发送cookie

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

    */varsource =new EventSource(url);

    // 连接一旦建立,就会触发 open 事件,可以在 onopen 属性定义回调函数source.onopen =function (event) {

        // ...    };

    // 客户端收到服务器发来的数据,就会触发 message 事件,可以在 onmessage 属性定义回调函数source.onmessage =function (event) {

        // data 就是服务器传回的数据(文本格式)vardata = event.data;

        // handle message    };

    // 如果发生通信错误(比如连接中断),就会触发 error 事件,可以在 onerror 属性定义回调函数source.onerror =function (event) {

        // handle error event    };

    // 其中 close 方法用于关闭 SSE 连接// source.close();

上述代码示例了 EventSource 建立监理,监听消息,异常等情况的处理方式。

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

source.addEventListener('foo',function (event) {

        vardata = event.data;

        // handle message},false);

上面是自定义事件的实例代码。

服务端

服务端用 Java 编写,采用 SpringBoot 框架,其中 SpringBoot 采用内置的 SseEmitter 对象支持 SSE。

@GetMapping("/subscribe")

    public SseEmitter subscribe() {

        // 设置超时时间为5分钟SseEmitter sseEmitter =newSseEmitter(5*60*1000L);

        // 直接返回 SseEmitter 对象就可以和客户端连接return sseEmitter;

    }

 客户端请求上面的接口之后就可以建立连接。如果要往客户端发送消息,只需要调用 SseEmitter 实例的 send 方法。

// 调用 SseEmitter 的 send 方法即可往客户端发送消息try {

            sseEmitter.send("hello");

        } catch (IOException e) {

            e.printStackTrace();

        }

实际运用时,可以将用户 id 和 SseEmitter 实例存在 Map 中,当需要给某个用户推送消息时,先通过用户 id 查找到其对应的 SseEmitter 实例,然后调用 send 方法,即可以给对应的用户推送消息。 

 如果服务端要断开连接,调用 SseEmitter 的 complete 方法即可。

小结

客户端 js 的代码中核心类是 EventSource,其包括建立连接、接收消息、异常处理时触发的事件。客户端 SpringBoot 框架中核心类是 SseEmitter 其中记录连接的信息,调用其 send 方法就可以向客户端推送消息。


参考:

本文内容大多参考以下文章,非原创。

http://www.ruanyifeng.com/blog/2017/05/server-sent_events.html

https://www.cnblogs.com/yihuihui/p/12622729.html

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

推荐阅读更多精彩内容