Java建立SSE连接

2024-04-13 17:04
文章标签 java 连接 建立 sse

本文主要是介绍Java建立SSE连接,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

最近有一个新的需求,服务器任务执行完成后需要给客户端发送消息,告诉客户端已经完成这个任务了。用到了SSE(Server Sent Events,服务器发送)。

在Spring中实现SSE连接:

SseEmitterUTF8

解决SSE推送消息乱码的问题,需要继承SseEmitter类,重写里面的extendResponse(),设置响应的类型为TEXT_EVENT_STREAM,并设置字符类型为UTF-8


package com.ruoyi.web.config;import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;import java.nio.charset.StandardCharsets;/*** @Date:2024/4/11 16:09* @description:解决推送消息乱码*/
public class SseEmitterUTF8 extends SseEmitter {public SseEmitterUTF8(Long timeout) {super(timeout);}@Overrideprotected void extendResponse(ServerHttpResponse outputMessage) {super.extendResponse(outputMessage);HttpHeaders headers = outputMessage.getHeaders();headers.setContentType(new MediaType(MediaType.TEXT_EVENT_STREAM, StandardCharsets.UTF_8));}
}

SseController

package com.ruoyi.web.controller.order;import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.core.domain.model.DownloadCenter;
import com.ruoyi.web.config.SseEmitterUTF8;
import com.ruoyi.web.service.SseService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.annotation.Resource;
import javax.annotation.security.PermitAll;/*** @Date:2024/4/11 16:11* @description:SSE*/
@RestController
@RequestMapping("/sse")
public class SseController {@Resourceprivate SseService sseService;/*** 建立连接* @return*/@GetMapping(value = "/connect", produces="text/event-stream;charset=UTF-8")public SseEmitterUTF8 sseConn(String userId){try {SseEmitterUTF8 sseEmitterUTF8 = sseService.connect(userId);return sseEmitterUTF8;} catch (Exception e){e.printStackTrace();throw new RuntimeException("SSE连接异常");}}/*** 给指定的用户发送消息* @param downloadCenter* @return*/@PostMapping("/sendMessage")@PermitAllpublic void sendMessage(String userId){try {sseService.sendMessage(userId);} catch (Exception e){e.printStackTrace();throw new RuntimeException("推送消息异常");}}/*** 断开SSE连接*/@PostMapping("/close")@PermitAllpublic void closeConn(){try {sseService.close();} catch (Exception e){e.printStackTrace();throw new RuntimeException("断开SSE连接异常");}}}

ServiceImpl

package com.ruoyi.web.service.impl;import com.ruoyi.common.constant.CacheConstants;
import com.ruoyi.common.core.domain.AjaxResult;
import com.ruoyi.common.utils.SecurityUtils;
import com.ruoyi.common.utils.StringUtils;
import com.ruoyi.web.config.SseEmitterUTF8;
import com.ruoyi.web.service.SseService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;import javax.annotation.Resource;
import java.io.IOException;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;/*** @Date:2024/4/11 16:31* @description:SSE*/
@Service
@Slf4j
public class SseServiceImpl implements SseService {//当前连接数private static AtomicInteger count = new AtomicInteger(0);//所有的SSE连接集合private static Map<String, SseEmitterUTF8> sseEmitterUTF8Map = new ConcurrentHashMap<>();/*** 建立连接* @return*/@Overridepublic SseEmitterUTF8 connect(String userId) throws IOException {//超时时间0表示不过期SseEmitterUTF8 emitter = new SseEmitterUTF8(0L);//注册回调emitter.onCompletion(completionCallBack(userId));emitter.onError(errorCallback(userId));emitter.onTimeout(timeoutCallBack(userId));sseEmitterUTF8Map.put(userId,emitter);//数量+1count.getAndIncrement();log.info("----------------用户{}连接完成----------------",userId);log.info("----------------建立SSE连接的用户数量:{}----------------",sseEmitterUTF8Map.size());return emitter;}/*** 给指定的用户发送消息* @param downloadCenter*/@Overridepublic void sendMessage(String userId) {String message = downloadCenter.getFilename() + "导出完成。";sseEmitterUTF8Map.get(userId).send(map);log.info("----------------消息发送完成:{}----------------",message);} catch (Exception e){log.error("----------------用户 : {}, 返回消息失败 : {}----------------",userId,message);e.printStackTrace();}}/*** 关闭连接*/@Overridepublic void close(String userId) {if (sseEmitterUTF8Map.containsKey(userId)){sseEmitterUTF8Map.get(userId).complete();sseEmitterUTF8Map.remove(userId);log.info("----------------用户{}退出 : {}----------------",userId);}}/*** 判断SSE的连接状态,发哦是那个消息之前可以调用方法判断连接是否有效* @param sseEmitterUTF8* @return*/public static boolean checkSseConnAlive(SseEmitter sseEmitterUTF8){if (Objects.isNull(sseEmitterUTF8)){return false;}// 返回true代表还连接, 返回false代表失去连接return !(Boolean) getField(sseEmitterUTF8,sseEmitterUTF8.getClass(), "sendFailed") &&!(Boolean) getField(sseEmitterUTF8,sseEmitterUTF8.getClass(), "complete");}public static Object getField(Object obj, Class<?> clazz, String fieldName) {for (; clazz != Object.class; clazz = clazz.getSuperclass()) {try {Field field;field = clazz.getDeclaredField(fieldName);field.setAccessible(true);return field.get(obj);} catch (Exception e) {}}return null;}private Runnable timeoutCallBack(String userId) {return () -> {log.error("----------------用户{}连接超时----------------",userId);removeUser(userId);};}private Consumer<Throwable> errorCallback(String userId) {return throwable -> {log.error("----------------用户{}连接异常---" +"-------------",userId);removeUser(userId);};}private static Runnable completionCallBack(String userId){return () -> {log.info("----------------用户{}连接结束----------------",userId);removeUser(userId);};}private static void removeUser(String userId){sseEmitterUTF8Map.remove(userId);count.getAndDecrement();log.info("----------------remove userId : {}----------------",userId);}
}

参考🔗

Spring Boot怎么使用SSE方式向前端推送数据-java教程-PHP中文网

这篇关于Java建立SSE连接的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/900713

相关文章

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