SpringBoot项目集成socketIo实现实时推送

2023-11-09 22:10

本文主要是介绍SpringBoot项目集成socketIo实现实时推送,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

 

  • netty-socketio maven依赖
<dependency><groupId>com.corundumstudio.socketio</groupId><artifactId>netty-socketio</artifactId><version>1.7.7</version>
</dependency>

 

  • application.properties相关配置
#============================================================================
# netty socket io setting
#============================================================================
# host在本地测试可以设置为localhost或者本机IP,在Linux服务器跑可换成服务器IP
socketio.host=localhost
socketio.port=9099
# 设置最大每帧处理数据的长度,防止他人利用大数据来攻击服务器
socketio.maxFramePayloadLength=1048576
# 设置http交互最大内容长度
socketio.maxHttpContentLength=1048576
# socket连接数大小(如只监听一个端口boss线程组为1即可)
socketio.bossCount=1
socketio.workCount=100
socketio.allowCustomRequests=true
# 协议升级超时时间(毫秒),默认10秒。HTTP握手升级为ws协议超时时间
socketio.upgradeTimeout=1000000
# Ping消息超时时间(毫秒),默认60秒,这个时间间隔内没有接收到心跳消息就会发送超时事件
socketio.pingTimeout=6000000
# Ping消息间隔(毫秒),默认25秒。客户端向服务器发送一条心跳消息间隔
socketio.pingInterval=25000

 

  • SocketIOConfig.java配置文件相关配置
package com.vcgeek.hephaestus.socketio;import com.corundumstudio.socketio.SocketConfig;
import com.corundumstudio.socketio.SocketIOServer;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** 功能描述** @author: zyu* @description:* @date: 2019/4/23 10:40*/
@Configuration
public class SocketIOConfig {@Value("${socketio.host}")private String host;@Value("${socketio.port}")private Integer port;@Value("${socketio.bossCount}")private int bossCount;@Value("${socketio.workCount}")private int workCount;@Value("${socketio.allowCustomRequests}")private boolean allowCustomRequests;@Value("${socketio.upgradeTimeout}")private int upgradeTimeout;@Value("${socketio.pingTimeout}")private int pingTimeout;@Value("${socketio.pingInterval}")private int pingInterval;/*** 以下配置在上面的application.properties中已经注明* @return*/@Beanpublic SocketIOServer socketIOServer() {SocketConfig socketConfig = new SocketConfig();socketConfig.setTcpNoDelay(true);socketConfig.setSoLinger(0);com.corundumstudio.socketio.Configuration config = new com.corundumstudio.socketio.Configuration();config.setSocketConfig(socketConfig);config.setHostname(host);config.setPort(port);config.setBossThreads(bossCount);config.setWorkerThreads(workCount);config.setAllowCustomRequests(allowCustomRequests);config.setUpgradeTimeout(upgradeTimeout);config.setPingTimeout(pingTimeout);config.setPingInterval(pingInterval);return new SocketIOServer(config);}}

 

以下就是提供一个SocketIOService接口,供其他地方需要使用时调用。

package com.vcgeek.hephaestus.socketio;import com.vcgeek.hephaestus.pojo.PushMessage;/*** 功能描述** @author: zyu* @description:* @date: 2019/4/23 10:41*/
public interface SocketIOService {//推送的事件public static final String PUSH_EVENT = "push_event";// 启动服务void start() throws Exception;// 停止服务void stop();// 推送信息void pushMessageToUser(PushMessage pushMessage);}

 

