脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → springboot实现SSE

springboot实现SSE(Server Sent Event)的示例代码

 更新时间：2024年04月22日 10:26:49   作者：爱码少年 00fly.online  
SSE 全称Server Sent Event,直译一下就是服务器发送事件,本文主要为大家详细介绍了springboot实现SSE的相关知识,需要的可以参考一下

一、概述

1.SSE是何方神圣

SSE 全称Server Sent Event，直译一下就是服务器发送事件。

其最大的特点，可以简单概括为两个

  • 长连接
  • 服务端可以向客户端推送信息

2.sse与websocket区别

sse 是单通道，只能服务端向客户端发消息；而 websocket 是双通道

那么为什么有了 websocket 还要搞出一个 sse 呢？既然存在，必然有着它的优越之处

ssewebsocket
http 协议独立的 websocket 协议
轻量，使用简单相对复杂
默认支持断线重连需要自己实现断线重连
文本传输二进制传输
支持自定义发送的消息类型-

二、实现过程

下面我们以springboot工程为例，实现服务器端不间断向客户端推送数据

1.效果展示

http://124.71.129.204:8080/index

2. 简要流程

3. 源码放送

SSE工具类

import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;

import org.apache.commons.lang3.RandomStringUtils;
import org.springframework.http.MediaType;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

import lombok.extern.slf4j.Slf4j;

/**
 * Server-Sent Events <BR>
 * https://blog.csdn.net/hhl18730252820/article/details/126244274
 */
@Slf4j
public class SSEServer
{
    /**
     * 当前连接数
     */
    private static AtomicInteger count = new AtomicInteger(0);
    
    private static Map<String, SseEmitter> sseEmitterMap = new ConcurrentHashMap<>();
    
    public static SseEmitter connect()
    {
        String userId = RandomStringUtils.randomAlphanumeric(10);
        SseEmitter sseEmitter = new SseEmitter(0L); // 设置超时时间，0表示不过期，默认是30秒，超过时间未完成会抛出异常
        
        // 注册回调
        sseEmitter.onCompletion(completionCallBack(userId));
        sseEmitter.onError(errorCallBack(userId));
        sseEmitter.onTimeout(timeOutCallBack(userId));
        sseEmitterMap.put(userId, sseEmitter);
        log.info("create new sse connect ,current user:{}, count: {}", userId, count.incrementAndGet());
        return sseEmitter;
    }
    
    public static void batchSendMessage(String message)
    {
        sseEmitterMap.forEach((k, v) -> {
            try
            {
                v.send(message, MediaType.APPLICATION_JSON);
            }
            catch (IOException e)
            {
                log.error("user id:{}, send message error:{}", k, e.getMessage());
                removeUser(k);
            }
        });
    }
    
    public static void removeUser(String userId)
    {
        sseEmitterMap.remove(userId);
        log.info("remove user id:{}, count: {}", userId, count.decrementAndGet());
    }
    
    public static int getUserCount()
    {
        return count.intValue();
    }
    
    private static Runnable completionCallBack(String userId)
    {
        return () -> {
            log.info("结束连接,{}", userId);
            removeUser(userId);
        };
    }
    
    private static Runnable timeOutCallBack(String userId)
    {
        return () -> {
            log.info("连接超时,{}", userId);
            removeUser(userId);
        };
    }
    
    private static Consumer<Throwable> errorCallBack(String userId)
    {
        return throwable -> {
            log.error("连接异常，{}", userId);
            removeUser(userId);
        };
    }
}

sse接口

import java.util.concurrent.TimeUnit;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

import com.fly.hello.service.SSEServer;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@Api(tags = "sse接口")
@RestController
@RequestMapping("/sse")
public class SSEController
{
    long i = -1;
    
    @ApiOperation("初始化")
    @GetMapping("/connect/{userId}")
    public SseEmitter connect(@PathVariable String userId)
    {
        SseEmitter sseEmitter = SSEServer.connect();
        if (i < 0)
        {
            new Thread(() -> sendMessage()).start();
        }
        return sseEmitter;
    }
    
    private void sendMessage()
    {
        if (i < 0) // 保证仅触发一次
        {
            log.info("Server-Sent Events start");
            while (true)
            {
                try
                {
                    TimeUnit.MILLISECONDS.sleep(1000);
                }
                catch (InterruptedException e)
                {
                }
                i = ++i % 101;
                SSEServer.batchSendMessage(String.valueOf(i));
            }
        }
    }
}

页面引用sse

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<link href="css/bootstrap.min.css" rel="external nofollow"  rel="stylesheet" type="text/css" />
<style>
body {
	margin: 10;
	font-size: 62.5%;
	line-height: 1.5;
}

