本文由 简悦 SimpRead 转码， 原文地址 blog.csdn.net
一、简介
SSE 是一种基于 HTTP 长连接技术，允许服务器向客户端浏览器实时推送更新。客户端通过创建一个 EventSource 对象并指向服务器上的一个 URL 来发起请求，这个请求保持打开状态，服务器可以在这个单一的 TCP 连接上不断发送新的数据块。这些数据块被称为 “事件”，每个事件包含类型（可选）、数据和一些元数据（如事件 ID，重新连接时间间隔等）。服务器端以简单的文本格式（通常为 UTF-8 编码的纯文本）发送数据。
二、SSE 有什么用
理论上， SSE 和 WebSocket 做的是同一件事情。当你需要用新数据局部实时更新网络应用时，SSE 可以做到不需要用户执行任何操作，便可以完成。如统计数据的实时情况。类似这种更新频繁、 低延迟的场景，SSE 可以完全满足。 SSE 是单向通道，只能服务器向客户端发送消息，当客户端发送一个 HTTP 请求，和服务器进行了一次握手，SSE 便可以一直向客户端发送消息。相对于 WebSocket 的双工通道来说，开销会更小一些。
三、SSE 发送的数据类型
在服务器端，需要使用 text/event-stream 作为响应的 Content-Type。发送的数据中：
-
event 字段是可选的，用于指定事件的名称；
-
data 字段是必须的，用于指定数据的内容；
-
id 字段是可选的，用于指定事件的标识符；
-
retry 字段是可选的，用于指定客户端在连接断开后重新连接的时间间隔（以毫秒为单位）。
每个字段都必须以换行符（\n）结尾，并且每个消息都必须以两个换行符（\n\n）结尾。
四、集成 SSE 的使用
1.pom 依赖引入
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
2. 编写创建长链接接口
这里展示创建 SseEmitter 的 service 的代码，controller 中仅调用该接口即可
public SseEmitter createSseConnect() {
// 设置超时时间，0表示不过期。默认30秒，超过时间未完成会抛出异常：AsyncRequestTimeoutException
SseEmitter sseEmitter = new SseEmitter(0L);
String clientId = String.valueOf(UUID.randomUUID());
sseCache.put(clientId, sseEmitter);
// 连接断开回调
sseEmitter.onCompletion(() -> {
sseCache.get(clientId).complete();
sseCache.remove(clientId);
});
// 连接超时
sseEmitter.onTimeout(()-> {
sseCache.get(clientId).complete();
sseCache.remove(clientId);
});
// 连接报错
sseEmitter.onError((throwable) -> {
sseCache.get(clientId).complete();
sseCache.remove(clientId);
});
return sseEmitter;
}
3. 数据发送
其中 builder 可以配置多个参数（以下为 SSE 源码
public interface SseEventBuilder {
SseEventBuilder id(String id);
SseEventBuilder name(String eventName);
SseEventBuilder reconnectTime(long reconnectTimeMillis);
SseEventBuilder comment(String comment);
SseEventBuilder data(Object object);
SseEventBuilder data(Object object, @Nullable MediaType mediaType);
Set<ResponseBodyEmitter.DataWithMediaType> build();
}
以下为 SSE 发送消息代码示例：
public void ssePushMsg() {
if (CollectionUtils.isEmpty(sseCache)) {
return;
}
for (Map.Entry<String, SseEmitter> entry : sseCache.entrySet()) {
try {
SseEmitter.SseEventBuilder event = event();
event.id("11");
event.name("这是名字");
event.data("这是一条sse数据");
//发送消息
entry.getValue().send(event);
} catch (IOException e) {
// 处理异常
log.error("发送失败");
}
}
}
访问 controller 接口。具体效果如下：
