Spring Boot 整合 SSE（Server-Sent Events）

1、簡述

SSE（Server-Sent Events）是一種基于HTTP協(xié)議的單向通信機(jī)制，允許服務(wù)器向瀏覽器持續(xù)發(fā)送實時更新。與WebSocket不同，SSE更簡單，使用HTTP/1.1協(xié)議即可，不需要額外的協(xié)議升級。它通過簡單的文本流格式（data: ...\n\n）傳輸事件，支持自定義事件類型和重連機(jī)制。

SSE與其他技術(shù)的對比

SSE的特點：

• 自動重連：客戶端在連接斷開時會自動嘗試重新連接。
• 輕量級協(xié)議：事件流格式簡單，無需額外解析庫。
• 瀏覽器原生支持：現(xiàn)代瀏覽器通過EventSource API直接使用。

2、Spring Boot 中的SSE實現(xiàn)

2.1 添加依賴與配置

驗證Spring Boot版本兼容性：確保使用Spring Boot 2.2+版本以獲得更好的異步支持。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.1.0</version>
</parent>

2.2 實現(xiàn)后端接口

代碼深度解析：

• 使用Stream.generate生成數(shù)據(jù)流，但需注意無限流會導(dǎo)致線程阻塞，推薦結(jié)合異步線程池。
• 添加事件ID和重試機(jī)制（增強(qiáng)SSE規(guī)范支持）：

@GetMapping(value = "/sse/stream", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
public Flux<String> stream() {
    return Flux.interval(Duration.ofSeconds(1))
              .map(sequence -> "id: " + sequence + "\n" 
                             + "data: " + LocalTime.now() + "\n\n")
              .take(10);
}

2.3 超時與異常處理

精細(xì)化配置：

• 通過SseEmitter設(shè)置超時回調(diào)，記錄未完成的連接：

emitter.onTimeout(() -> {
    log.warn("SSE連接超時：{}", emitter);
    emitters.remove(emitter);
});

• 全局異常處理：使用@ExceptionHandler捕獲IOException，避免連接中斷導(dǎo)致服務(wù)不可用。

2.4 前端實現(xiàn)優(yōu)化

增強(qiáng)健壯性：

• 監(jiān)聽特定事件類型并處理重連：

eventSource.addEventListener("customEvent", function(e) {
    console.log("自定義事件數(shù)據(jù)：", e.data);
});
eventSource.onerror = function() {
    setTimeout(() => new EventSource('/sse/stream'), 5000); // 5秒后重連
};

• 添加心跳檢測：服務(wù)器定期發(fā)送注釋行（:keep-alive\n）防止代理超時。

3、高級實踐

3.1 結(jié)合Spring Security實現(xiàn)鑒權(quán)

保護(hù)SSE端點：

@GetMapping("/sse/private-stream")
public SseEmitter privateStream(Authentication authentication) {
    if (authentication == null) {
        throw new SecurityException("未授權(quán)訪問");
    }
    return ssePushService.subscribe();
}

Token驗證：前端在初始化EventSource時攜帶Token：

new EventSource('/sse/private-stream?token=xxxx');

3.2 分布式場景下的解決方案

使用消息隊列廣播事件（以Redis Pub/Sub為例）：

1. 引入依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2. 訂閱Redis頻道并推送消息：

@Bean
public MessageListenerAdapter redisListener(SsePushService pushService) {
    return new MessageListenerAdapter((message, channel) -> 
        pushService.pushMessage(message.toString()));
}

3.3 性能監(jiān)控與調(diào)優(yōu)

• 監(jiān)控連接數(shù)：通過/actuator/metrics/sse.emitters端點（需集成Actuator）。
• 背壓控制：使用Project Reactor的Flux處理背壓，避免服務(wù)器過載。

4、注意事項（增強(qiáng)版）

• 瀏覽器兼容性：
• IE完全不支持，可通過polyfill（如eventsource庫）降級為長輪詢。
• 移動端瀏覽器需測試網(wǎng)絡(luò)切換（如4G/WiFi）對連接的影響。
• 消息格式規(guī)范：
  • 每條消息以data:開頭，結(jié)尾必須有兩個換行符。
  • 發(fā)送JSON數(shù)據(jù)需轉(zhuǎn)義換行符：data: {\"time\": \"12:00\"}\n\n。
• 安全加固：
  • 啟用HTTPS防止中間人攻擊。
  • 限制每IP連接數(shù)，防止DDoS攻擊。

5、實戰(zhàn)案例：實時日志監(jiān)控系統(tǒng)

架構(gòu)設(shè)計

1. 日志收集：Filebeat監(jiān)聽日志文件變動。
2. 消息中轉(zhuǎn)：Kafka接收日志并緩存。
3. SSE推送：Spring Boot消費Kafka消息并廣播。

關(guān)鍵代碼

@KafkaListener(topics = "logs")
public void handleLog(String logMessage) {
    ssePushService.pushMessage(logMessage);
}

6、調(diào)試與測試技巧

• 使用Curl測試SSE：

curl -N http://localhost:8080/sse/stream

• 瀏覽器開發(fā)者工具：
  • 網(wǎng)絡(luò)面板查看EventStream分幀詳情。
  • 控制臺調(diào)試EventSource事件監(jiān)聽。

延伸閱讀：

• MDN Server-Sent Events文檔
• Spring官方異步處理指南

到此這篇關(guān)于Spring Boot 整合 SSE（Server-Sent Events）實戰(zhàn)案例(全網(wǎng)最全)的文章就介紹到這了,更多相關(guān)Spring Boot 整合 SSE內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論