  • SocketIOServiceImpl.java接口实现类
package com.vcgeek.hephaestus.socketio;import com.corundumstudio.socketio.SocketIOClient;
import com.corundumstudio.socketio.SocketIOServer;
import com.vcgeek.hephaestus.pojo.PushMessage;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;/*** 功能描述** @author: zyu* @description:* @date: 2019/4/23 10:42*/
@Service(value = "socketIOService")
public class SocketIOServiceImpl implements SocketIOService {// 用来存已连接的客户端private static Map<String, SocketIOClient> clientMap = new ConcurrentHashMap<>();@Autowiredprivate SocketIOServer socketIOServer;/*** Spring IoC容器创建之后,在加载SocketIOServiceImpl Bean之后启动** @throws Exception*/@PostConstructprivate void autoStartup() throws Exception {start();}/*** Spring IoC容器在销毁SocketIOServiceImpl Bean之前关闭,避免重启项目服务端口占用问题** @throws Exception*/@PreDestroyprivate void autoStop() throws Exception {stop();}@Overridepublic void start() throws Exception {// 监听客户端连接socketIOServer.addConnectListener(client -> {String loginUserNum = getParamsByClient(client);if (loginUserNum != null) {System.out.println(loginUserNum);System.out.println("SessionId:  " + client.getSessionId());System.out.println("RemoteAddress:  " + client.getRemoteAddress());System.out.println("Transport:  " + client.getTransport());clientMap.put(loginUserNum, client);}});// 监听客户端断开连接socketIOServer.addDisconnectListener(client -> {String loginUserNum = getParamsByClient(client);if (loginUserNum != null) {clientMap.remove(loginUserNum);System.out.println("断开连接: " + loginUserNum);System.out.println("断开连接: " + client.getSessionId());client.disconnect();}});// 处理自定义的事件,与连接监听类似socketIOServer.addEventListener("text", Object.class, (client, data, ackSender) -> {// TODO do something
            client.getHandshakeData();System.out.println( " 客户端:************ " + data);});socketIOServer.start();}@Overridepublic void stop() {if (socketIOServer != null) {socketIOServer.stop();socketIOServer = null;}}@Overridepublic void pushMessageToUser(PushMessage pushMessage) {String loginUserNum = pushMessage.getLoginUserNum();if (StringUtils.isNotBlank(loginUserNum)) {SocketIOClient client = clientMap.get(loginUserNum);if (client != null)client.sendEvent(PUSH_EVENT, pushMessage);}}/*** 此方法为获取client连接中的参数,可根据需求更改* @param client* @return*/private String getParamsByClient(SocketIOClient client) {// 从请求的连接中拿出参数(这里的loginUserNum必须是唯一标识)Map<String, List<String>> params = client.getHandshakeData().getUrlParams();List<String> list = params.get("loginUserNum");if (list != null && list.size() > 0) {return list.get(0);}return null;}public static Map<String, SocketIOClient> getClientMap() {return clientMap;}public static void setClientMap(Map<String, SocketIOClient> clientMap) {SocketIOServiceImpl.clientMap = clientMap;}
}

 

  • 前端相关测试页面编写
<!DOCTYPE html>
<html>
<head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><title>NETTY SOCKET.IO DEMO</title><base><script src="https://cdn.bootcss.com/jquery/3.4.0/jquery.min.js"></script><script src="https://cdn.bootcss.com/socket.io/2.2.0/socket.io.js"></script><style>body {padding: 20px;}#console {height: 450px;overflow: auto;}.username-msg {color: orange;}.connect-msg {color: green;}.disconnect-msg {color: red;}</style>
</head><body><div id="console" class="well"></div><button id="btnSend" onclick="send()">发送数据</button>
</body>
<script type="text/javascript">var socket;connect();function connect() {var loginUserNum = '79';var opts = {query: 'loginUserNum=' + loginUserNum};socket = io.connect('http://localhost:9099', opts);socket.on('connect', function () {console.log("连接成功");serverOutput('<span class="connect-msg">连接成功</span>');});socket.on('push_event', function (data) {output('<span class="username-msg">' + data + ' </span>');console.log(data);});socket.on('disconnect', function () {serverOutput('<span class="disconnect-msg">' + '已下线! </span>');});}function output(message) {var element = $("<div>" + " " + message + "</div>");$('#console').prepend(element);}function serverOutput(message) {var element = $("<div>" + message + "</div>");$('#console').prepend(element);}function send() {console.log('发送数据');socket.emit('text','你好');}</script>
</html>

 

文章转载:https://www.jianshu.com/p/c67853e729e2

 

