1. 背景

在使用ChatGPT时，发现输入 prompt 后，页面是逐步给出回复的，起初以为使用了 WebSckets 持久化连接协议，查看其网络请求，发现这个接口的通信方式并非传统的 http 接口或者 WebSockets，而是基于 EventStream 的事件流，像打字机一样，一段一段的返回答案。

ChatGPT 是一个基于深度学习的大型语言模型，处理自然语言需要大量的计算资源和时间，响应速度肯定比普通的读数据库要慢的多，普通 http 接口等待时间过长，显然并不合适。对于这种单项对话场景，ChagtGPT 将先计算出的数据“推送”给用户，边计算边返回，避免用户因为等待时间过长关闭页面。而这，正式采用了 SSE 技术。

2. 简介

Server-Sent Events 服务器推送事件，简称 SSE，是一种服务端实时主动向浏览器推送消息的技术。SSE 是 HTML5 中一个与通信相关的 API，主要由两部分组成：服务端与浏览器端的通信协议（HTTP 协议）及浏览器端可供 JavaScript 使用的 EventSource 对象。

从“服务端主动向浏览器实时推送消息”这一点来看，该 API 与 WebSockets API 有一些相似之处。但是，该 API 与 WebSockers API 的不同之处在于：

3. 服务端实现

3.1 协议

SSE 协议非常简单，本质是浏览器发起 http 请求，服务器在收到请求后，返回状态与数据，并附带以下 headers：js Content-Type: text/event-stream Cache-Control: no-cache Connection: keep-alive– SSE API规定推送事件流的 MIME 类型为 text/event-stream。- 必须指定浏览器不缓存服务端发送的数据，以确保浏览器可以实时显示服务端发送的数据。- SSE 是一个一直保持开启的 TCP 连接，所以 Connection 为 keep-alive。

3.2 消息格式

EventStream（事件流）为 UTF-8 格式编码的文本或使用 Base64 编码和 gzip 压缩的二进制消息。每条消息由一行或多行字段（event、id、retry、data）组成，每个字段组成形式为：字段名:字段值。字段以行为单位，每行一个（即以 \n 结尾）。以冒号开头的行为注释行，会被浏览器忽略。每次推送，可由多个消息组成，每个消息之间以空行分隔（即最后一个字段以\n\n结尾）。

📢 注意：

• 除上述四个字段外，其他所有字段都会被忽略。
• 如果一行字段中不包含冒号，则整行文本将被视为字段名，字段值为空。
• 注释行可以用来防止链接超时，服务端可以定期向浏览器发送一条消息注释行，以保持连接不断。

3.2.1 event

事件类型。如果指定了该字段，则在浏览器收到该条消息时，会在当前 EventSource 对象（见 4）上触发一个事件，事件类型就是该字段的字段值。可以使用 addEventListener 方法在当前 EventSource 对象上监听任意类型的命名事件。如果该条消息没有 event 字段，则会触发 EventSource 对象 onmessage 属性上的事件处理函数。

3.2.2 id

事件ID。事件的唯一标识符，浏览器会跟踪事件ID，如果发生断连，浏览器会把收到的最后一个事件ID放到 HTTP Header Last-Event-Id 中进行重连，作为一种简单的同步机制。例如可以在服务端将每次发送的事件ID值自动加 1，当浏览器接收到该事件ID后，下次与服务端建立连接后再请求的 Header 中将同时提交该事件ID，服务端检查该事件ID是否为上次发送的事件ID，如果与上次发送的事件ID不一致则说明浏览器存在与服务器连接失败的情况，本次需要同时发送前几次浏览器未接收到的数据。

3.2.3 retry

重连时间。整数值，单位 ms，如果与服务器的连接丢失，浏览器将等待指定时间，然后尝试重新连接。如果该字段不是整数值，会被忽略。当服务端没有指定浏览器的重连时间时，由浏览器自行决定每隔多久与服务端建立一次连接（一般为 30s）。

3.2.4 data

消息数据。数据内容只能以一个字符串的文本形式进行发送，如果需要发送一个对象时，需要将该对象以一个 JSON 格式的字符串的形式进行发送。在浏览器接收到该字符串后，再把它还原为一个 JSON 对象。

4. 客户端实现

在客户端，可以使用 JavaScript 的 EventSource API 创建 EventSource 对象监听服务器发送的事件。一旦建立连接，服务器就可以使用 HTTP 响应的 ‘text/event-stream’ 内容类型发送事件消息，浏览器则可以通过监听 EventSource 对象的 onmessage、onopen 和 onerror 事件来处理这些消息。

4.1 建立连接

EventSource 接受两个参数：URL 和 options。URL 为 http 事件来源，一旦 EventSource 对象被创建后，浏览器立即开始对该 URL 地址发送过来的事件进行监听。options 是一个可选的对象，包含 withCredentials 属性，表示是否发送凭证（cookie、HTTP认证信息等）到服务端，默认为 false。

const eventSource = new EventSource('http_api_url', { withCredentials: true })

与 XMLHttpRequest 对象类型，EventSource 对象有一个 readyState 属性值，具体含义如下表：

可以使用 EventSource 对象的 close 方法关闭与服务端之间的连接，使浏览器不再建立与服务端之间的连接。

// 初始化 eventSource 等省略 
const eventSource = new EventSource('http_api_url', { withCredentials: true })
...
// 关闭连接 
eventSource.close()

