一文帶你學(xué)會SSE，你學(xué)會了嗎？
隨著Web應(yīng)用的不斷發(fā)展，實(shí)時數(shù)據(jù)傳輸?shù)男枨笞兊迷絹碓狡毡椤鹘y(tǒng)的輪詢方法不僅效率低下，而且在高并發(fā)情況下會對服務(wù)器造成不必要的壓力。為了解決這個問題，Server-Sent Events (SSE) 應(yīng)運(yùn)而生，它允許服務(wù)器端主動向客戶端推送更新。
Server-Sent Events
Server-Sent Events 是一種允許服務(wù)器向?yàn)g覽器發(fā)送實(shí)時更新的技術(shù)。不同于WebSocket的全雙工通信方式，SSE更專注于單向的數(shù)據(jù)流，即從服務(wù)器到客戶端的數(shù)據(jù)推送。
這種方式對于需要實(shí)時更新的場景非常有用，當(dāng)前主流的大模型平臺，比如ChatGPT、通義千問、文心一言，對話時采用的就是SSE。
SSE 本質(zhì)是一個基于 http 協(xié)議的通信技術(shù)。
SSE的應(yīng)用
引入依賴
spring-boot-starter-web 中默認(rèn)已經(jīng)引用了 sse，所以我們不需要額外引入其他依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>基本用法
@RestController
public class SseController {
@GetMapping("/sse")
public SseEmitter handleSse() {
SseEmitter emitter = new SseEmitter();
// 異步處理發(fā)送事件
new Thread(() -> {
try {
// 推送事件
emitter.send("實(shí)時消息：你好！");
Thread.sleep(1000); // 模擬延時
emitter.send("實(shí)時消息：更新來了！");
emitter.complete(); // 結(jié)束推送
} catch (Exception e) {
emitter.completeWithError(e); // 異常處理
}
}).start();
return emitter;
}
}客戶端代碼
const eventSource = new EventSource("/sse");
// 處理服務(wù)器推送的消息
eventSource.onmessage = function(event) {
console.log(event.data);
};
// 處理連接關(guān)閉或錯誤
eventSource.onerror = function() {
console.log("連接出現(xiàn)問題，自動重連...");
};效果預(yù)覽
圖片
為什么會這么多，那是因?yàn)榭蛻舳说淖詣又剡B機(jī)制，無需我們手動維護(hù)，客戶端會自動發(fā)起重連。
SseEmitter
其實(shí)sse的核心，就是SseEmitter這個類，是 Spring 提供的一個類，用于處理 Server-Sent Events (SSE)。它允許服務(wù)器端以流的形式推送事件給客戶端，而不需要客戶端不斷輪詢服務(wù)器。
1.構(gòu)造函數(shù)
- SseEmitter()：創(chuàng)建一個默認(rèn)超時時間的 SseEmitter 實(shí)例。默認(rèn)超時為 30 秒。
- SseEmitter(Long timeout)：創(chuàng)建一個帶有自定義超時時間的 SseEmitter 實(shí)例。
timeout：指定以毫秒為單位的超時時間。如果設(shè)置為 0L，則連接永遠(yuǎn)不會超時。
2.核心方法
- send(Object object)：向客戶端發(fā)送一條消息。
object：要發(fā)送的數(shù)據(jù)，可以是任何類型的對象。
此方法會將數(shù)據(jù)直接發(fā)送到客戶端，并在響應(yīng)體中流式返回。
- send(SseEmitter.SseEventBuilder event)：以事件構(gòu)建器的形式發(fā)送一條消息。
SseEventBuilder 是用來構(gòu)建發(fā)送事件的一個內(nèi)部類，允許你自定義事件的各個屬性，如 id、data、name 等。
complete()：表示 SSE 流完成并關(guān)閉連接。服務(wù)器告訴客戶端，事件流已經(jīng)結(jié)束。
completeWithError(Throwable ex)：在發(fā)生錯誤時關(guān)閉連接，并以錯誤的形式告知客戶端。
3.回調(diào)函數(shù)
- onCompletion(Runnable callback)：指定當(dāng) SSE 連接完成（正常關(guān)閉）時執(zhí)行的回調(diào)函數(shù)。
- onTimeout(Runnable callback)：指定當(dāng)連接超時時執(zhí)行的回調(diào)函數(shù)。
- onError(Consumer<Throwable> callback)：指定當(dāng)發(fā)生錯誤時執(zhí)行的回調(diào)函數(shù)。這個錯誤可能是由于網(wǎng)絡(luò)連接問題、客戶端斷開等原因。
4.SseEventBuilder 內(nèi)部類
SseEmitter.SseEventBuilder 是用于構(gòu)建 SSE 事件的一個類，允許自定義事件的各個部分：
- SseEmitter.event()：返回一個新的 SseEventBuilder 實(shí)例，用于構(gòu)建事件。
- id(String id)：設(shè)置事件的唯一標(biāo)識符。客戶端可以通過這個 ID 識別和處理事件。
- name(String name)：設(shè)置事件的名稱。客戶端可以通過這個名稱識別不同類型的事件，SSE 響應(yīng)中會顯示為 event: name。
- data(Object data)：設(shè)置要發(fā)送的數(shù)據(jù)。可以是文本、JSON 等類型，最終會在客戶端的 SSE 流中顯示為 data: xxx。
- reconnectTime(long milliseconds)：告訴客戶端在多少毫秒后嘗試重新連接。如果連接中斷，客戶端會在指定時間后自動重連。
- comment(String comment)：向客戶端發(fā)送一條注釋（不會觸發(fā)事件）。
目前 SseEmitter 是基于 每個客戶端請求獨(dú)立管理 的對象，因此不適合將其直接交由 Spring 管理為單例或共享對象。
每次請求應(yīng)手動創(chuàng)建新的 SseEmitter 實(shí)例，并配置合適的超時時間。對于每個連接，SseEmitter 都是短暫的，使用完畢后應(yīng)該調(diào)用 complete() 或 completeWithError() 方法來釋放資源。
SSE 與 WebSocket 對比
圖片
小結(jié)
- 相比輪詢，SSE 通過長連接減少了網(wǎng)絡(luò)開銷和服務(wù)器壓力。
- SseEmitter 適用于需要服務(wù)器實(shí)時推送數(shù)據(jù)的場景，特別是實(shí)時通知、動態(tài)更新等需求
- 相比websocket，在某些場景下，SSE 更加易用，且占用的資源較少
