SpringBoot实现Server-Sent Events(SSE)的使用完整指南

更新时间：2024年09月12日 10:55:11 作者：boydoy1987

使用SpringBoot实现Server-Sent Events（SSE）可以有效处理实时数据推送需求,具有单向通信、轻量级和高实时性等优势,本文详细介绍了在SpringBoot中创建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请求。

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对象，并通过一个单独的线程定期发送消息到客户端。

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

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

<!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功能，为用户提供更好的实时体验。

到此这篇关于SpringBoot实现Server-Sent Events(SSE)的使用完整指南的文章就介绍到这了,更多相关SpringBoot Server-Sent Events(SSE)内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

springboot整合微信支付sdk过程解析
这篇文章主要介绍了springboot整合微信支付sdk过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
SpringBoot配置文件密码加密与解密的操作代码
我们在SpringBoot项目当中,会把数据库的用户名密码等配置直接放在yaml或者properties文件中,这样维护数据库的密码等敏感信息显然是有一定风险的,所以我们需要给密码加解密,本文给大家介绍了SpringBoot配置文件密码加密与解密的操作代码,需要的朋友可以参考下
2024-12-12
基于mybatis-plus 时间字段比较
这篇文章主要介绍了mybatis-plus 时间字段的比较，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
基于SpringBoot + Android实现登录功能
在移动互联网的今天,许多应用需要通过移动端实现与服务器的交互功能,其中登录是最常见且基础的一种功能,本篇博客将详细介绍如何使用 Spring Boot 和 Android 实现一个完整的登录功能,需要的朋友可以参考下
2024-11-11
解决Mybatis plus实体类属性与表字段不一致的问题
这篇文章主要介绍了Mybatis plus实体类属性与表字段不一致解决方法,文末给大家提到了Mybatis-plus中数据库表名和表字段名的相关知识，需要的朋友可以参考下
2022-07-07
Spring事务管理只对出现运行期异常进行回滚
Spring的事务管理默认只对出现运行期异常(java.lang.RuntimeException及其子类)进行回滚,需要了解更多Spring事务方面的知识，可详看本文
2012-11-11
详解Java设计模式——迭代器模式
这篇文章主要介绍了Java设计模式——迭代器模式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-03-03
浅谈mybatis主键生成的几种策略
本文主要介绍了浅谈mybatis主键生成策略,包括使用数据库自增主键、使用UUID生成主键和使用MyBatis-Plus的雪花算法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2026-01-01
java基本事件处理机制解析
这篇文章主要介绍了java基本事件处理机制解析, Java事件处理机制是一种用于处理用户交互和系统事件的编程模型,它基于事件驱动的思想,通过监听和响应事件来实现程序的交互性和动态性,需要的朋友可以参考下
2023-10-10
java 如何读取远程主机文件
这篇文章主要介绍了java 如何读取远程主机文件的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-02-02