springboot整合SSE的项目实践

 更新时间:2023年09月15日 15:29:51   作者:普通还不自信的程序员  
SSE是一种可以主动从服务端推送消息的技术,本文主要介绍了springboot整合SSE的项目实践,具有一定的参考价值,感兴趣的可以了解一下

SSE简介

SSE(Server Sent Event),是一种可以主动从服务端推送消息的技术。SSE的本质其实就是一个HTTP的长连接,只不过它给客户端发送的不是一次性的数据包,而是一个stream流,格式为text/event-stream。所以客户端不会关闭连接,会一直等着服务器发过来的新的数据流。

SSE服务端代码

springboot中封装了sse代码,不需要额外的依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
public class SseEmitterServer {
    private static final Logger LOGGER = LoggerFactory.getLogger(SseEmitterServer.class);
    /**
     * 当前连接数
     */
    private static AtomicInteger count = new AtomicInteger(0);
    private static Map<Integer, SseEmitter> sseEmitterMap = new ConcurrentHashMap<>();
    public static SseEmitter connect(Integer userId){
        // 设置超时日期,0表示不过期
        SseEmitter sseEmitter = new SseEmitter(0L);
        // 注册回调
        sseEmitter.onCompletion(completionCallBack(userId));
        sseEmitter.onError(errorCallBack(userId));
        sseEmitter.onTimeout(timeoutCallBack(userId));
        sseEmitterMap.put(userId,sseEmitter);
        count.getAndIncrement();
        LOGGER.info("创建新SSE连接,连接用户编号:{}",userId);
        LOGGER.info("现有连接用户:"+sseEmitterMap.keySet());
        return sseEmitter;
    }
    /**
     * 给指定用户发信息
     */
    public static void sendMessage(Integer userId,String message){
        if (!sseEmitterMap.containsKey(userId)) {
            connect(userId);
        }
        try {
            sseEmitterMap.get(userId).send(message);
            LOGGER.info("给" + userId + "号发送消息:" + message);
        } catch (IOException e) {
            LOGGER.error("userId:{},发送信息出错:{}", userId, e.getMessage());
            e.printStackTrace();
        }
    }
    /**
     * 群发消息
     */
    public static void batchSendMessage(String message){
        if (sseEmitterMap != null&&!sseEmitterMap.isEmpty()) {
            sseEmitterMap.forEach((k,v)->{
                try {
                    v.send(message, MediaType.APPLICATION_JSON);
                } catch (IOException e) {
                    LOGGER.error("userId:{},发送信息出错:{}",k,e.getMessage());
                    e.printStackTrace();
                }
            });
        }
    }
    public static void batchSendMessage(Set<Integer> userIds,String message){
        userIds.forEach(userId->sendMessage(userId,message));
    }
    /**
     * 移出用户
     */
    public static void removeUser(Integer userId){
        sseEmitterMap.remove(userId);
        count.getAndDecrement();
        LOGGER.info("remove user id:{}",userId);
        LOGGER.info("remain user id:"+sseEmitterMap.keySet());
    }
    public static List<Integer> getIds(){
        return new ArrayList<>(sseEmitterMap.keySet());
    }
    public static int getUserCount(){
        return count.intValue();
    }
    private static Runnable completionCallBack(Integer userId){
        return ()->{
          LOGGER.info("结束连接,{}",userId);
          removeUser(userId);
        };
    }
    private static Runnable timeoutCallBack(Integer userId){
        return ()->{
            LOGGER.info("连接超时,{}",userId);
            removeUser(userId);
        };
    }
    private static Consumer<Throwable> errorCallBack(Integer userId){
        return throwable -> {
            LOGGER.error("连接异常,{}",userId);
            removeUser(userId);
        };
    }
}
@RestController
@CrossOrigin(maxAge = 3600)
public class SseController {
    @RequestMapping(value = "/sse/connect/{id}",method = RequestMethod.GET)
    public SseEmitter connect(@PathVariable Integer id){
        SseEmitter sseEmitter = SseEmitterServer.connect(id);
        return sseEmitter;
    }
    /**
     * 向指定用户发送消息
     */
    @RequestMapping(value = "/sse/send/{id}", method = RequestMethod.GET)
    public EiInfo sendMsg(@PathVariable Integer id,@RequestParam("message") String message) {
        EiInfo eiInfo = new EiInfo();
        SseEmitterServer.sendMessage(id,message);
        eiInfo.sysSetMsg("向"+id+"号用户发送信息,"+message+",消息发送成功");
        return eiInfo;
    }
    /**
     * 向所有用户发送消息
     */
    @RequestMapping(value = "/sse/send/all", method = RequestMethod.GET)
    public EiInfo sendMsg2AllUser(@RequestParam("message") String message) {
        EiInfo eiInfo = new EiInfo();
        SseEmitterServer.batchSendMessage(message);
        eiInfo.sysSetMsg("向所有用户发送信息,"+message+",消息发送成功");
        return eiInfo;
    }
    /**
     * 关闭用户连接
     */
    @RequestMapping(value = "/sse/close/{id}", method = RequestMethod.GET)
    public EiInfo closeSse(@PathVariable Integer id) {
        EiInfo eiInfo = new EiInfo();
        SseEmitterServer.removeUser(id);
        eiInfo.sysSetMsg("关闭"+id+"号连接。当前连接用户有:"+SseEmitterServer.getIds());
        return eiInfo;
    }
}

