Spring Boot中集成 SSE

2024-05-25 10:04
文章标签 java spring boot 集成 sse

本文主要是介绍Spring Boot中集成 SSE，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

目录

  1. SSE简介
  2. SSE原理
  3. SSE的使用场景
  4. 在Spring Boot中集成SSE
    • 创建Spring Boot项目
    • 添加依赖
    • 创建SSE控制器
    • 前端使用SSE
    • 详细案例：股票价格实时推送
  5. 总结

SSE简介

服务器发送事件（Server-Sent Events，SSE）是一种在HTTP协议上实现的服务器推送技术。它允许服务器单向地将实时更新推送到客户端。与WebSocket不同，SSE是基于HTTP协议的简化实现，非常适合需要从服务器向客户端单向推送数据的场景。

SSE原理

SSE通过HTTP协议的一个长连接来实现服务器到客户端的单向数据流。客户端通过发送一个普通的HTTP请求来建立连接，服务器接收到请求后，保持连接不断开，并通过这个连接持续地发送事件。客户端使用JavaScript的EventSource API来处理这些事件。

SSE的使用场景

SSE适用于以下应用场景：

  • 实时通知：如邮件通知、系统消息推送。
  • 实时更新：如股票行情、新闻更新。
  • 监控和仪表盘：实时监控数据的展示。
  • 社交媒体更新：如实时评论和点赞。

在Spring Boot中集成SSE

创建Spring Boot项目

首先，使用Spring Initializr或IDE（如IntelliJ IDEA）创建一个新的Spring Boot项目，选择合适的Spring Boot版本（如2.5.x或3.x），并添加以下依赖：

  • Spring Web

添加依赖

在pom.xml中添加Spring Web的依赖：

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- 其他依赖 -->
</dependencies>

创建SSE控制器

