Spring Boot中使用Server-Sent Events (SSE) 實現(xiàn)實時數(shù)據(jù)推送教程

更新時間：2024年03月29日 09:12:21 作者：冬山兄

Server-Sent Events (SSE) 是HTML5引入的一種輕量級的服務器向瀏覽器客戶端單向推送實時數(shù)據(jù)的技術(shù),本文主要介紹了Spring Boot中使用Server-Sent Events (SSE) 實現(xiàn)實時數(shù)據(jù)推送教程,具有一定的參考價值,感興趣的可以了解一下

一、簡介

Server-Sent Events (SSE) 是HTML5引入的一種輕量級的服務器向瀏覽器客戶端單向推送實時數(shù)據(jù)的技術(shù)。在Spring Boot框架中，我們可以很容易地集成并利用SSE來實現(xiàn)實時通信。

二、依賴添加

在Spring Boot項目中，無需額外引入特定的依賴，因為Spring Web MVC模塊已經(jīng)內(nèi)置了對SSE的支持。

輔助Maven

        <!-- 集成beetl -->
        <dependency>
            <groupId>com.ibeetl</groupId>
            <artifactId>beetl-framework-starter</artifactId>
            <version>1.2.30.RELEASE</version>
        </dependency>

        <!-- 集成hutool工具類簡便操作 -->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.3.10</version>
        </dependency>

三、編寫核心SSE Client

