SpringBoot SseEmitter，服务器单项消息推送

最新推荐文章于 2024-08-06 20:18:30 发布
最新推荐文章于 2024-08-06 20:18:30 发布
阅读量250 收藏 2
点赞数 1
文章标签： spring boot 后端 java 服务器 spring
本文为博主原创文章，未经博主允许不得转载。
本文链接：https://blog.csdn.net/WangKun_0612/article/details/140826998
版权

防止推送消息乱码

import org.jetbrains.annotations.NotNull;
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;

/**
 * @Description 防止中文乱码
 * @Author WangKun
 * @Date 2024/7/30 11:22
 * @Version
 */
public class SseUTF8 extends SseEmitter {

    public SseUTF8(Long timeout) {
        super(timeout);
    }

    @Override
    protected void extendResponse(@NotNull ServerHttpResponse outputMessage) {
        super.extendResponse(outputMessage);
        HttpHeaders headers = outputMessage.getHeaders();
        headers.setContentType(new MediaType(MediaType.TEXT_EVENT_STREAM, StandardCharsets.UTF_8));
    }

}

SseEmitter工具类
import com.harmonywisdom.enums.ResultCode;
import com.harmonywisdom.utils.StringUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.scheduling.annotation.Async;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.lang.reflect.Field;
import java.io.IOException;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * @Description SSE消息推送工具
 * @Author WangKun
 * @Date 2024/7/29 14:55
 * @Version
 */
@Component
@Slf4j
public class SseUtils {

    /**
     * 容器
     */
    private static final ConcurrentHashMap<String, SseUTF8> SSE_MAP_CACHE = new ConcurrentHashMap<>(0);

    /**
     * 默认时长不过期(默认30s)
     */
    private static final long DEFAULT_TIMEOUT = 0L;

    /**
     * @param userId
     * @Description 创建连接
     * @Throws
     * @Return SseUTF8
     * @Date 2024-07-29 15:01:58
     * @Author WangKun
     **/
    public static SseUTF8 createConnect(String userId) {

        SseUTF8 sseEmitter = new SseUTF8(DEFAULT_TIMEOUT);
        // 需要给客户端推送ID
        if (SSE_MAP_CACHE.containsKey(userId)) {
            remove(userId);
        }
        // 长链接完成后回调接口(关闭连接时调用)
        sseEmitter.onCompletion(() -> {
            log.info("SSE连接结束:{}", userId);
            remove(userId);
        });
        // 连接超时回调
        sseEmitter.onTimeout(() -> {
            log.error("SSE连接超时:{}", userId);
            remove(userId);
        });
        // 连接异常时，回调方法
        sseEmitter.onError(
                throwable -> {
                    try {
                        log.info("SSE{}连接异常,{}", userId, throwable.toString());
                        sseEmitter.send(SseUTF8.event()
                                .id(userId)
                                .name("发生异常!")
                                .data("发生异常重试!")
                                .reconnectTime(3000));
                        SSE_MAP_CACHE.put(userId, sseEmitter);
                    } catch (IOException e) {
                        log.error("用户--->{} SSE连接失败重试,异常信息--->{}", userId, e.getMessage());
                        e.printStackTrace();
                    }
                }
        );
        SSE_MAP_CACHE.put(userId, sseEmitter);
        try {
            // 注册成功返回用户信息
            sseEmitter.send(SseUTF8.event().id(String.valueOf(ResultCode.CONNECT_SUCCESS.getCode())).data(userId, MediaType.APPLICATION_JSON));
        } catch (IOException e) {
            log.error("用户--->{} SSE连接失败,异常信息--->{}", userId, e.getMessage());
        }
        return sseEmitter;
    }

    /**
     * @param userId
     * @Description 移除用户连接
     * @Throws
     * @Return void
     * @Date 2024-07-29 15:07:03
     * @Author WangKun
     **/
    private static void remove(String userId) {
        SSE_MAP_CACHE.remove(userId);
        log.info("SSE移除用户连接--->{} ", userId);
    }

    /**
     * @param userId
     * @Description 关闭连接
     * @Throws
     * @Return void
     * @Date 2024-07-29 15:38:16
     * @Author WangKun
     **/
    public static void closeConnect(String userId) {
        SseUTF8 sseEmitter = SSE_MAP_CACHE.get(userId);
        if (sseEmitter != null) {
            sseEmitter.complete();
            log.info("SSE关闭连接：{}", userId);
            remove(userId);
        }
    }