创建一个控制器来处理SSE连接和事件推送。

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.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;@RestController
public class SseController {@GetMapping("/sse")public SseEmitter handleSse() {// 创建一个新的SseEmitter实例，超时时间为30秒SseEmitter emitter = new SseEmitter(30_000L);// 创建一个ScheduledExecutorService来定时发送事件ScheduledExecutorService executor = Executors.newScheduledThreadPool(1);// 每秒发送一个当前时间的消息executor.scheduleAtFixedRate(() -> {try {// 发送事件，事件名称为"message"，数据为当前时间戳emitter.send(SseEmitter.event().name("message").data("Current Time: " + System.currentTimeMillis()));} catch (IOException e) {// 发送失败时完成该Emitteremitter.completeWithError(e);}}, 0, 1, TimeUnit.SECONDS);// 在30秒后完成该Emitterexecutor.schedule(() -> emitter.complete(), 30, TimeUnit.SECONDS);return emitter;}
}

前端使用SSE

在前端使用JavaScript的EventSource来接收服务器发送的事件：

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>SSE Demo</title>
</head>
<body><h1>SSE Demo</h1><div id="messages"></div><script>// 创建一个新的EventSource实例，连接到服务器的/sse端点const eventSource = new EventSource("/sse");// 当收到服务器发送的消息时，执行此函数eventSource.onmessage = function(event) {// 获取消息展示的divconst messagesDiv = document.getElementById("messages");// 创建一个新的div元素来展示新消息const newMessage = document.createElement("div");newMessage.textContent = event.data; // 设置div的文本内容为事件数据messagesDiv.appendChild(newMessage); // 将新消息添加到消息展示div中};// 当发生错误时，执行此函数eventSource.onerror = function(error) {console.error("EventSource failed: ", error);eventSource.close(); // 关闭EventSource};</script>
</body>
</html>

详细案例：股票价格实时推送

假设我们需要实现一个股票价格实时推送的功能，服务器定期向客户端发送股票价格更新。

创建StockService类

模拟股票价格变化的服务类。

import org.springframework.stereotype.Service;import java.util.Random;@Service
public class StockService {private Random random = new Random();// 模拟获取股票价格的方法public double getStockPrice(String symbol) {// 返回一个随机价格return 100 + (random.nextDouble() * 50);}
}
更新SseController类

使用StockService类来推送股票价格。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;import java.io.IOException;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;@RestController
public class SseController {private final StockService stockService;// 使用构造器注入StockServicepublic SseController(StockService stockService) {this.stockService = stockService;}@GetMapping("/sse/{symbol}")public SseEmitter handleSse(@PathVariable String symbol) {// 创建一个新的SseEmitter实例，超时时间为30秒SseEmitter emitter = new SseEmitter(30_000L);// 创建一个ScheduledExecutorService来定时发送事件ScheduledExecutorService executor = Executors.newScheduledThreadPool(1);// 每秒发送一个股票价格更新executor.scheduleAtFixedRate(() -> {try {// 获取股票价格double price = stockService.getStockPrice(symbol);// 发送事件，事件名称为"stock-price"，数据为股票价格emitter.send(SseEmitter.event().name("stock-price").data("Stock Price of " + symbol + ": " + price));} catch (IOException e) {// 发送失败时完成该Emitteremitter.completeWithError(e);}}, 0, 1, TimeUnit.SECONDS);// 在30秒后完成该Emitterexecutor.schedule(() -> emitter.complete(), 30, TimeUnit.SECONDS);return emitter;}
}
更新前端代码

在前端展示股票价格更新。

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Stock Price SSE Demo</title>
</head>
<body><h1>Stock Price SSE Demo</h1><input type="text" id="symbol" placeholder="Enter stock symbol"><button onclick="connect()">Connect</button><div id="messages"></div><script>let eventSource;function connect() {const symbol = document.getElementById("symbol").value;if (eventSource) {eventSource.close(); // 关闭已有的连接}// 创建一个新的EventSource实例，连接到服务器的/sse/{symbol}端点eventSource = new EventSource("/sse/" + symbol);// 当收到服务器发送的消息时，执行此函数eventSource.onmessage = function(event) {// 获取消息展示的divconst messagesDiv = document.getElementById("messages");// 创建一个新的div元素来展示新消息const newMessage = document.createElement("div");newMessage.textContent = event.data; // 设置div的文本内容为事件数据messagesDiv.appendChild(newMessage); // 将新消息添加到消息展示div中};// 当发生错误时，执行此函数eventSource.onerror = function(error) {console.error("EventSource failed: ", error);eventSource.close(); // 关闭EventSource};}</script>
</body>
</html>

这篇关于Spring Boot中集成 SSE的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1001192。

相关文章

Spring Security简介、使用与最佳实践

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security？—— 核心思想二、如何在 Java 项目中使用？——
阅读更多...
SpringBoot+RustFS 实现文件切片极速上传的实例代码

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot？二、环境准备与部署2.1 安装 RustF
阅读更多...
springboot中使用okhttp3的小结

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。
阅读更多...
java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

《java.sql.SQLTransientConnectionException连接超时异常原因及解决方案》：本文主要介绍java.sql.SQLTransientConnectionExcep... 目录一、引言二、异常信息分析三、可能的原因3.1 连接池配置不合理3.2 数据库负载过高3.3 连接泄漏
阅读更多...
javacv依赖太大导致jar包也大的解决办法

javacv依赖太大导致jar包也大的解决办法

《javacv依赖太大导致jar包也大的解决办法》随着项目的复杂度和依赖关系的增加,打包后的JAR包可能会变得很大,：本文主要介绍javacv依赖太大导致jar包也大的解决办法,文中通过代码介绍的... 目录前言1.检查依赖2.更改依赖3.检查副依赖总结 前言最近在写项目时，用到了Javacv里的获取视频
阅读更多...
Java实现字节字符转bcd编码

Java实现字节字符转bcd编码

《Java实现字节字符转bcd编码》BCD是一种将十进制数字编码为二进制的表示方式,常用于数字显示和存储,本文将介绍如何在Java中实现字节字符转BCD码的过程,需要的小伙伴可以了解下... 目录前言BCD码是什么Java实现字节转bcd编码方法补充总结前言BCD码（Binary-Coded Decima
阅读更多...
SpringBoot全局域名替换的实现

SpringBoot全局域名替换的实现

《SpringBoot全局域名替换的实现》本文主要介绍了SpringBoot全局域名替换的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录 项目结构⚙️ 配置文件application.yml️ 配置类AppProperties.Ja
阅读更多...
Java使用Javassist动态生成HelloWorld类

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC
阅读更多...
JavaScript中的高级调试方法全攻略指南

JavaScript中的高级调试方法全攻略指南

《JavaScript中的高级调试方法全攻略指南》什么是高级JavaScript调试技巧,它比console.log有何优势,如何使用断点调试定位问题,通过本文,我们将深入解答这些问题,带您从理论到实... 目录观点与案例结合观点1观点2观点3观点4观点5高级调试技巧详解实战案例断点调试：定位变量错误性能分
阅读更多...
Java实现将HTML文件与字符串转换为图片

Java实现将HTML文件与字符串转换为图片

《Java实现将HTML文件与字符串转换为图片》在Java开发中,我们经常会遇到将HTML内容转换为图片的需求,本文小编就来和大家详细讲讲如何使用FreeSpire.DocforJava库来实现这一功... 目录前言核心实现：html 转图片完整代码场景 1：转换本地 HTML 文件为图片场景 2：转换 H
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2