sse.js：灵活强大的Server-Sent Events解决方案

sse.js：灵活强大的Server-Sent Events解决方案

【免费下载链接】sse.js A flexible Server-Sent Events EventSource polyfill for Javascript 项目地址: https://gitcode.com/gh_mirrors/ss/sse.js

sse.js是一个专为JavaScript设计的灵活Server-Sent Events (SSE) EventSource polyfill。该项目提供比标准EventSource更可控和功能丰富的替代方案，让开发者能够发送带有自定义头部和载荷的请求，支持多种HTTP方法。

核心功能特性

高度可定制的请求配置

sse.js突破了原生EventSource的限制，支持自定义请求头部，轻松添加认证头和其他自定义头部。除了GET请求外，还完美支持POST及其他HTTP方法，无论是有载荷还是无载荷请求都能优雅处理。

智能事件管理系统

基于EventTarget接口实现全面事件监听，支持open、error、abort、message等事件。内置高效的事件数据解析和处理机制，通过debug选项可轻松追踪数据流状态。

稳定可靠的连接保障

具备增强错误处理机制，优化了问题诊断和修复流程。支持包括IE11在内的多浏览器环境，提供智能连接状态管理，适应不同网络条件的稳定事件流。

安装与使用

安装方式

可以通过以下命令克隆仓库：

git clone https://gitcode.com/gh_mirrors/ss/sse.js

基本用法

最简使用方式是创建SSE对象，附加监听器并激活流：

var source = new SSE(url);
source.addEventListener("message", function (e) {
  var payload = JSON.parse(e.data);
  console.log(payload);
});

高级功能详解

自定义请求头部

var source = new SSE(url, { headers: { Authorization: "Bearer 0xdeadbeef" } });

POST请求支持

var source = new SSE(url, {
  headers: { "Content-Type": "text/plain" },
  payload: "Hello, world!",
});

自动重连功能

var source = new SSE(url, {
  autoReconnect: true,
  reconnectDelay: 3000,
  maxRetries: null,
  useLastEventId: true,
});

Last-Event-ID支持

Last-Event-ID头是SSE规范的关键部分，有助于在重连时保持消息连续性。启用时，sse.js会自动跟踪最后接收的事件ID，并在重连时发送此ID。

事件流顺序

SSE事件按以下顺序分发：

事件	描述	触发时机	事件属性
readystatechange	状态变为CONNECTING	调用stream()时	readyState: 0
open	连接建立	收到服务器响应头时	responseCode, headers
readystatechange	状态变为OPEN	连接建立后	readyState: 1
message	数据接收	服务器发送数据时	data, id, lastEventId
error	连接错误	连接失败或服务器返回错误	responseCode, data
readystatechange	状态变为CLOSED	连接关闭时	readyState: 2
abort	连接中止	调用close()时	无

配置选项参考

名称	描述
headers	包含请求头部的对象。示例：{'Authorization': 'Bearer 0123456789'}
payload	要发送的请求载荷。示例：'{"filter": "temperature > 25"}'
method	使用的HTTP方法。如未指定，有载荷时默认POST，否则GET
withCredentials	是否发送cookie。默认：false
start	是否立即开始流式传输。默认：true
debug	启用调试日志。默认：false
autoReconnect	连接丢失时是否自动重连。默认：false
reconnectDelay	重连前的等待时间（毫秒）。默认：3000
maxRetries	最大重连尝试次数。设为null表示无限制。默认：null
useLastEventId	重连时是否发送Last-Event-ID头以恢复流。默认：true

开发与发布

发布流程

通过npm version增加包版本，然后发布到GitHub和NPM：

$ npm version {major,minor,patch}
$ git publish --tags
$ npm publish --otp <otp>

应用场景

企业级应用集成

• 实时数据监控仪表板
• 即时消息推送系统
• 实时协作编辑工具

性能关键场景

• 高频数据更新应用
• 大规模并发连接管理
• 跨平台实时通信

通过sse.js，开发者可以轻松构建高性能的实时Web应用，享受简单配置带来的强大功能。无论是新手还是有经验的开发者，都能快速上手并发挥其最大价值。

【免费下载链接】sse.js A flexible Server-Sent Events EventSource polyfill for Javascript 项目地址: https://gitcode.com/gh_mirrors/ss/sse.js