不使用 EventSource 的 POST 请求的 SSE(Server-Sent Events)

✨ 文章独立博客地址:https://blog.xez.cc/posts/f255ffad.html
✨ 本文在我的独立博客网页阅读更佳嗷~

最近在写一个类似于ChatGPT的流式输出的后端接口,查找资料以及控制台查看到这一类的开发都是使用的SSE。后端查资料一顿开搞,前端却犯了难…前端使用EventSource这个对象在MDN中的定义是只允许发送GET请求,而且还不能携带头部信息…后面查找资料发现可以这样使用,故翻译收藏起来了。

本文将解释如何使用 HTTP POST 请求从前端接收 SSEEventSource 不支持该请求。大多数文章和文档都会告诉您需要 GET 请求才能接收事件,但事实并非如此。大多数 HTTP 库都会隐藏用于从 axios 等服务器接收响应的较低级别步骤。我们需要一个库,允许我们根据收到的每个网络请求(又称每个 SSE 消息)构建自己的响应。

What is SSE?

SSE(Server-Sent Events)是一种基于 HTTP 协议的服务器推送技术,它允许服务器实时向客户端推送数据,而无需客户端定时轮询或发送请求。SSE 的主要特点包括:

  • 单向通信:SSE 是从服务器向客户端的单向通信,客户端不需要发送任何请求就可以接收到服务器的推送数据。
  • 实时性:SSE 的推送数据是实时的,客户端可以立即收到最新的数据。
  • 可靠性:SSE 是基于 HTTP 协议的,因此可以使用 HTTP 的可靠性机制,例如重试、重连和错误处理。

在 ChatGPT 的 AI 生成内容中,SSE 技术可以用来实时向客户端推送新生成的对话内容。当用户发起对话后,ChatGPT 会不断地生成新的对话内容,并通过 SSE 技术将新的内容实时地推送给客户端,从而实现实时对话的效果。

使用 SSE 技术的好处是能够节省客户端的网络带宽和服务器的资源,因为客户端不需要定时发送请求,而是等待服务器推送数据。此外,SSE 还具有实时性和可靠性的优势,可以保证客户端能够实时接收到最新的数据,而且在网络故障或其他错误时能够自动重试和重连。

在这里插入图片描述

How it works?

  1. 首先,我们将使用 fetchSSE 端点发出 POST 请求。该端点将设置为返回多条带有响应标头 ContentType: text/event-stream 的消息。
  const response = await fetch('/sse', {
    method: 'POST',
    headers: {
      'Content-Type': 'text/event-stream'
    },
    body: {
      "user_id": 123
    }
  })
  1. 创建一个 reader 实例以获取从服务器收到的每个网络请求。
// To recieve data as a string we use TextDecoderStream class in pipethrough
const reader = response.body.pipeThrough(new TextDecoderStream()).getReader()

// To receive data as byte array we call getReader() directrly
const reader = response.body.getReader();
  1. 创建一个循环以继续接收消息,直到触发完成信号为止。在此循环内,还可以使用 SSE 消息更新前端应用程序。
while (true) {
  const {value, done} = await reader.read();
  if (done) break;
  console.log('Received', value);
}
  1. 完整代码示例

从 POST 请求接收 SSE 消息的完整示例。

const response = await fetch('/sse', {
    method: 'POST',
    headers: {
      'Content-Type': 'text/event-stream'
    },
    body: {
      "user_id": 123
    }
  })
const reader = response.body.pipeThrough(new TextDecoderStream()).getReader()
while (true) {
  const {value, done} = await reader.read();
  if (done) break;
  console.log('Received', value);
}

用于完成设置循环的示例 Express 框架示例。

app.post('/completion', (req, res) => {
  res.setHeader('Cache-Control', 'no-cache')
  res.setHeader('Content-Type', 'text/event-stream')
  res.setHeader('Access-Control-Allow-Origin', '*')
  res.setHeader('Connection', 'keep-alive')
  res.flushHeaders() // flush the headers to establish SSE with client

  const response = openai.createCompletion({
    model: 'text-davinci-003',
    prompt: 'hello world',
    max_tokens: 100,
    temperature: 0,
    stream: true
  }, { responseType: 'stream' })

  response.then(resp => {
    resp.data.on('data', data => {
      const lines = data.toString().split('\n').filter(line => line.trim() !== '')
      for (const line of lines) {
        const message = line.replace(/^data: /, '')
        if (message === '[DONE]') {
          res.write('data: DONE\n\n')
          res.end()
          return
        }
        const parsed = JSON.parse(message)
        res.write(`data: ${parsed.choices[0].text}\n\n`)
      }
    })
  }).catch(err => {
    console.log(err)
  })
})
### Server-Sent Events (SSE) 使用指南 #### SSE简介 Server-Sent Events (SSE) 提供了一种简单、有效的机制用于服务器向浏览器或其他客户端推送实时更新。这种技术特别适合单向通信模式下的低延迟数据传输需求[^1]。 #### 主要特点 - **单一连接**:一旦建立,该连接可以保持开放状态直到再需要。 - **自动重连支持**:如果网络中断,浏览器会尝试重新连接到服务器。 - **事件驱动模型**:允许定义特定类型的事件监听器以便更灵活地处理同类型的数据流。 #### 实现流程概述 为了实现一个完整的SSE系统,在服务端需设置好HTTP响应头以告知客户端这是一个持续性的消息源;而在客户端则应利用`EventSource`对象订阅来自指定URL的消息流。 --- ### Go语言中的SSE实现案例 下面展示了一个基于Go语言构建的基础版SSE服务器: ```go package main import ( "fmt" "log" "net/http" ) func handler(w http.ResponseWriter, r *http.Request) { w.Header().Set("Content-Type", "text/event-stream") w.Header().Set("Cache-Control", "no-cache") w.Header().Set("Connection", "keep-alive") for i := 0; ; i++ { fmt.Fprintf(w, "data: Message %d\n\n", i) // Flush the buffer to send data immediately. if flusher, ok := w.(http.Flusher); ok { flusher.Flush() } time.Sleep(time.Second) } } func main() { http.HandleFunc("/events", handler) log.Fatal(http.ListenAndServe(":8080", nil)) } ``` 此段代码创建了一个简单的HTTP处理器函数 `handler()` ,它将持续断地每秒发送一条新消息给已连接上的所有客户端。 --- ### Spring Boot框架下SSE的应用实例 对于采用Java开发的企业级应用程序来说,Spring Boot提供了便捷的方式来集成SSE特性。这里给出一段简化后的配置方法: ```java @RestController public class SseController { private final List<SseEmitter> emitters = new CopyOnWriteArrayList<>(); @GetMapping(value="/register", produces="text/event-stream") public SseEmitter register() throws IOException{ SseEmitter emitter = new SseEmitter(); this.emitters.add(emitter); emitter.onCompletion(() -> this.emitters.remove(emitter)); emitter.onError((e)->this.emitters.remove(emitter)); return emitter; } @PostMapping("/send/{message}") public void sendMessage(@PathVariable String message){ for(SseEmitter emitter : this.emitters){ try { emitter.send(message); } catch(Exception e){} } } } ``` 这段程序片段实现了两个主要的功能点——一是接受新的SSE注册请求并将对应的发射器保存起来等待后续操作;二是提供接口让其他组件可以通过POST请求触发广播消息至所有在线的客户端[^2]。 ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值