@Slf4j
@Component
public class SseClient {
    private static final Map<String, SseEmitter> sseEmitterMap = new ConcurrentHashMap<>();
    /**
     * 創(chuàng)建連接
     */
    public SseEmitter createSse(String uid) {
        //默認30秒超時,設(shè)置為0L則永不超時
        SseEmitter sseEmitter = new SseEmitter(0l);
        //完成后回調(diào)
        sseEmitter.onCompletion(() -> {
            log.info("[{}]結(jié)束連接...................", uid);
            sseEmitterMap.remove(uid);
        });
        //超時回調(diào)
        sseEmitter.onTimeout(() -> {
            log.info("[{}]連接超時...................", uid);
        });
        //異?；卣{(diào)
        sseEmitter.onError(
                throwable -> {
                    try {
                        log.info("[{}]連接異常,{}", uid, throwable.toString());
                        sseEmitter.send(SseEmitter.event()
                                .id(uid)
                                .name("發(fā)生異常！")
                                .data("發(fā)生異常請重試！")
                                .reconnectTime(3000));
                        sseEmitterMap.put(uid, sseEmitter);
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
        );
        try {
            sseEmitter.send(SseEmitter.event().reconnectTime(5000));
        } catch (IOException e) {
            e.printStackTrace();
        }
        sseEmitterMap.put(uid, sseEmitter);
        log.info("[{}]創(chuàng)建sse連接成功！", uid);
        return sseEmitter;
    }

    /**
     * 給指定用戶發(fā)送消息
     *
     */
    public boolean sendMessage(String uid,String messageId, String message) {
        if (StrUtil.isBlank(message)) {
            log.info("參數(shù)異常，msg為null", uid);
            return false;
        }
        SseEmitter sseEmitter = sseEmitterMap.get(uid);
        if (sseEmitter == null) {
            log.info("消息推送失敗uid:[{}],沒有創(chuàng)建連接，請重試。", uid);
            return false;
        }
        try {
            sseEmitter.send(SseEmitter.event().id(messageId).reconnectTime(1*60*1000L).data(message));
            log.info("用戶{},消息id:{},推送成功:{}", uid,messageId, message);
            return true;
        }catch (Exception e) {
            sseEmitterMap.remove(uid);
            log.info("用戶{},消息id:{},推送異常:{}", uid,messageId, e.getMessage());
            sseEmitter.complete();
            return false;
        }
    }

    /**
     * 斷開
     * @param uid
     */
    public void closeSse(String uid){
        if (sseEmitterMap.containsKey(uid)) {
            SseEmitter sseEmitter = sseEmitterMap.get(uid);
            sseEmitter.complete();
            sseEmitterMap.remove(uid);
        }else {
            log.info("用戶{} 連接已關(guān)閉",uid);
        }

    }

}

創(chuàng)建SSE 端點：創(chuàng)建一個SseEmitter，用uid進行標識，uid可以是用戶標識符，也可以是業(yè)務標識符?？梢岳斫鉃橥ㄐ判诺罉俗R。
通過端點發(fā)送事件：可以定時或在事件發(fā)生時調(diào)用sseEmitter.send()方法來發(fā)送事件。
關(guān)閉端點連接

四、編寫Controller

@Controller
public class IndexAction {
    @Autowired
    private SseClient sseClient;
    @GetMapping("/")
    public String index(ModelMap model) {
        String uid = IdUtil.fastUUID();
        model.put("uid",uid);
        return "index";
    }

    @CrossOrigin
    @GetMapping("/createSse")
    public SseEmitter createConnect(String uid) {
        return sseClient.createSse(uid);
    }
    @CrossOrigin
    @GetMapping("/sendMsg")
    @ResponseBody
    public String sseChat(String uid) {
        for (int i = 0; i < 10; i++) {
            sseClient.sendMessage(uid, "no"+i,IdUtil.fastUUID());
        }
        return "ok";
    }

    /**
     * 關(guān)閉連接
     */
    @CrossOrigin
    @GetMapping("/closeSse")
    public void closeConnect(String uid ){

        sseClient.closeSse(uid);
    }
}

1，打開頁面默認頁面，傳遞端點標識。

2，連接端點（/createSse），頁面需要使用

3，通過ajax（/sendMsg），觸發(fā)后端業(yè)務(循環(huán)十條數(shù)據(jù)發(fā)往頁面)，向頁面發(fā)送消息。

4，主動關(guān)閉連接(/closeSse)

五、前端接收與處理

HTML & JavaScript

在前端頁面，使用EventSource API訂閱SSE endpoint：

Html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div id="con"></div>
<script>
    let chat = document.getElementById("con");
    if (window.EventSource) {
        //創(chuàng)建sse
         eventSource = new EventSource(`/createSse?uid=${uid}`);
        eventSource.onopen = function (event) {
            console.log('SSE鏈接成功');
        }
        eventSource.onmessage = function (event) {
            if(event.data){
                chat.innerHTML += event.data + '<br/>';
                //console.log('后端返回的數(shù)據(jù):', data.value);
            }
        }
        eventSource.onerror = (error) => {
            console.log('SSE鏈接失敗');
        };
    } else {
        alert("你的瀏覽器不支持SSE");
    }
</script>
</body>
</html>

在這個例子中，前端每接收到一次SSE推送的事件，就會在id為"con"的元素中追加數(shù)據(jù)。

六、注意事項

當客戶端斷開連接時，SseEmitter會拋出IOException，所以務必捕獲并處理這種異常，通常情況下我們會調(diào)用emitter.complete()或emitter.completeWithError()來關(guān)閉SseEmitter。
SSE連接是持久性的，長時間保持連接可能需要處理超時和重連問題。
考慮到資源消耗，對于大量的并發(fā)客戶端，可能需要采用連接池或者其他優(yōu)化策略。

總結(jié)，Spring Boot中利用SSE實現(xiàn)實時數(shù)據(jù)推送既簡單又實用，特別適合實時更新頻率不高、實時性要求不嚴苛的場景。同時，在高并發(fā)場景下需要注意資源管理和優(yōu)化策略的選擇。

到此這篇關(guān)于Spring Boot中使用Server-Sent Events (SSE) 實現(xiàn)實時數(shù)據(jù)推送教程的文章就介紹到這了,更多相關(guān)SpringBoot 實時數(shù)據(jù)推送內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: