Spring Boot 整合 SSE（Server-Sent Events）

1、简述

SSE（Server-Sent Events）是一种基于HTTP协议的单向通讯机制，答应服务器向欣赏器连续发送实时更新。与WebSocket差别，SSE更简单，利用HTTP/1.1协议即可，不必要额外的协议升级。
SSE的特点：

• 单向通讯：服务器推送数据给客户端，客户端无法向服务器发送消息。
  
• 简单易用：基于HTTP协议，无需复杂的设置。
  
• 欣赏器支持：当代欣赏器大多内置支持（如Chrome、Edge、Firefox等）。
  

2、Spring Boot 中的SSE实现

2.1 添加依靠
SSE无需额外的依靠，Spring Boot自带对SSE的支持。创建一个Spring Boot项目即可。

1. <dependency>
2.     <groupId>org.springframework.boot</groupId>
3.     <artifactId>spring-boot-starter-web</artifactId>
4. </dependency>

复制代码

2.2 实现后端接口
利用MediaType.TEXT_EVENT_STREAM_VALUE作为返回范例即可开启SSE。以下代码是一个简单的实现。

1. package com.example.sse.controller;
3. import org.springframework.http.MediaType;
4. import org.springframework.web.bind.annotation.GetMapping;
5. import org.springframework.web.bind.annotation.RestController;
7. import java.time.LocalTime;
8. import java.util.concurrent.Executors;
9. import java.util.concurrent.TimeUnit;
10. import java.util.stream.Stream;
12. @RestController
13. public class SseController {
15.     @GetMapping(value = "/sse/stream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
16.     public Stream<String> stream() {
17.         // 模拟数据流
18.         return Stream.generate(() -> "当前时间：" + LocalTime.now())
19.                      .limit(10); // 限制10条消息
20.     }
21. }

复制代码

2.3 设置超时时间（可选）
默认情况下，Spring Boot的相应会超时。可以在application.properties中调解超时时间：

1. server.servlet.session.timeout=30s
2. spring.mvc.async.request-timeout=30000

复制代码

2.4 前端实现
SSE在前端通过EventSource对象实现。以下是一个简单的前端示例：

1. <!DOCTYPE html>
2. <html lang="en">
3. <head>
4.     <meta charset="UTF-8">
5.     <title>SSE Example</title>
6. </head>
7. <body>
8.     <h1>实时消息</h1>
9.     <div id="messages"></div>
11.     <script>
12.         const eventSource = new EventSource('/sse/stream');
14.         eventSource.onmessage = function(event) {
15.             const messagesDiv = document.getElementById('messages');
16.             const newMessage = document.createElement('p');
17.             newMessage.textContent = event.data;
18.             messagesDiv.appendChild(newMessage);
19.         };
21.         eventSource.onerror = function() {
22.             console.error('SSE连接出错，正在尝试重连...');
23.             eventSource.close();
24.         };
25.     </script>
26. </body>
27. </html>

复制代码

3、高级实践
利用Spring Scheduler推送数据，在实际场景中，大概必要定时向客户端推送数据。比方，监控体系定时更新。

1. package com.example.sse.service;
3. import org.springframework.http.MediaType;
4. import org.springframework.stereotype.Service;
5. import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
7. import java.io.IOException;
8. import java.util.concurrent.CopyOnWriteArrayList;
10. @Service
11. public class SsePushService {
13.     private final CopyOnWriteArrayList<SseEmitter> emitters = new CopyOnWriteArrayList<>();
15.     public SseEmitter subscribe() {
16.         SseEmitter emitter = new SseEmitter(30_000L);
17.         emitters.add(emitter);
18.         emitter.onCompletion(() -> emitters.remove(emitter));
19.         emitter.onTimeout(() -> emitters.remove(emitter));
20.         return emitter;
21.     }
23.     public void pushMessage(String message) {
24.         for (SseEmitter emitter : emitters) {
25.             try {
26.                 emitter.send(message, MediaType.TEXT_PLAIN);
27.             } catch (IOException e) {
28.                 emitters.remove(emitter);
29.             }
30.         }
31.     }
32. }

复制代码

创建一个控制器订阅和推送消息：

1. package com.example.sse.controller;
3. import com.example.sse.service.SsePushService;
4. import org.springframework.web.bind.annotation.GetMapping;
5. import org.springframework.web.bind.annotation.RestController;
7. @RestController
8. public class SsePushController {
10.     private final SsePushService ssePushService;
12.     public SsePushController(SsePushService ssePushService) {
13.         this.ssePushService = ssePushService;
14.     }
16.     @GetMapping("/sse/subscribe")
17.     public SseEmitter subscribe() {
18.         return ssePushService.subscribe();
19.     }
21.     @GetMapping("/sse/push")
22.     public void pushMessage() {
23.         ssePushService.pushMessage("当前时间：" + System.currentTimeMillis());
24.     }
25. }

复制代码

注意事项：

• 欣赏器兼容性：SSE不支持IE，但当代欣赏器支持精良。
  
• 毗连断开处置惩罚：可通过EventSource的onerror事故重新毗连。
  
• 性能标题：对大量订阅者时，需思量利用分布式消息队列优化（如Kafka）。
  
• 超时时间：默认30秒超时，必要根据实际需求调解。
  

4、实用场景

• 实时关照：如监控体系的告警推送。
  
• 实时更新：如股票行情、体育比分。
  
• 消息流：如体系日志、任务进度。