使用Python和Go实现服务器发送事件(SSE)

 更新时间:2024年11月25日 10:33:19   作者:关山月  
在当今的交互式web应用程序中,实时数据更新在增强用户体验方面起着至关重要的作用,在实时通信的各种技术中,SSE在众多解决方案脱颖而出,本文给大家介绍了使用Python和Go实现服务器发送事件(SSE),需要的朋友可以参考下

为什么选择SSE?

服务器发送事件是HTML5规范的一部分,专门用于将事件从服务器推送到客户端。它的简单性、自动重新连接和事件跟踪功能使其非常适合数据流的场景。在单向数据流情况下,SSE表现尤其出色。

概述

SSE是一种服务器向浏览器实时推送消息的技术。它是HTML5规范的一部分,主要涉及:

  • 通信协议:使用HTTP。
  • 事件对象:在浏览器端可用。

WebSockets也是一种实时通信技术,但它们有不同之处:

SSEWebSockets
基于HTTP基于TCP
单向(服务器到客户端)全双工(双向)
轻量级和简单更复杂的
内置重新连接和消息跟踪需要手动实现这些功能
文本或Base64和gzip压缩的二进制文件支持各种数据类型
支持自定义事件类型不支持自定义事件类型
HTTP/1.1或HTTP/2限制连接数量无限连接

服务器实现

协议实现

本质上,浏览器发起一个HTTP请求,服务器用HTTP状态进行响应,包括以下标头:

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

SSE指定事件流的MIME类型必须为 text/event-stream ,浏览器不应该缓存数据,并且连接应该是持久的( keep-alive )。

消息格式

事件流是使用UTF-8编码的文本或Base64编码的二进制消息,并使用gzip压缩。每条消息由一行或多行字段组成,格式为 field-name : field-value 。每个字段以 \n 结尾。以冒号开头的行是注释,会被浏览器忽略。每个推送可以由多个消息组成,以空行分隔( \n\n )。

关键字段包括:

  • event :事件类型。
  • id :事件ID,浏览器跟踪最后接收到的事件用来重新连接服务。
  • retry :浏览器在连接失败后重新尝试连接所需的等待时间(ms)。
  • data :消息数据。

示例:Python实现SSE

from flask import Flask, Response

app = Flask(__name__)


@app.route('/events')
def sse_handler():
    def generate():
        paragraph = [
            "Hello, this is an example of a continuous text output.",
            "It contains multiple sentences, each of which will be sent to the client as an event.",
            "This is to simulate the functionality of Server-Sent Events (SSE).",
            "We can use this method to push real-time updates.",
            "End of sample text, thank you!",
        ]

        for sentence in paragraph:
            yield f"data: {sentence}\n\n"

            import time
            time.sleep(1)

    return Response(generate(), mimetype='text/event-stream')


if __name__ == '__main__':
    app.run(host='0.0.0.0', port=8081, debug=True)

示例:Go实现SSE

package main

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

func main() {
    http.HandleFunc("/events", sseHandler)

    fmt.Println("Starting server on :8080")
    if err := http.ListenAndServe(":8080", nil); err != nil {
        log.Fatalf("Server error: %v", err)
    }
}

func sseHandler(w http.ResponseWriter, r *http.Request) {
    flusher, ok := w.(http.Flusher)
    if !ok {
        http.Error(w, "Streaming unsupported!", http.StatusInternalServerError)
        return
    }

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

    // Change the output here to a specific text
    paragraph := []string{
        "Hello, this is an example of a continuous text output.",
        "It contains multiple sentences, each of which will be sent to the client as an event.",
        "This is to simulate the functionality of Server-Sent Events (SSE).",
        "We can use this method to push real-time updates.",
        "End of sample text, thank you!",
    }

    for _, sentence := range paragraph {
        _, err := fmt.Fprintf(w, "data: %s\n\n", sentence)
        if err != nil {
            return
        }
        flusher.Flush()
        time.Sleep(1 * time.Second) // Wait 1 second before sending the next piece of text
    }
}

浏览器API️