4.2 监听事件

EventSource 对象本身继承自 EventTarget 接口，因此可以使用 addEventListener() 方法来监听事件。EventSource 对象触发的事件主要包括以下三种：

• open 事件：当成功连接到服务端时触发。
• message 事件：当接收到服务器发送的消息时触发。该事件对象的 data 属性包含了服务器发送的消息内容。
• error 事件：当发生错误时触发。该事件对象的 event 属性包含了错误信息。

// 初始化 eventSource 等省略 
 
eventSource.addEventListener('open', function(event) { 
  console.log('Connection opened')
})
eventSource.addEventListener('message', function(event) { 
  console.log('Received message: ' + event.data); 
}) 
 
// 监听自定义事件
 
eventSource.addEventListener('xxx', function(event) {
  console.log('Received message: ' + event.data);
})
eventSource.addEventListener('error', function(event) {
  console.log('Error occurred: ' + event.event);
})

当然，也可以采用属性监听（onopen、onmessage、onerror）的形式。

// 初始化 eventSource 等省略
eventSource.onopen = function(event) {
  console.log('Connection opened')
}
eventSource.onmessage = function(event) {
  console.log('Received message: ' + event.data);
}
eventSource.onerror = function(event) {
  console.log('Error occurred: ' + event.event)
})

📢注意：EventSource 对象的属性监听只能监听预定义的事件类型（open、message、error）。不能用于监听自定义事件类型。如果要实现自定义事件类型的监听，可以使用 addEventListener() 方法。

5. 实践

5.1 服务端

使用 Node.js 实现 SSE 的简单示例：

const http = require('http');
const fs = require('fs');
http.createServer((req, res) => {
  if (req.url === '/') {
    // 如果请求根路径，返回 index.html 文件 
    fs.readFile('index.html', (err, data) => {
      if (err) {
        res.writeHead(500);
        res.end('Error loading index.html');
      } else {
        res.writeHead(200, {'Content-Type': 'text/html'}); 
        res.end(data);
      }
    });
  } else if (req.url === '/events') {
    // 如果请求 /events 路径，建立 SSE 连接 
    res.writeHead(200, { 
      'Content-Type': 'text/event-stream', 
      'Cache-Control': 'no-cache',
      'Connection': 'keep-alive' 
    }); 
    // 每隔 1 秒发送一条消息 
    let id = 0; 
    const intervalId = setInterval(() => { 
      res.write(`event: customEvent\n`)
      res.write(`id: ${id}\n`)
      res.write(`retry: 30000\n`)
      const data = { id, time: new Date().toISOString()}
      res.write(`data: ${JSON.stringify(data)}\n\n`); 
      id++
    }, 1000); 
    // 当客户端关闭连接时停止发送消息
    req.on('close', () => { 
      clearInterval(intervalId); 
      id = 0
      res.end();
    });
  } else { 
    // 如果请求的路径无效，返回 404 状态码 
    res.writeHead(404); 
    res.end();
  }
    
}).listen(3000); 

console.log('Server listening on port 3000'); 

5.2 浏览器

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>SSE Demo</title>
</head>
<body>
  <h1>SSE Demo</h1>
  <button onclick="connectSSE()">建立 SSE 连接</button>
  <button onclick="closeSSE()">断开 SSE 连接</button> <br /> <br /> 
  <div id="message"></div>
  <script> 
    const messageElement = document.getElementById('message')  
    let eventSource // 建立 SSE 连接 
    const connectSSE = () => {
      // 创建实例
      eventSource = new EventSource('/events')
      
      // 监听消息事件 
      eventSource.addEventListener('message', (event) => { 
        const data = JSON.parse(event.data) 
        messageElement.innerHTML += `${data.id} --- ${data.time}` + '<br />'
      }) 
      
      // 监听连接成功事件 
      eventSource.onopen = () => {
        messageElement.innerHTML += `SSE 连接成功，状态${eventSource.readyState}` 
      }
      
      // 监听连接失败事件
      eventSource.onerror = () => {
        messageElement.innerHTML += `SSE 连接错误，状态${eventSource.readyState}`
      } 
    } 
    
    // 断开 SSE 连接 
    const closeSSE = () => {
      eventSource.close() 
      messageElement.innerHTML += `SSE 连接关闭，状态${eventSource.readyState}`
    }
  </script>
</body>
</html> 

将上面的两份代码保存为 server.js 和 index.html，并在命令行中执行 node server.js 启动服务端，然后在浏览器中打开 http://localhost:3000 即可看到 SSE 效果。

6. 兼容性

发展至今，SSE 已具有广泛的的浏览器兼容性，几乎除 IE 之外的浏览器均已支持。

7. 总结

SSE 技术是一种轻量级的实时通信技术，基于 HTTP 协议，具有服务端推送、断线重连、简单轻量等优点。但是，SSE 技术也有一些缺点，如不能进行双向通信、连接数受限等。

SSE 可以在 Web 应用程序中实现诸如股票在线数据、日志推送、聊天室实时人数等即时数据推送功能。需要注意的是，SSE 并不是适用于所有的实时推送场景。在需要高并发、高吞吐量和低延迟的场景下，WebSockets 可能更加适合。而在需要更轻量级的推送场景下，SSE 可能更加适合。因此，在选择即时更新方案时，需要根据具体的需求和场景进行选择。