.blue-button {
	background: #25A6E1;
	padding: 3px 20px;
	color: #fff;
	font-size: 10px;
	border-radius: 2px;
	-moz-border-radius: 2px;
	-webkit-border-radius: 4px;
	border: 1px solid #1A87B9
}

table {
	width: 60%;
}

th {
	background: SteelBlue;
	color: white;
}

td, th {
	border: 1px solid gray;
	font-size: 12px;
	text-align: left;
	padding: 5px 10px;
	overflow: hidden;
	white-space: nowrap;
	text-overflow: ellipsis;
	max-width: 200px;
	white-space: nowrap;
	text-overflow: ellipsis;
	text-overflow: ellipsis;
}
</style>
</head>
<title>Hello World!</title>
<script>
	let data = new EventSource("/sse/connect/001")
	data.onmessage = function(event) {
		document.getElementById("result").innerText = event.data + '%';
		document.getElementById("my-progress").value = event.data;
	}
</script>
<body>
	<div class="wrapper-page">
		<table align="center">
			<tr>
				<th colspan="4">Navigate</th>
			</tr>
			<tr>
				<td><a href="/index" rel="external nofollow"  target="_self">index</a></td>
				<td><a href="/404" rel="external nofollow"  target="_self">出错页面</a></td>
				<td><a href="/doc.html" rel="external nofollow"  target="_blank">doc.html</a></td>
				<td><a href="/h2-console" rel="external nofollow"  target="_blank">h2-console</a></td>
			</tr>
		</table>
		<div class="ex-page-content text-center">
			<h2 align="center">
				<a href="index" rel="external nofollow" >reload</a>
				<div><progress style="width: 60%" id="my-progress" value="0" max="100"></progress></div>
				<div id="result"></div>
			</h2>
			<img src="show/girl" width="600" height="600" />
			<img src="show/pic" width="600" height="600" />
		</div>
	</div>
</body>

</html>

4.完整项目

https://gitcode.com/00fly/springboot-hello

git clone https://gitcode.com/00fly/springboot-hello.git

到此这篇关于springboot实现SSE(Server Sent Event)的示例代码的文章就介绍到这了,更多相关springboot实现SSE内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • java编程Reference核心原理示例源码分析

    java编程Reference核心原理示例源码分析

    这篇文章主要为大家介绍了java编程Reference的核心原理以及示例源码分析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步早日升职加薪
    2022-01-01
  • 利用java实现单词倒序排列

    利用java实现单词倒序排列

    这篇文章就是利用java实现单词倒序排列，感觉像是在变魔术，感兴趣的小伙伴来见证一下
    2015-07-07
  • java中最大的整数用法分析

    java中最大的整数用法分析

    这篇文章主要介绍了java中最大的整数用法,结合具体实例形式分析了java计算类java.math.BigInteger具体使用技巧,需要的朋友可以参考下
    2017-06-06
  • Java jvm中Code Cache案例详解

    Java jvm中Code Cache案例详解

    这篇文章主要介绍了Java jvm中Code Cache案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • Java 仿天猫服装商城系统的实现流程

    Java 仿天猫服装商城系统的实现流程

    读万卷书不如行万里路，只学书上的理论是远远不够的，只有在实战中才能获得能力的提升，本篇文章手把手带你用java+SSM+jsp+mysql+maven实现一个仿天猫服装商城系统,大家可以在过程中查缺补漏，提升水平
    2021-11-11
  • window下安装和配置maven环境

    window下安装和配置maven环境

    这篇文章主要为大家详细介绍了window下安装和配置maven环境的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-03-03
  • Java使用fill()数组填充的实现

    Java使用fill()数组填充的实现

    这篇文章主要介绍了Java使用fill()数组填充的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • 全网最精细详解二叉树,2万字带你进入算法领域

    全网最精细详解二叉树,2万字带你进入算法领域

    大家好,我是哪吒,一个热爱编码的Java工程师,本着"欲速则不达,欲达则欲速"的学习态度,在程序猿这条不归路上不断成长,所谓成长,不过是用时间慢慢擦亮你的眼睛,少时看重的,年长后却视若鸿毛,少时看轻的,年长后却视若泰山,成长之路,亦是渐渐放下执念,内心归于平静的旅程
    2021-08-08
  • SpringBoot 中常用注解及各种注解作用

    SpringBoot 中常用注解及各种注解作用

    本篇文章将介绍几种SpringBoot 中常用注解及各个注解的作用，感兴趣的朋友跟随脚本之家小编一起学习吧
    2018-03-03
  • Java请求调用参数格式为form-data类型的接口代码示例

    Java请求调用参数格式为form-data类型的接口代码示例

    这篇文章主要给大家介绍了关于Java请求调用参数格式为form-data类型的接口的相关资料,文中给出了详细的代码示例,对大家的学习或者工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-08-08

最新评论