在客户端,JavaScript的 EventSource API允许您创建一个 EventSource 对象来侦听服务器发送的事件。一旦连接上,服务器就可以向浏览器发送事件消息。浏览器通过监听 onmessageonopenonerror 事件来处理这些消息。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>SSE Example 🌟</title>
</head>
<body>
    <h1>Server-Sent Events Example 🚀</h1>
    <div id="messages"></div>
    <script>
        window.onload = function() {
            if (typeof(EventSource) !== "undefined") {
                const eventSource = new EventSource('/events');

                eventSource.onmessage = function(event) {
                    const newElement = document.createElement("p");
                    newElement.textContent = "Message: " + event.data;

                    document.getElementById("messages").appendChild(newElement);
                };

                eventSource.onerror = function(event) {
                    console.error("Error occurred: ", event);
                    const newElement = document.createElement("p");
                    newElement.textContent = "An error occurred while connecting to the event source.";
                    document.getElementById("messages").appendChild(newElement);
                    eventSource.close(); 
                };
            } else {
                document.getElementById("messages").textContent = "Sorry, your browser does not support server-sent events...";
            }
        };
    </script>
</body>
</html>

SSE调试

目前,许多流行的工具,如Postman、Insomnia、Bruno和ThunderClient缺乏对服务器发送事件SSE的足够支持。在开发过程中,这种限制会让人非常沮丧。幸运的是,我最近遇到了EchoAPI,这个工具提供了出色的SSE调试功能。这个发现极大地改善了我的工作流程,提高了效率和生产力。

如果您正在使用SSE或进行API调试,我强烈建议您尝试一下EchoAPI。它可以彻底改变您的调试体验并简化您的开发工作。

示例:SSE的EchoAPI客户端

在EchoAPI中,使用SSE接口非常简单。只需输入URL,填写相关参数,然后点击“发送”即可看到您的请求结果。

以上就是使用Python和Go实现服务器发送事件(SSE)的详细内容,更多关于Python Go服务器发送事件的资料请关注脚本之家其它相关文章!

相关文章

  • Python 变量类型详解

    Python 变量类型详解

    变量可以指定不同的数据类型,这些变量可以存储整数,小数或字符。这篇文章主要介绍了Python 变量类型详解,需要的朋友可以参考下
    2018-10-10
  • Python实现json对值进行模糊搜索的示例详解

    Python实现json对值进行模糊搜索的示例详解

    我经常使用json进行存储配置,于是常常遇到这样的问题:如果想要对某个数组里的值进行模糊搜索,同时输出相关的其他数组相同位置的的值该如何实现呢?本文就来和大家详细聊聊
    2023-01-01
  • Python PyPDF2模块安装使用解析

    Python PyPDF2模块安装使用解析

    这篇文章主要介绍了Python PyPDF2模块安装使用解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • django rest framework vue 实现用户登录详解

    django rest framework vue 实现用户登录详解

    这篇文章主要介绍了django rest framework vue 实现用户登录详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-07-07
  • Python Json读写操作之JsonPath用法详解

    Python Json读写操作之JsonPath用法详解

    JSONPath是一种信息抽取类库,是从JSON文档中抽取指定信息的工具,提供多种语言实现版本,包括Javascript、Python、PHP和Java,这篇文章主要介绍了Python Json读写操作之JsonPath用法详解,需要的朋友可以参考下
    2023-04-04
  • 基于python实现usb热插拔检测

    基于python实现usb热插拔检测

    这篇文章主要为大家详细介绍了如何使用Python实现用于在Linux系统中监测USB设备的热插拔,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-05-05
  • 一篇文章弄懂Python中的可迭代对象、迭代器和生成器

    一篇文章弄懂Python中的可迭代对象、迭代器和生成器

    这篇文章主要给大家介绍了关于Python中可迭代对象、迭代器和生成器的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Python具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-08-08
  • Python发送邮件测试报告操作实例详解

    Python发送邮件测试报告操作实例详解

    这篇文章主要介绍了Python发送邮件测试报告操作,结合实例形式较为详细的分析了Python邮件发送相关模块使用及操作注意事项,需要的朋友可以参考下
    2018-12-12
  • Python中is和==的区别详解

    Python中is和==的区别详解

    这篇文章主要介绍了Python中is和==的区别详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-11-11
  • 对TensorFlow的assign赋值用法详解

    对TensorFlow的assign赋值用法详解

    今天小编就为大家分享一篇对TensorFlow的assign赋值用法详解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07

最新评论