SseEmiter流式接口

​

 

概述：

  • SseEmiter 是 Spring Framework 提供的一个类，用于支持服务器发送事件（Server-Sent Events，SSE）。SSE 是一种基于 HTTP 的协议，允许服务器向客户端推送实时数据，而不需要客户端不断地轮询服务器。SSE 特别适用于需要实时更新数据的场景，例如实时通知、实时数据流等。

 

SseEmitter 的主要特点：

  1. 单向通信：SSE 是单向的，服务器可以向客户端推送数据，但客户端不能向服务器发送数据。
  2. 基于 HTTP：SSE 使用标准的 HTTP 协议，因此不需要额外的协议支持。
  3. 自动重连：如果连接中断，客户端会自动尝试重新连接服务器。
  4. 事件流格式：SSE 使用简单的文本格式来传输数据，每条消息以 data: 开头，并以两个换行符 \n\n 结束。

 

SseEmitter 的基本用法：

  1. 创建 SseEmitter 实例：在控制器中创建一个 SseEmitter 实例，并将其返回给客户端。
  2. 发送事件：通过 SseEmitter 实例的 send 方法向客户端发送事件。
  3. 处理连接关闭：通过 SseEmitter 的 onCompletion 和 onTimeout 方法处理连接关闭或超时的情况。

1. 后端代码示例

import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

import java.io.IOException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

@RestController
public class SseController {

    private final ExecutorService nonBlockingService = Executors.newCachedThreadPool();

    @GetMapping("/sse")
    public SseEmitter handleSse() {
        SseEmitter emitter = new SseEmitter();

        nonBlockingService.execute(() -> {
            try {
                for (int i = 0; i < 10; i++) {
                    SseEmitter.SseEventBuilder event = SseEmitter.event()
                            .data("SSE event - " + i)
                            .id(String.valueOf(i))
                            .name("sse event")
                            .reconnectTime(10_000L);
                    emitter.send(event);
                    Thread.sleep(1000); // 模拟延迟
                }
                emitter.complete(); // 完成发送
            } catch (IOException | InterruptedException e) {
                emitter.completeWithError(e);
            }
        });

        return emitter;
    }
}

 

2. 前端请求设置

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>SSE Example</title>
</head>
<body>
    <h1>Server-Sent Events Example</h1>
    <ul id="eventList"></ul>

    <script>
        const eventSource = new EventSource('/sse');
        const eventList = document.getElementById('eventList');

        eventSource.onmessage = function(event) {
            const newElement = document.createElement("li");
            newElement.textContent = "Event: " + event.data;
            eventList.appendChild(newElement);
        };

        eventSource.onerror = function() {
            console.error("EventSource failed.");
        };
    </script>
</body>
</html>

 

3. nginx配置

注意：如果前端的请求是走nginx到后端，一定要配置下列信息。否则nginx会默认缓存，不会以流的形式发送信息。


location /api_proxy/ {
        add_header X-Location "sse";
        # 取消缓冲
        proxy_buffering off;
        # 关闭代理缓存
        proxy_cache off;

        # 重要！因为项目实际不止有一个nginx代理，还有可能会有统一的上层nginx网关。
        # 只在第一个nginx种关闭缓存还不够，由于第二个nginx默认会缓存数据，所以sse流就再一次被缓存了。
        # 解决办法是在第一个nginx的配置里面，继续加上这个header，表示这个路径下的请求需要带上这个header，这样第二个nginx才能继续收到这个header并且不缓存数据。
        add_header X-Accel-Buffering "no";

       proxy_set_header Host $http_host;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_set_header X-Frame-Options sameorigin;
       proxy_set_header X-Forwarded-For $remote_addr;
       proxy_pass http://127.0.0.1:8080/;
}
​
posted @ 2025-12-25 15:12  小朱学编程啊  阅读(0)  评论(0)    收藏  举报