Springboot通过SSE实现实时消息返回

news2025/5/25 4:26:57

Server-Sent Events（SSE）是一种从服务器向客户端推送实时消息的技术。相较于WebSocket，SSE更为简单，适用于大多数实时消息场景。本文将深入探讨如何使用Spring Boot通过SSE实现实时消息返回。

一、什么是SSE

SSE是一种允许服务器通过HTTP协议向客户端发送实时更新的技术。客户端只需发送一个简单的HTTP请求，然后保持连接打开，服务器可以在任意时间推送消息。SSE适用于实时性要求高，但双向通信需求不强的场景，如实时股票行情、新闻推送等。

二、Spring Boot中使用SSE

在Spring Boot中实现SSE相对简单，只需通过Controller返回SSE的响应流即可。

1. 创建Spring Boot项目

首先，创建一个基本的Spring Boot项目，并添加必要的依赖。

pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

2. 编写Controller

接下来，创建一个控制器来处理SSE连接并推送实时消息。

SseController.java

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

import java.io.IOException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;

@RestController
public class SseController {

    private final ExecutorService executorService = Executors.newCachedThreadPool();

    @GetMapping("/sse")
    public SseEmitter handleSse() {
        SseEmitter emitter = new SseEmitter();
        executorService.execute(() -> {
            try {
                for (int i = 0; i < 10; i++) {
                    emitter.send("Message " + i, MediaType.TEXT_PLAIN);
                    TimeUnit.SECONDS.sleep(1);
                }
                emitter.complete();
            } catch (IOException | InterruptedException e) {
                emitter.completeWithError(e);
            }
        });
        return emitter;
    }
}

上述代码创建了一个 /sse端点，当客户端连接到该端点时，服务器将通过SseEmitter对象每秒发送一条消息，共发送10条消息。

三、客户端实现

为了接收服务器推送的消息，客户端需要使用EventSource对象建立连接并处理接收到的消息。

index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>SSE Demo</title>
</head>
<body>
    <h1>Server-Sent Events Demo</h1>
    <div id="messages"></div>

    <script>
        const eventSource = new EventSource("/sse");

        eventSource.onmessage = function(event) {
            const messagesDiv = document.getElementById("messages");
            const message = document.createElement("div");
            message.textContent = event.data;
            messagesDiv.appendChild(message);
        };

        eventSource.onerror = function() {
            console.error("EventSource failed.");
        };
    </script>
</body>
</html>

在上述HTML文件中，使用 EventSource对象连接到 /sse端点，并通过 onmessage事件处理器显示接收到的消息。