转载于:https://www.cnblogs.com/zyulike/p/10775358.html

这篇关于SpringBoot项目集成socketIo实现实时推送的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

C#借助Spire.XLS for .NET实现在Excel中添加文档属性

《C#借助Spire.XLSfor.NET实现在Excel中添加文档属性》在日常的数据处理和项目管理中,Excel文档扮演着举足轻重的角色,本文将深入探讨如何在C#中借助强大的第三方库Spire.... 目录为什么需要程序化添加Excel文档属性使用Spire.XLS for .NET库实现文档属性管理Sp

Python+FFmpeg实现视频自动化处理的完整指南

《Python+FFmpeg实现视频自动化处理的完整指南》本文总结了一套在Python中使用subprocess.run调用FFmpeg进行视频自动化处理的解决方案,涵盖了跨平台硬件加速、中间素材处理... 目录一、 跨平台硬件加速:统一接口设计1. 核心映射逻辑2. python 实现代码二、 中间素材处

Java方法重载与重写之同名方法的双面魔法(最新整理)

《Java方法重载与重写之同名方法的双面魔法(最新整理)》文章介绍了Java中的方法重载Overloading和方法重写Overriding的区别联系,方法重载是指在同一个类中,允许存在多个方法名相同... 目录Java方法重载与重写:同名方法的双面魔法方法重载(Overloading):同门师兄弟的不同绝

Spring配置扩展之JavaConfig的使用小结

《Spring配置扩展之JavaConfig的使用小结》JavaConfig是Spring框架中基于纯Java代码的配置方式,用于替代传统的XML配置,通过注解(如@Bean)定义Spring容器的组... 目录JavaConfig 的概念什么是JavaConfig?为什么使用 JavaConfig?Jav

Java数组动态扩容的实现示例

《Java数组动态扩容的实现示例》本文主要介绍了Java数组动态扩容的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录1 问题2 方法3 结语1 问题实现动态的给数组添加元素效果,实现对数组扩容,原始数组使用静态分配

Java中ArrayList与顺序表示例详解

《Java中ArrayList与顺序表示例详解》顺序表是在计算机内存中以数组的形式保存的线性表,是指用一组地址连续的存储单元依次存储数据元素的线性结构,:本文主要介绍Java中ArrayList与... 目录前言一、Java集合框架核心接口与分类ArrayList二、顺序表数据结构中的顺序表三、常用代码手动

JAVA项目swing转javafx语法规则以及示例代码

《JAVA项目swing转javafx语法规则以及示例代码》:本文主要介绍JAVA项目swing转javafx语法规则以及示例代码的相关资料,文中详细讲解了主类继承、窗口创建、布局管理、控件替换、... 目录最常用的“一行换一行”速查表(直接全局替换)实际转换示例(JFramejs → JavaFX)迁移建

Spring Boot Interceptor的原理、配置、顺序控制及与Filter的关键区别对比分析

《SpringBootInterceptor的原理、配置、顺序控制及与Filter的关键区别对比分析》本文主要介绍了SpringBoot中的拦截器(Interceptor)及其与过滤器(Filt... 目录前言一、核心功能二、拦截器的实现2.1 定义自定义拦截器2.2 注册拦截器三、多拦截器的执行顺序四、过

Python实现快速扫描目标主机的开放端口和服务

《Python实现快速扫描目标主机的开放端口和服务》这篇文章主要为大家详细介绍了如何使用Python编写一个功能强大的端口扫描器脚本,实现快速扫描目标主机的开放端口和服务,感兴趣的小伙伴可以了解下... 目录功能介绍场景应用1. 网络安全审计2. 系统管理维护3. 网络故障排查4. 合规性检查报错处理1.

JAVA线程的周期及调度机制详解

《JAVA线程的周期及调度机制详解》Java线程的生命周期包括NEW、RUNNABLE、BLOCKED、WAITING、TIMED_WAITING和TERMINATED,线程调度依赖操作系统,采用抢占... 目录Java线程的生命周期线程状态转换示例代码JAVA线程调度机制优先级设置示例注意事项JAVA线程