    /**
     * @param userId
     * @param message
     * @param sseEmitter
     * @Description 推送消息到客户端
     * @Throws
     * @Return void
     * @Date 2024-07-29 15:48:19
     * @Author WangKun
     **/
    private static boolean sendMsgToClient(String userId, String message, SseUTF8 sseEmitter) {
        // 推送之前检测心态是否存在
        boolean isAlive = checkSseConnectAlive(sseEmitter);
        if (!isAlive) {
            // 失去连接移除
            log.error("SSE推送消息失败：客户端{}未创建长链接或者关闭,失败消息:{}", userId, message);
            SSE_MAP_CACHE.remove(userId);
            return false;
        }
        SseUTF8.SseEventBuilder sendData = SseUTF8.event().id(String.valueOf(ResultCode.CONNECT_SUCCESS.getCode())).data(message, MediaType.APPLICATION_JSON);
        try {
            sseEmitter.send(sendData);
            return true;
        } catch (IOException e) {
            log.error("推送消息失败：{}", message);
        }
        return true;
    }

    /**
     * @param sseEmitter
     * @Description 检测连接心跳
     * @Throws
     * @Return boolean
     * @Date 2024-07-30 17:27:32
     * @Author WangKun
     **/
    public static boolean checkSseConnectAlive(SseUTF8 sseEmitter) {
        if (sseEmitter == null) {
            return false;
        }
        // 返回true代表还连接, 返回false代表失去连接
        return !(Boolean) getField(sseEmitter, sseEmitter.getClass(), "sendFailed") &&
                !(Boolean) getField(sseEmitter, sseEmitter.getClass(), "complete");
    }

    /**
     * @param obj
     * @param clazz
     * @param fieldName
     * @Description 反射获取 sendFailed complete
     * @Throws
     * @Return java.lang.Object
     * @Date 2024-07-30 17:27:49
     * @Author WangKun
     **/
    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 ignored) {
            }
        }

        return null;
    }

    /**
     * @param msg
     * @Description 发送消息给所有客户端
     * @Throws
     * @Return void
     * @Date 2024-07-29 15:48:40
     * @Author WangKun
     **/
    public static boolean sendTextMessage(String msg) {
        if (SSE_MAP_CACHE.isEmpty()) {
            return false;
        }
        if (StringUtils.isEmpty(msg) || StringUtils.isBlank(msg)) {
            return false;
        }
        boolean isSuccess = false;
        for (Map.Entry<String, SseUTF8> entry : SSE_MAP_CACHE.entrySet()) {
            isSuccess = sendMsgToClient(entry.getKey(), msg, entry.getValue());
            if (!isSuccess) {
                log.error("群发客户端{}消息推送,失败消息:{}", entry.getKey(), msg);
            }
        }
        return isSuccess;
    }

    /**
     * @param clientId
     * @param msg
     * @Description 给指定客户端发送消息
     * @Throws
     * @Return Boolean
     * @Date 2024-07-29 15:51:30
     * @Author WangKun
     **/
    public static boolean sendTextMessage(String clientId, String msg) {
        return sendMsgToClient(clientId, msg, SSE_MAP_CACHE.get(clientId));
    }

    /**
     * @Description 检测客户端心跳（连接状态，给客户端发送信息，如果sendFailed,complete返回false 移除客户端，说明客户端关闭）
      * @param
     * @Throws
     * @Return void
     * @Date 2024-07-31 16:22:25
     * @Author WangKun
     **/
    @Async("threadPoolExecutor")
    @Scheduled(cron = "0 0/15 * * * ?")
    public void checkSseAlive() {
        log.info("检测客户端连接状态");
        sendTextMessage("LIVE");
    }

}

使用方法

/**
 * @Description 测试sse
 * @Author WangKun
 * @Date 2024/7/29 15:56
 * @Version
 */
@RequiredArgsConstructor
@RestController
@RequestMapping("/api/sse")
public class TestSSEController {

    @Log("测试SSE消息连接")
    @AnonymousPostMapping(value = "/connect")
    public SseUTF8 connect(@RequestParam String userId) {
        return SseUtils.createConnect(userId);
    }

