SseEmitter 使用

### 使用 `SseEmitter` 进行服务器发送事件编程 #### 创建并配置 `SseEmitter` 为了使用 `SseEmitter` 发送服务端事件到客户端，首先需要创建一个 `SseEmitter` 的实例。这可以通过在控制器的方法中返回一个新的 `SseEmitter` 对象来完成[^1]。 ```java import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.servlet.mvc.method.annotation.SseEmitter; @RestController public class EventController { @GetMapping("/events") public SseEmitter handleEvents() { SseEmitter emitter = new SseEmitter(); // 设置超时时间（可选） emitter.setTimeout(0L); return emitter; } } ``` #### 向客户端发送消息 一旦建立了 `SseEmitter` 实例，就可以通过调用其 `send()` 方法向客户端发送数据。可以传递字符串、对象或其他类型的响应体作为参数给此方法。下面是一个简单的例子，展示如何每隔一段时间就发送一条消息： ```java import java.io.IOException; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; @RestController public class EventController { private final ExecutorService executor = Executors.newCachedThreadPool(); @GetMapping("/events") public SseEmitter subscribeToEvents() throws InterruptedException, IOException { SseEmitter emitter = new SseEmitter(); Runnable task = () -> { try { for (int i = 0; ; i++) { Thread.sleep(2000); String message = "Event number: " + i; if (!emitter.isCompleted()) { emitter.send(SseEmitter.event() .name("event-name") // 可以为事件命名 .data(message)); } else { break; } } } catch (IOException | InterruptedException e) { System.err.println(e.getMessage()); } finally { emitter.complete(); // 完成会话 } }; executor.submit(task); return emitter; } } ``` 上述代码展示了如何设置定时器定期向订阅者广播更新的消息流。每当有新的事件发生时，就会触发一次 `send()` 调用来通知所有的监听设备。 #### 处理异常情况 当遇到错误或连接丢失的情况下，应该适当地关闭资源以防止内存泄漏等问题的发生。为此可以在捕获异常之后调用 `completeWithError(Throwable)` 来结束当前的 SSE 流程，并释放关联的线程和其他资源。 ```java try { emitter.send(eventData); } catch (Exception ex) { emitter.completeWithError(ex); } ``` 此外，在不再需要继续维持长链接的时候也可以主动调用 `complete()` 方法正常终止该连接。

SseEmitter是Spring框架提供的一个用于服务器向客户端推送消息的工具。具体使用步骤如下： 1. 在Spring配置文件中配置SseEmitter的Bean ``` @Bean public SseEmitter sseEmitter() { return new SseEmitter(); } ``` 2. 在Controller中注入SseEmitter的Bean ``` @Autowired private SseEmitter sseEmitter; ``` 3. 使用SseEmitter发送消息给客户端 ``` sseEmitter.send("Hello world!"); ``` 4. 当需要关闭连接时，使用SseEmitter的complete方法 ``` sseEmitter.complete(); ``` 5. 如果需要设置超时时间，可以使用SseEmitter的setTimeout方法 ``` sseEmitter.setTimeout(60000L); ``` 6. 如果需要设置重试时间，可以使用SseEmitter的setRetry方法 ``` sseEmitter.setRetry(5000L); ``` 注意事项： 1. SseEmitter是基于HTTP协议的，因此需要在客户端使用EventSource对象来接收服务器发送的消息。 2. 在使用SseEmitter时，需要注意不要在长时间没有响应的情况下保持连接，否则可能会导致服务器资源耗尽。因此需要根据实际情况设置超时时间和重试时间。