go vue Server-Send Event(SSE) 示例

Server-Send Events

对于 web 应用来说,有时需要持续接受服务器发过来的数据,例如通知、处理进度等。此时 WebSockets 估计是第一个出现在脑海里的,但是其实有更简单轻便的方式——Server-Send Events(简称 SSE)。SSE 通过 http(s) 链接创建一个单向流。服务器端可以源源不断的向客户端推送数据,客户端意外断开后还可以自动重连,甚至设置重连间隔。

协议格式

Snipaste_2020-04-27_22-04-51.png

SSE 是个纯文本协议,格式表现在服务器端的推送数据上。数据分为四部分 data, event, id, retry。

data: something happend!\n\n

第二个 \n 表示这个 event 结束,可以发给客户端了。第一个 \n 主要是为了有时要传输多行数据时,例如传个 json:

data: {\n
data: "foo": "bar"\n
data: }\n\n

上面都属于 message 这个类型,如果想发送别的类型可以通过 event 字段自定义:

event: close\n
data: play enough\n\n

注意任然需要带上 data 字段。

客户端代码(VUE)

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Server-Send Event</title>
</head>
<body>
    <div id="app">
        <button @click="create">Server-Send Event</button>
    </div>
    <script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
    <script>
        var app = new Vue({
            el: "#app",
            data: {
                page: 1,
                pageSize: 30,
                appId: 10003,
            },
            methods: {
                create: function() {
                    let url = 'http://localhost:8000/event?page='+this.page+'&pageSize='+this.pageSize+'&appId='+this.appId
                    let es = new EventSource(url);
                    es.addEventListener('message', event => {
                        console.log(event.data);
                    });
                    es.addEventListener('error', event => {
                        if (event.readyState == EventSource.CLOSED) {
                            console.log('event was closed');
                        };
                    });
                    es.addEventListener('close', event => {
                        console.log(event.type);
                        es.close();
                    });
                }
            },
        })
    </script>
</body>
<script>

</script>
</html>

客户端可以在 url 加上一些参数,但是如果想传大量参数,那就没什么直接的方法了,像 post 那样。只能另想方法,例如先发个 post 请求把数据发到服务器,再 SSE ,并通过 session 或别的将这两者关联。

服务器代码(go)

package main

import (
    "fmt"
    "log"
    "net/http"
    "time"
)

func handleSSE(w http.ResponseWriter, r *http.Request) {

    appId := r.URL.Query()["appId"]
    page := r.URL.Query()["page"]
    pageSize := r.URL.Query()["pageSize"]

    w.Header().Set("Content-Type", "text/event-stream")
    w.Header().Set("Cache-Control", "no-cache")
    w.Header().Set("Connection", "keep-alive")
    w.Header().Set("Access-Control-Allow-Origin", "*")

    flusher, ok := w.(http.Flusher)
    if !ok {
        log.Panic("server not support")
    }
    for i := 0; i < 10; i++ {
        time.Sleep(5*time.Second)
        fmt.Fprintf(w, "data: %d%s%s%s\n\n", i, appId[0], page[0], pageSize[0])
        flusher.Flush()
    }
    fmt.Fprintf(w, "event: close\ndata: close\n\n") // 一定要带上data,否则无效
}

func main() {
    http.Handle("/event", http.HandlerFunc(handleSSE))
    http.ListenAndServe(":8000", nil)
}

服务器端必须设置 Content-Type 为 text/event-stream 表明这是个 event 流。no-cache 主要是避免客户端读缓存,keep-alive 保持长链接。

参考

本文严重参考这个博客

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

推荐阅读更多精彩内容