    @Log("测试SSE消息推送")
    @AnonymousPostMapping(value = "/send")
    public ResponseResult<Boolean> send(@RequestParam String userId, @RequestParam String param) {
        boolean flag = SseUtils.sendTextMessage(userId, param);
        if (!flag) {
            return ResponseResult.error(ResultCode.UNAVAILABLE_FOR_LEGAL_REASONS.getCode(), ResultCode.UNAVAILABLE_FOR_LEGAL_REASONS.getMsg());
        }
        return ResponseResult.success(true, ResultCode.OK.getCode());
    }

    @Log("测试SSE所有客户端消息推送")
    @AnonymousPostMapping(value = "/sendAll")
    public ResponseResult<Boolean> sendAll(@RequestParam String param) {
        boolean flag = SseUtils.sendTextMessage(param);
        if (!flag) {
            return ResponseResult.error(ResultCode.UNAVAILABLE_FOR_LEGAL_REASONS.getCode(), ResultCode.UNAVAILABLE_FOR_LEGAL_REASONS.getMsg());
        }
        return ResponseResult.success(true, ResultCode.OK.getCode());
    }

    @Log("测试SSE消息关闭")
    @AnonymousPostMapping(value = "/close")
    public ResponseResult<String> close(@RequestParam String userId) {
        SseUtils.closeConnect(userId);
        return ResponseResult.success(ResultCode.OK.getCode());
    }
}

简要说明

1:

推送消息之前，检测推送得到客户端是否存在，不存在，直接移除，避免浪费。

前端关闭浏览器或者关闭界面要调用关闭接口，将其关闭。

结果：

连接

推送：

给admin的客户端推送

给全部客户端推送

