Springboot?實(shí)現(xiàn)Server-Sent?Events的項(xiàng)目實(shí)踐

更新時間：2024年12月24日 10:10:39 作者：it噩夢

本文介紹了在Spring?Boot中實(shí)現(xiàn)Server-Sent?Events(SSE),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

在 Spring Boot 中，返回 text/event-stream 類型的響應(yīng)通常用于實(shí)現(xiàn) Server-Sent Events (SSE)，這種方式允許服務(wù)器推送實(shí)時更新到瀏覽器?？蛻舳送ㄟ^ EventSource API 監(jiān)聽并接收這些事件。Spring Boot 可以通過使用 @RestController 和 SseEmitter 來實(shí)現(xiàn)這一功能。

步驟 1：創(chuàng)建 SSE Controller 返回 text/event-stream

我們可以通過 @GetMapping 來創(chuàng)建一個 API，返回 text/event-stream 類型的數(shù)據(jù)。這個數(shù)據(jù)會是一個持續(xù)的流，瀏覽器會實(shí)時地接收它。

示例：通過 Spring Boot 返回 text/event-stream 類型的響應(yīng)

控制器：在 Spring Boot 中定義一個返回 text/event-stream 類型的 API 接口。
使用 SseEmitter：SseEmitter 是 Spring 提供的一個類，用于處理 Server-Sent Events 流。我們可以利用它來異步地向客戶端推送數(shù)據(jù)。

示例 1：簡單的 SSE 實(shí)現(xiàn)

在這個示例中，我們將創(chuàng)建一個簡單的 Spring Boot 控制器，該控制器將返回一個實(shí)時的事件流（SSE）。

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

@RestController
public class SseController {

    /**
     * 這個接口會返回一個持續(xù)的事件流，瀏覽器會通過 EventSource 接收
     */
    @GetMapping("/sse")
    public SseEmitter handleSse() {
        SseEmitter emitter = new SseEmitter();

        // 啟動一個新的線程模擬定期推送事件
        new Thread(() -> {
            try {
                for (int i = 0; i < 10; i++) {
                    // 向客戶端發(fā)送數(shù)據(jù)
                    emitter.send("data: Event " + i + "\n\n");
                    Thread.sleep(1000); // 每秒發(fā)送一次
                }
                emitter.complete(); // 發(fā)送完畢后，標(biāo)記事件流完成
            } catch (Exception e) {
                emitter.completeWithError(e); // 如果出現(xiàn)異常，標(biāo)記事件流出錯
            }
        }).start();

        return emitter; // 返回 SseEmitter 實(shí)例，它會處理異步流式數(shù)據(jù)
    }
}

說明：

SseEmitter 用于處理 SSE 連接。我們將數(shù)據(jù)通過 emitter.send() 發(fā)送到客戶端。
事件通過 data: <message> 格式發(fā)送給客戶端，注意每條消息以兩個換行符結(jié)束（\n\n）。
Thread.sleep(1000) 用于模擬每秒發(fā)送一個事件。如果你需要定期發(fā)送事件，可以通過類似的機(jī)制來實(shí)現(xiàn)。
最后，通過 emitter.complete() 標(biāo)記事件流結(jié)束。如果發(fā)生錯誤，則使用 emitter.completeWithError()。

步驟 2：前端接收 SSE 事件

在前端，使用 JavaScript 的 EventSource API 接收服務(wù)器推送的事件。這個 API 會保持與服務(wù)器的連接，一旦有新的事件，瀏覽器會自動處理。

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

<h1>Server-Sent Events Example</h1>
<div id="messages"></div>

<script>
    // 創(chuàng)建一個 EventSource 對象，連接到 /sse 接口
    const eventSource = new EventSource("/sse");

    // 每當(dāng)接收到數(shù)據(jù)時，處理該事件
    eventSource.onmessage = function(event) {
        const messagesDiv = document.getElementById('messages');
        const message = document.createElement('p');
        message.textContent = event.data;
        messagesDiv.appendChild(message);
    };

    // 錯誤處理
    eventSource.onerror = function(error) {
        console.error("EventSource failed:", error);
    };
</script>

</body>
</html>

步驟 3：配置 Spring Boot 啟用異步支持

SSE 通常需要異步處理，因此在 Spring Boot 中啟用異步支持是非常重要的。可以通過 @EnableAsync 來啟用異步支持。

啟用異步支持

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;

@Configuration
@EnableAsync
public class AsyncConfig {
}

步驟 4：定時推送數(shù)據(jù)（可選）

如果你希望定期推送事件（例如，每隔一定時間推送一個消息），可以使用 Spring 的 @Scheduled 注解來安排定時任務(wù)。

示例：定時發(fā)送事件

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Controller;

@Controller
public class ScheduledSseController {

    private final SseEmitter emitter = new SseEmitter();

    @Scheduled(fixedRate = 5000)  // 每5秒發(fā)送一個事件
    public void sendScheduledEvent() {
        try {
            emitter.send("data: Scheduled Event at " + System.currentTimeMillis() + "\n\n");
        } catch (IOException e) {
            emitter.completeWithError(e);
        }
    }
}

在上面的示例中，@Scheduled(fixedRate = 5000) 會定期每 5 秒發(fā)送一次事件。

步驟 5：處理多客戶端連接

如果你需要管理多個客戶端連接，可以將 SseEmitter 實(shí)例存儲在一個列表中，并為每個連接發(fā)送事件。每當(dāng)有新事件時，你可以通過遍歷這些連接，發(fā)送事件到所有連接的客戶端。

import org.springframework.stereotype.Controller;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
import org.springframework.web.bind.annotation.GetMapping;

import java.io.IOException;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

@Controller
public class MultiClientSseController {

    private final List<SseEmitter> emitters = new CopyOnWriteArrayList<>();

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

        // 在新線程中發(fā)送數(shù)據(jù)
        new Thread(() -> {
            try {
                for (int i = 0; i < 10; i++) {
                    for (SseEmitter e : emitters) {
                        e.send("data: Event " + i + "\n\n");
                    }
                    Thread.sleep(1000); // 每秒發(fā)送一次
                }
            } catch (Exception e) {
                emitters.forEach(SseEmitter::completeWithError);
            }
        }).start();

        return emitter;
    }
}

總結(jié)

返回 text/event-stream：在 Spring Boot 控制器中使用 SseEmitter 或直接通過 @GetMapping 返回流式數(shù)據(jù)。
前端接收事件：使用瀏覽器的 EventSource API 來接收事件流。
定時事件：可以使用 @Scheduled 來定期推送事件，或者通過后臺線程推送動態(tài)數(shù)據(jù)。
多客戶端支持：可以管理多個 SseEmitter 實(shí)例，為每個客戶端推送事件。

這種方式非常適合實(shí)時數(shù)據(jù)推送，例如股票行情更新、社交媒體通知、實(shí)時消息等應(yīng)用場景。

到此這篇關(guān)于Springboot 實(shí)現(xiàn)Server-Sent Events的項(xiàng)目實(shí)踐的文章就介紹到這了,更多相關(guān)Springboot實(shí)現(xiàn)Server-Sent Events內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: