java通过SSE实现消息推送

更新时间：2024年11月04日 15:51:01 作者：铁猛

这篇文章主要为大家详细介绍了java如何通过SSE实现消息推送功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

一、什么是SSE

严格地说，HTTP 协议无法做到服务器主动推送信息。但是，有一种变通方法，就是服务器向客户端声明，接下来要发送的是流信息（streaming）。

也就是说，发送的不是一次性的数据包，而是一个数据流，会连续不断地发送过来。这时，客户端不会关闭连接，会一直等着服务器发过来的新的数据流，视频播放就是这样的例子。本质上，这种通信就是以流信息的方式，完成一次用时很长的下载。

SSE 就是利用这种机制，使用流信息向浏览器推送信息。它基于 HTTP 协议，目前除了 IE/Edge，其他浏览器都支持。

二、如何在java中实现SSE

在Spring Boot项目中，无需额外引入特定的依赖，因为Spring Web MVC模块已经内置了对SSE的支持。

1、编写SSE服务，来进行创建链接和发送消息

package com.smart3dmap.prjpntmanage.service;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Service;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

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

@Slf4j
@Service
public class SSEService {
    private static final Map<String,SseEmitter> sseEmitterMap = new ConcurrentHashMap<>();
    public SseEmitter crateSse(String uid) {
        SseEmitter sseEmitter = new SseEmitter(0L);
        sseEmitter.onCompletion(() -> {
            log.info("[{}]结束链接" , uid);
            sseEmitterMap.remove(uid);
        });
        sseEmitter.onTimeout(() -> {
            log.info("[{}]链接超时",uid);
        });
        sseEmitter.onError(throwable -> {
            try{
                log.info("[{}]链接异常，{}",uid,throwable.toString());
                sseEmitter.send(SseEmitter.event()
                        .id(uid)
                        .name("发生异常")
                        .data("发生异常请重试")
                        .reconnectTime(3000));
                sseEmitterMap.put(uid,sseEmitter);
            }catch (IOException e){
                e.printStackTrace();
            }
        });
        try{
            sseEmitter.send(SseEmitter.event().reconnectTime(5000));
        }catch (IOException e){
            e.printStackTrace();
        }
        sseEmitterMap.put(uid,sseEmitter);
        log.info("[{}]创建sse连接成功!",uid);
        return sseEmitter;
    }

    public boolean sendMessage(String uid,String messageId,String message){
        if(StringUtils.isEmpty(message)){
            log.info("[{}]参数异常，msg为空",uid);
            return false;
        }
        SseEmitter sseEmitter = sseEmitterMap.get(uid);
        if(sseEmitter == null){
            log.info("[{}]sse连接不存在",uid);
            return  false;
        }
        try{
            sseEmitter.send(SseEmitter.event().id(messageId).reconnectTime(60000).data(message));
            log.info("用户{},消息ID：{}，推送成功：{}",uid,messageId,message);
            return true;
        }catch (IOException e){
            sseEmitterMap.remove(uid);
            log.info("用户{},消息ID：{}，消息推送失败：{}",uid,messageId,message);
            sseEmitter.complete();
            return false;
        }
    }

    public void closeSse(String uid){
        if(sseEmitterMap.containsKey(uid)){
            SseEmitter sseEmitter = sseEmitterMap.get(uid);
            sseEmitter.complete();
            sseEmitterMap.remove(uid);
        }else {
            log.info("用户{}连接已关闭",uid);
        }
    }

}

2、编写对应的Controller来实现具体业务

package com.test.controller;

import cn.hutool.core.util.IdUtil;
import com.test.service.SSEService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

@Controller
@RequestMapping("test")
public class TestController {
    @Autowired
    private SSEService sseService;
    @GetMapping("createSse")
    @CrossOrigin
    public SseEmitter createSse(String uid)
    {
        return sseService.crateSse(uid);
    }

    @GetMapping("sendMsg")
    @ResponseBody
    @CrossOrigin
    public String sseChat(String uid){
        for (int i = 0; i < 10; i++) {
            sseService.sendMessage(uid,"消息"+i,IdUtil.fastUUID().replace("-",""));
        }
        return "OK";
    }
    @GetMapping("closeSse")
    @CrossOrigin
    public void closeSse(String uid){
        sseService.closeSse(uid);
    }
}

三、前端实现消息的监听

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>SSE消息推送监听</title>
</head>
<body>
    <div id="conMsg"></div>
<script>
    let uid = 1;
    let chat = document.getElementById("conMsg");
    if(window.EventSource){
        var eventSource = new EventSource(`http://127.0.0.1:8090/test/createSse?uid=${uid}`);
        eventSource.onopen = ()=>{
            console.log("链接成功");
        }
        eventSource.onmessage = (ev)=>{
            if(ev.data){
                chat.innerHTML += ev.data+"<br>";
            }
        }
        eventSource.onerror = ()=>{
            console.log("sse链接失败")
        }
    }else{
        alert("当前浏览器不支持sse")
    }
</script>
</body>
</html>

到此这篇关于java通过SSE实现消息推送的文章就介绍到这了,更多相关java SSE消息推送内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

SpringBoot实现i18n国际化的两种企业级方案
在全球化业务场景下,系统适配多语言已成为标配需求,SpringBoot作为主流的Java开发框架,提供了完善的国际化,本文将从实战角度出发,完整讲解两种企业级i18n实现方案：基于配置文件的静态实现和基于数据库的动态实现,需要的朋友可以参考下
2026-01-01
简单探索 Java 中的惰性计算
这篇文章主要介绍了简单探索 Java 中的惰性计算，惰性计算（尽可能延迟表达式求值）是许多函数式编程语言的特性。惰性集合在需要时提供其元素，无需预先计算它们，这带来了一些好处。,需要的朋友可以参考下
2019-06-06
Java生成动态版验证码的方法实例
这篇文章主要给大家介绍了利用Java生成动态版验证码的方法实例，本文生成的是GIF格式 + 干扰元素，让验证码破解难度又上了一个层次，文中给出了详细的示例代码，并在文末给出了完整的实例代码供大家下载学习，需要的朋友们下面来一起看看吧。
2017-04-04
Springboot自定义mvc组件如何实现
这篇文章主要介绍了Springboot自定义mvc组件如何实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-11-11
java 查询oracle数据库所有表DatabaseMetaData的用法(详解)
下面小编就为大家带来一篇java 查询oracle数据库所有表DatabaseMetaData的用法(详解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-11-11
IDEA的Swing可视化插件JFormDesigner详解
JFormDesigner是一个专业的软件应用程序，专门用于帮助您开发Java Swing用户界面，而无需具备编程技能。它可作为独立实用程序使用，也可以将其用作各种IDE的插件，本文给大家介绍idea Swing可视化插件，感兴趣的朋友一起看看吧
2022-06-06
java 算法之快速排序实现代码
这篇文章主要介绍了java 算法之快速排序实现代码的相关资料,需要的朋友可以参考下
2017-05-05
Springboot jar文件如何打包zip在linux环境运行
这篇文章主要介绍了Springboot jar文件如何打包zip在linux环境运行,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-02-02
Spring Security 2026 构建安全、可靠的企业应用实践指南
文章概述了SpringSecurity2026的核心特性、认证与授权的最佳实践、安全防护和会话管理措施,以及在微服务架构中的应用,并探讨了未来的安全趋势,强调通过合理配置和实践构建更安全的企业应用
2026-04-04
springboot 如何禁用某项健康检查
这篇文章主要介绍了springboot 如何禁用某项健康检查的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07