使用Spring Boot实现Server-Sent Events（SSE）的完整指南

一、引言

在Web应用开发中，实现实时数据推送是一个常见需求。Server-Sent Events（SSE）是HTML5提供的一种服务器到客户端的单向通信技术，允许服务器主动向客户端推送信息，无需客户端不断轮询。本文将详细介绍如何在Spring Boot应用中实现SSE，并提供完整的代码示例。

二、SSE的优势

单向通信：服务器到客户端的简单数据流，无需客户端发送请求。
轻量级：基于HTTP，不需要额外的框架或协议。
实时性：服务器端数据更新可以即时推送到客户端。
三、SSE的典型使用场景
实时通知：如邮件提醒、社交动态更新等。
实时数据展示：如股票市场数据、实时统计信息等。
在线聊天室：服务器端推送新消息给所有在线用户。
四、Spring Boot实现SSE的步骤

创建Spring Boot项目
首先，你需要创建一个Spring Boot项目。可以使用Spring Initializr或者任何IDE来创建项目，并添加spring-boot-starter-web依赖。
创建SSE端点
在Spring Boot项目中，创建一个控制器来处理SSE请求。

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;
@RestController
public class SseController {
    private final ExecutorService executor = Executors.newSingleThreadExecutor();
    @GetMapping(value = "/sse", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
    public SseEmitter streamSseMvc() {
        SseEmitter emitter = new SseEmitter();
        executor.execute(() -> {
            try {
                for (int i = 0; i < 10; i++) {
                    // 模拟数据处理
                    Thread.sleep(1000);
                    emitter.send("Message " + i);
                }
                emitter.complete();
            } catch (IOException | InterruptedException e) {
                emitter.completeWithError(e);
            }
        });
        return emitter;
    }
}

在上面的代码中，我们创建了一个SseEmitter对象，并通过一个单独的线程定期发送消息到客户端。

运行Spring Boot应用

确保你的Spring Boot应用已经配置好，并且可以运行。启动应用后，服务器将在默认的8080端口上监听。

客户端代码

在客户端，你可以使用以下HTML和JavaScript代码来接收SSE。

html 复制代码

<!DOCTYPE html>
<html>
<head>
    <title>SSE with Spring Boot</title>
</head>
<body>
<h1>Receiving Server-Sent Events</h1>
<div id="messages"></div>
<script>
    var eventSource = new EventSource('/sse');
    eventSource.onmessage = function(event) {
        var messages = document.getElementById('messages');
        var message = document.createElement('div');
        message.textContent = 'Message from server: ' + event.data;
        messages.appendChild(message);
    };
    eventSource.onerror = function(event) {
        console.error('EventSource failed:', event);
        eventSource.close();
    };
</script>
</body>
</html>

五、测试

启动Spring Boot应用，并在浏览器中打开上述HTML文件。你应该能够看到服务器发送的消息每隔一秒出现在页面上。

六、总结

本文展示了如何在Spring Boot应用中实现SSE，通过简单的步骤和代码示例，你可以轻松地在你的Web应用中添加实时数据推送功能。SSE提供了一种简单而有效的方法来处理实时数据流，非常适合于需要服务器主动推送信息给客户端的场景。通过Spring Boot，我们可以快速地集成和部署SSE功能，为用户提供更好的实时体验。