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

相关文章

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

SpringBoot基于配置实现短信服务策略的动态切换

《SpringBoot基于配置实现短信服务策略的动态切换》这篇文章主要为大家详细介绍了SpringBoot在接入多个短信服务商(如阿里云、腾讯云、华为云)后,如何根据配置或环境切换使用不同的服务商,需... 目录目标功能示例配置(application.yml)配置类绑定短信发送策略接口示例:阿里云 & 腾

SpringBoot项目中报错The field screenShot exceeds its maximum permitted size of 1048576 bytes.的问题及解决

《SpringBoot项目中报错ThefieldscreenShotexceedsitsmaximumpermittedsizeof1048576bytes.的问题及解决》这篇文章... 目录项目场景问题描述原因分析解决方案总结项目场景javascript提示:项目相关背景:项目场景:基于Spring

Spring Boot 整合 SSE的高级实践(Server-Sent Events)

《SpringBoot整合SSE的高级实践(Server-SentEvents)》SSE(Server-SentEvents)是一种基于HTTP协议的单向通信机制,允许服务器向浏览器持续发送实... 目录1、简述2、Spring Boot 中的SSE实现2.1 添加依赖2.2 实现后端接口2.3 配置超时时

Spring Boot读取配置文件的五种方式小结

《SpringBoot读取配置文件的五种方式小结》SpringBoot提供了灵活多样的方式来读取配置文件,这篇文章为大家介绍了5种常见的读取方式,文中的示例代码简洁易懂,大家可以根据自己的需要进... 目录1. 配置文件位置与加载顺序2. 读取配置文件的方式汇总方式一:使用 @Value 注解读取配置方式二

一文详解Java异常处理你都了解哪些知识

《一文详解Java异常处理你都了解哪些知识》:本文主要介绍Java异常处理的相关资料,包括异常的分类、捕获和处理异常的语法、常见的异常类型以及自定义异常的实现,文中通过代码介绍的非常详细,需要的朋... 目录前言一、什么是异常二、异常的分类2.1 受检异常2.2 非受检异常三、异常处理的语法3.1 try-

Java中的@SneakyThrows注解用法详解

《Java中的@SneakyThrows注解用法详解》:本文主要介绍Java中的@SneakyThrows注解用法的相关资料,Lombok的@SneakyThrows注解简化了Java方法中的异常... 目录前言一、@SneakyThrows 简介1.1 什么是 Lombok?二、@SneakyThrows

Java中字符串转时间与时间转字符串的操作详解

《Java中字符串转时间与时间转字符串的操作详解》Java的java.time包提供了强大的日期和时间处理功能,通过DateTimeFormatter可以轻松地在日期时间对象和字符串之间进行转换,下面... 目录一、字符串转时间(一)使用预定义格式(二)自定义格式二、时间转字符串(一)使用预定义格式(二)自

Spring 请求之传递 JSON 数据的操作方法

《Spring请求之传递JSON数据的操作方法》JSON就是一种数据格式,有自己的格式和语法,使用文本表示一个对象或数组的信息,因此JSON本质是字符串,主要负责在不同的语言中数据传递和交换,这... 目录jsON 概念JSON 语法JSON 的语法JSON 的两种结构JSON 字符串和 Java 对象互转

JAVA保证HashMap线程安全的几种方式

《JAVA保证HashMap线程安全的几种方式》HashMap是线程不安全的,这意味着如果多个线程并发地访问和修改同一个HashMap实例,可能会导致数据不一致和其他线程安全问题,本文主要介绍了JAV... 目录1. 使用 Collections.synchronizedMap2. 使用 Concurren