SSE测试

连接服务端

创建三个用户,分别连接服务端

给指定用户发送消息

使用接口测试工具,只给1号用户发送消息

浏览器中,1号用户接收到消息,2号3号未接收到消息

群发消息

关闭连接

当SSE客户端连接后,如果长时间不断开,它会保持连接状态。SSE(Server-Sent Events)是一种基于HTTP的推送技术,允许服务器实时向客户端发送数据。当客户端连接到服务器的SSE端点时,它会创建一个EventSource对象,该对象将与服务器进行长期连接,并接收服务器发送的事件。只有在客户端手动关闭连接或连接发生错误时,才会断开SSE连接。

请注意,由于SSE是基于HTTP的技术,因此它可能受到浏览器或服务器的超时设置的影响。如果在长时间没有收到服务器的数据时,连接可能会断开。如果您希望在长时间不断开连接的情况下保持SSE连接,请确保服务器发送数据以保持连接活跃,或者调整相关超时设置。

在使用SSE的客户端连接中,如果长时间不断开连接,可能会出现以下情况:

  • 连接超时。如果服务器端没有发送新的事件数据,而客户端也没有重新建立连接,可能会超过服务器的连接超时时间。这可能导致服务器关闭连接,客户端需要重新建立连接才能接收新的事件数据。
  • 网络异常。长时间不断开连接可能会导致网络异常,例如连接中断、丢包等问题。在这种情况下,客户端可能需要重新建立连接,以恢复和服务器的通信。为了避免长时间不断开连接的问题,建议在合适的时机关闭连接。

到此这篇关于springboot整合SSE的项目实践的文章就介绍到这了,更多相关springboot整合SSE内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Springboot Druid 自定义加密数据库密码的几种方案

    Springboot Druid 自定义加密数据库密码的几种方案

    这篇文章主要介绍了Springboot Druid 自定义加密数据库密码的步骤,帮助大家更好的理解和使用springboot,感兴趣的朋友可以了解下
    2020-12-12
  • java中的AWT事件处理问题

    java中的AWT事件处理问题

    这篇文章主要介绍了java中的AWT事件处理问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • SpringBoot框架整合Mybatis简单攻略

    SpringBoot框架整合Mybatis简单攻略

    这篇文章主要介绍了SpringBoot框架整合Mybatis的简单攻略,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2021-10-10
  • java实现修改并替换jar包中静态文件过程

    java实现修改并替换jar包中静态文件过程

    文章介绍了如何在场景前后端不分离的项目中,通过环境变量动态修改jar包中的静态资源文件,如`main.js`,具体步骤包括查询jar包中的js文件目录,解压并替换文件,然后将修改后的文件重新打包到jar中,文章提供了一种个人经验分享,希望能帮助到其他开发者
    2025-12-12
  • WebSocket整合SSM(Spring,Struts2,Maven)的实现示例

    WebSocket整合SSM(Spring,Struts2,Maven)的实现示例

    这篇文章主要介绍了WebSocket整合SSM(Spring,Struts2,Maven)的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-01-01
  • Java中的类加载器_动力节点Java学院整理

    Java中的类加载器_动力节点Java学院整理

    这篇文章主要为大家详细介绍了Java中类加载器的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • idea使用带provide修饰依赖导致ClassNotFound

    idea使用带provide修饰依赖导致ClassNotFound

    程序打包到Linux上运行时,若Linux上也有这些依赖,为了在Linux上运行时避免依赖冲突,可以使用provide修饰,本文主要介绍了idea使用带provide修饰依赖导致ClassNotFound,下面就来介绍一下解决方法,感兴趣的可以了解一下
    2024-01-01
  • SpringBoot中的三种应用事件处理机制详解

    SpringBoot中的三种应用事件处理机制详解

    在项目开发中,组件间的松耦合设计至关重要,应用事件处理机制作为观察者模式的一种实现,允许系统在保持模块独立性的同时实现组件间的通信,SpringBoot延续并增强了Spring框架的事件机制,提供了多种灵活的事件处理方式,本文给大家介绍了SpringBoot中的三种应用事件处理机制
    2025-04-04
  • JDK都出到14了,你有什么理由不会函数式编程(推荐)

    JDK都出到14了,你有什么理由不会函数式编程(推荐)

    这篇文章主要介绍了JDK都出到14了,你有什么理由不会函数式编程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-05-05
  • java统计字符串中指定元素出现次数方法

    java统计字符串中指定元素出现次数方法

    这篇文章主要介绍了java统计字符串中指定元素出现次数方法,需要的朋友可以参考下
    2015-12-12

最新评论