掐指一算乀缺钱
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
WCF之消息交换模式.zip
05-30
这通常用于实现推送通知或实时更新的场景。 - 在WCF中，实现双向通信需要创建一个回调合同，其中包含服务端将调用的方法定义。客户端作为服务的代理，同时也是一个服务的实现，这样服务就能通过回调接口回传消息。 ...
springboot实现文件上传步骤解析
08-25
-- 其他表单项 --> 井号： <!-- ... --> ``` 这个模态框中包含了一个文件上传表单，用于上传文件。 第三步：编写 Spring Boot controllers 在 Spring Boot 中，我们需要编写一个控制器，用于处理...
Springboot整合SSE实现实时消息推送
玩转Java
03-01 1116
SSE消息实时推送
SpringBoot项目集成UniPush推送服务
不会写代码的小周
07-07 4132
uni app开通uni push厂商推送配置实现离线推送
WebSocket服务端消息推送
热门推荐
何哥的博客
09-18 1万+
一、Web端实现即时消息推送五种方式 股票曲线实时变化，在线IM聊天等等，Web系统里总是能见到消息推送的应用。消息推送用好了能增强用户体验，实现消息推送有N种解决方案。 1.1、什么是消息推送 消息推送（Push）指运营人员通过自己的产品或第三方工具对用户当前网页或移动设备进行的主动消息推送。用户可以在网页上或移动设备锁定屏幕和通知栏看到push消息通知。以此来实现用户的多层次需求，使得用户能够自己设定所需要的信息频道，得到即时消息，简单说就是一种定制信息的实现方式。我们平时浏览邮箱时突然弹出消息
Windows单项选择题.pdf
11-16
Windows单项选择题.pdf
NIBIANFANGZHEN_单项逆变_
10-04
《单项逆变电路详解——基于LC滤波设计》 在电力电子技术领域，单项逆变器是一种常见的电源转换装置，其主要功能是将直流电（DC）转化为交流电（AC）。这种转换过程对于太阳能发电系统、储能设备以及各种工业应用来...
Windows7单项选择题.pdf
11-16
Windows7单项选择题.pdf
基于Spring boot + Vue的灾难救援系统
NPCS_JQ的博客
08-02 746
以脚手架项目为基础完成的1.主页：echarts展示的图表2.系统管理：用户管理，角色管理，字典管理，菜单管理，日志管理3.文件管理：生成文件4.文章管理：集合富文本写文章5.公告管理：公告的管理6.轮播图管理：前台首页的轮播图7.灾难类型管理8.灾难记录9..资源调度10.预案管理11.科普信息。
【Spring Boot】用 Spring Security 实现后台登录及权限认证功能
书山有路，学海无涯。记录成长，追逐梦想
08-03 1627
Spring Security 提供了声明式的安全访问控制解决方案（仅支持基于 Spring 的应用程序），对访问权限进行认证和授权，它基于 Spring AOP 和 Servlet 过滤器，提供了安全性方面的全面解决方案。
基于若依框架开发的Spring Boot+Vue的MES（生产制造执行系统）是一种专为中小型工厂设计的ERP（企业资源计划）系统
m0_62996549的博客
08-03 695
基于若依框架开发的Spring Boot+Vue的MES（生产制造执行系统）是一种专为中小型工厂设计的ERP（企业资源计划）系统。这个系统旨在帮助这些工厂实现更有效的生产管理、数据收集与分析、设备监控以及质量管理等，从而提高生产效率和产品质量。
8月6日Spring Boot学习笔记
最新发布
tcwjy2021的博客
08-06 507
MyBatis 的每一个查询映射的返回类型都是 resultMap，只是当我们提供的返回类型是 resultType 时，MyBatis 会自动把对应的值赋给 resultType 所指定对象的属性，而当我们提供的返回类型是 resultMap 时，MyBatis 会将数据库中的列数据复制到对象的相应属性上，可用于复制查询。Map 的 key 是参数名，collection 属性值是传入的 List 或 array 对象在自己封装的 Map 中的 key。
Spring Boot常用注解
东皋长歌的专栏
08-03 1726
Component注解是一个通用的注解，可以用来标注任何Spring管理的bean，像@Service，@Controller，@Repository都是@Component注解的别名。用途：@Data是一个复合注解，集成了@Getter，@Setter，@ToString，@EqualsAndHashCode，@RequiredArgsConstuctor等注解。用途：用于标识控制层组件，是@Component注解的别称，用于标识Spring MVC控制器，处理Web请求并返回视图。
Spring Boot实战：拦截器
LHY537200的博客
08-06 953
什么是拦截器：拦截器在SpringBoot中主要有以下几个作用： 1.2拦截器的基本使用1.⾃定义拦截器：实现HandlerInterceptor接⼝，并重写其所有⽅法 2.注册配置拦截器：实现WebMvcConfigurer接⼝，并重写addInterceptors⽅法 3.启动服务, 试试访问任意请求, 观察后端⽇志 可以看到preHandle ⽅法执⾏之后就放⾏了, 开始执⾏⽬标⽅法, ⽬标⽅法执⾏完成之后执⾏ postHandle和afterCompletion⽅法.
Spring Boot 整合 Dubbo3 + Nacos 2.4.0【进阶】+ 踩坑记录
小天一直在路上
08-03 1054
1、Nacos 2.4.0 增加鉴权的配置；2、Nacos 2.4.0 配置 MySQL；3、Nacos2.4.0 的热更新；4、Dubbo3 自动负载；5、Dubbo3 的重试和超时机制；6、踩坑记录
Spring Boot集成Resilience4J实现限流/重试/隔离
HBLOG
08-03 236
Spring Boot集成Resilience4J实现断路器功能 | Harries Blog™，本篇文章主要讲述基于Resilience4J实现限流/重试/隔离。
Spring boot框架指南
lvjingang的博客
08-06 813
或的方式，统一管理了项目中使用的库的版本号，避免了版本冲突，简化了Maven项目的配置。使用起步依赖：在项目的pom.xml文件中，通过指定作为父项目，或者通过来管理依赖版本。-- 引入Spring Boot的父项目依赖管理 -->
JSONP跨域
zhuge_long的专栏
07-31 562
json存在的意义：不同类型的语言，都能识别jsonJSONP(JSON with Padding)是JSON的一种“使用模式”，可用于解决主流浏览器的跨域数据访问的问题。由于同源策略，一般来说位于server1.的网页无法与不是 server1.example.com的服务器沟通，而HTML的浏览器A从服务器B获取的静态资源，包括Html、Css、Js，然后在Js中通过Ajax访问C服务器的静态资源或请求。即：浏览器A从B服务器拿的资源，资源中想访问服务器C的资源。
提升Lua服务器承载人数策略分析
"该资源是一份关于如何利用Lua优化服务器以提高承载人数的PPT，主要探讨了服务器承载人数的需求分析、当前承载能力评估以及识别性能瓶颈的方法。" 在优化服务器承载人数方面，首先需要明确的是游戏类型对承载需求的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值