0
0

日常记录-SpringBoot整合netty-socketio

SpringBoot整合netty-socketio

这次整合借鉴了以下博主的智慧

websocket和socketio的区别

socket.io.js最简版单页HTML测试工具

Netty-SocketIO多路复用

springboot学习(四十三) springboot使用netty-socketio实现消息推送

SpringBoot集成SocketIO

一、准备工作

1、maven依赖

socketio的核心依赖就只有这个

<!-- netty-socketio： 仿`node.js`实现的socket.io服务端 --><dependency><groupId>com.corundumstudio.socketio</groupId><artifactId>netty-socketio</artifactId><version>1.7.19</version></dependency>

2、socketIO的yml配置

在这里插入图片描述

#自定义socketio配置,你可以直接硬编码，看个人喜好socketio:# socketio请求地址host: 127.0.0.1
  # socketio端口port:9999# 设置最大每帧处理数据的长度，防止他人利用大数据来攻击服务器maxFramePayloadLength:1048576# 设置http交互最大内容长度maxHttpContentLength:1048576# socket连接数大小（如只监听一个端口boss线程组为1即可）bossCount:1# 连接数大小workCount:100# 允许客户请求allowCustomRequests:true# 协议升级超时时间（毫秒），默认10秒。HTTP握手升级为ws协议超时时间upgradeTimeout:1000000# Ping消息超时时间（毫秒），默认60秒，这个时间间隔内没有接收到心跳消息就会发送超时事件pingTimeout:6000000# Ping消息间隔（毫秒），默认25秒。客户端向服务器发送一条心跳消息间隔pingInterval:25000# 命名空间，多个以逗号分隔，namespaces: /test,/socketIO
  #namespaces: /socketIO

3、socketIO的config代码

packagecom.gzgs.socketio.common.config;importcom.corundumstudio.socketio.SocketConfig;importcom.corundumstudio.socketio.SocketIOServer;importcom.corundumstudio.socketio.annotation.SpringAnnotationScanner;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importjava.util.Arrays;importjava.util.Optional;@ConfigurationpublicclassSocketIOConfig{@Value("${socketio.host}")privateString host;@Value("${socketio.port}")privateInteger port;@Value("${socketio.bossCount}")privateint bossCount;@Value("${socketio.workCount}")privateint workCount;@Value("${socketio.allowCustomRequests}")privateboolean allowCustomRequests;@Value("${socketio.upgradeTimeout}")privateint upgradeTimeout;@Value("${socketio.pingTimeout}")privateint pingTimeout;@Value("${socketio.pingInterval}")privateint pingInterval;@Value("${socketio.namespaces}")privateString[] namespaces;@BeanpublicSocketIOServersocketIOServer(){SocketConfig socketConfig =newSocketConfig();
        socketConfig.setTcpNoDelay(true);
        socketConfig.setSoLinger(0);com.corundumstudio.socketio.Configuration config =newcom.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);//服务端finalSocketIOServer server =newSocketIOServer(config);//添加命名空间（如果你不需要命名空间，下面的代码可以去掉）Optional.ofNullable(namespaces).ifPresent(nss ->Arrays.stream(nss).forEach(server::addNamespace));return server;}//这个对象是用来扫描socketio的注解，比如 @OnConnect、@OnEvent@BeanpublicSpringAnnotationScannerspringAnnotationScanner(){returnnewSpringAnnotationScanner(socketIOServer());}}

4、SocketIOServer启动或关闭

我在启动类里面定义了启动或者关闭SocketIOServer

packagecom.gzgs.socketio;importcom.corundumstudio.socketio.SocketIOServer;importlombok.extern.slf4j.Slf4j;importorg.springframework.beans.factory.DisposableBean;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.boot.CommandLineRunner;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.stereotype.Component;@SpringBootApplicationpublicclassSocketioServerApplication{publicstaticvoidmain(String[] args){SpringApplication.run(SocketioServerApplication.class, args);}}@Component@Slf4jclassSocketIOServerRunnerimplementsCommandLineRunner,DisposableBean{@AutowiredprivateSocketIOServer socketIOServer;@Overridepublicvoidrun(String... args)throwsException{
        socketIOServer.start();
        log.info("SocketIOServer==============================启动成功");}@Overridepublicvoiddestroy()throwsException{//如果用kill -9  这个监听是没用的，有可能会导致你服务kill掉了，但是socket服务没有kill掉
        socketIOServer.stop();
        log.info("SocketIOServer==============================关闭成功");}}

在这里插入图片描述

springboot整合socketIO的工作已经完成了

5、项目目录结构

参考下即可，核心是如何配置以及如何启动/关闭SocketIO

在这里插入图片描述

二、客户端和服务端建立连接

1、服务端

1.1 用户缓存信息ClientCache

packagecom.gzgs.socketio.common.cache;importcom.corundumstudio.socketio.SocketIOClient;importorg.springframework.stereotype.Component;importjava.util.HashMap;importjava.util.UUID;importjava.util.concurrent.ConcurrentHashMap;/**
 * 这是存储用户的缓存信息
 */@ComponentpublicclassClientCache{//用于存储用户的socket缓存信息privatestaticConcurrentHashMap<String,HashMap<UUID,SocketIOClient>> concurrentHashMap =newConcurrentHashMap<>();//保存用户信息publicvoidsaveClient(String userId,UUID sessionId,SocketIOClient socketIOClient){HashMap<UUID,SocketIOClient> sessionIdClientCache = concurrentHashMap.get(userId);if(sessionIdClientCache ==null){
            sessionIdClientCache =newHashMap<>();}
        sessionIdClientCache.put(sessionId,socketIOClient);
        concurrentHashMap.put(userId,sessionIdClientCache);}//获取用户信息publicHashMap<UUID,SocketIOClient>getUserClient(String userId){return concurrentHashMap.get(userId);}//根据用户id和session删除用户某个session信息publicvoiddeleteSessionClientByUserId(String userId,UUID sessionId){
        concurrentHashMap.get(userId).remove(sessionId);}//删除用户缓存信息publicvoiddeleteUserCacheByUserId(String userId){
        concurrentHashMap.remove(userId);}}

1.2 SocketIOServerHandler

用于监听客户端的建立连接请求和关闭连接请求

packagecom.gzgs.socketio.common.handler;importcom.corundumstudio.socketio.SocketIOClient;importcom.corundumstudio.socketio.SocketIOServer;importcom.corundumstudio.socketio.annotation.OnConnect;importcom.corundumstudio.socketio.annotation.OnDisconnect;importcom.gzgs.socketio.common.cache.ClientCache;importlombok.extern.slf4j.Slf4j;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.stereotype.Component;importjava.util.UUID;@Slf4j@ComponentpublicclassSocketIOServerHandler{@AutowiredprivateClientCache clientCache;/**
     * 建立连接
     * @param client 客户端的SocketIO
     */@OnConnectpublicvoidonConnect(SocketIOClient client){//因为我定义用户的参数为userId，你也可以定义其他名称 客户端请求 http://localhost:9999?userId=12345//下面两种是加了命名空间的，他会请求对应命名空间的方法（就类似你进了不同的房间玩游戏）//因为我定义用户的参数为userId，你也可以定义其他名称 客户端请求 http://localhost:9999/test?userId=12345//因为我定义用户的参数为userId，你也可以定义其他名称 客户端请求 http://localhost:9999/SocketIO?userId=12345String userId = client.getHandshakeData().getSingleUrlParam("userId");//同一个页面sessionid一样的UUID sessionId = client.getSessionId();//保存用户的信息在缓存里面
        clientCache.saveClient(userId,sessionId,client);

        log.info("SocketIOServerHandler-用户id:{},sessionId:{},建立连接成功",userId,sessionId);}/**
     * 关闭连接
     * @param client 客户端的SocketIO
     */@OnDisconnectpublicvoidonDisconnect(SocketIOClient client){//因为我定义用户的参数为userId，你也可以定义其他名称String userId = client.getHandshakeData().getSingleUrlParam("userId");//sessionId,页面唯一标识UUID sessionId = client.getSessionId();//clientCache.deleteUserCacheByUserId(userId);//只会删除用户某个页面会话的缓存，不会删除该用户不同会话的缓存，比如：用户同时打开了谷歌和QQ浏览器，当你关闭谷歌时候，只会删除该用户谷歌的缓存会话
        clientCache.deleteSessionClientByUserId(userId,sessionId);

        log.info("SocketIOServerHandler-用户id:{},sessionId:{},关闭连接成功",userId,sessionId);}}

2、客户端

直接复制建立html文件，在浏览器打开就可以使用了

<!DOCTYPEhtml><html><head><metahttp-equiv="Content-Type"content="text/html; charset=utf-8"/><title>SocketIO客户端测试环境</title><base><scriptsrc="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script><scriptsrc="https://cdn.bootcss.com/socket.io/2.1.1/socket.io.js"></script><style>body{padding: 20px;}#console{height: 450px;overflow: auto;}.connect-msg{color: green;}.disconnect-msg{color: red;}</style></head><body><h1>客户端测试环境</h1><hrstyle="height:1px;border:none;border-top:1px solid black;"/><divstyle="width: 700px;float: left"><h3>SocketClient建立连接</h3><divstyle="border: 1px;"><label>socketio服务端地址:</label><!--

      http://localhost 服务端ip
                  9999 服务端socket端口（服务端提供）
                test或socketIO 命名空间（可自定义）如果不定义命名空间，默认是/     比如：http://localhost:9999?userId=12345
                userId 用户id参数（可自定义）

       ps:因为我定义了命名空间/test和/socketIO，所以我这里也可以用
          http://localhost:9999/test?userId=12345
          http://localhost:9999/socketIO?userId=12345
         这里我用http://localhost:9999?userId=12345建立连接，因为这里还不涉及到请求不同命名空间的方法
      --><inputtype="text"id="url"value="http://localhost:9999?userId=12345"style="width: 500px;"><br><br><buttonid="connect"style="width: 100px;">建立连接</button><buttonid="disconnect"style="width: 100px;">断开连接</button></div><hrstyle="height:1px;border:none;border-top:1px solid black;"/><h3>SocketClient发送消息</h3><divstyle="border: 1px;"><label>socketEvent名称:</label><inputtype="text"id="socketEvent"value="getUserRooms"><br><br><textareaid="content"maxlength="1000"cols="40"rows="5"placeholder="请输入内容"></textarea><buttonid="send"style="width: 100px;">发送消息</button></div><hrstyle="height:1px;border:none;border-top:1px solid black;"/></div><divstyle="float: left;margin-left: 50px;"><h3>SocketIO互动消息</h3><buttonid="clean"style="width: 100px;">清理输出</button><divid="console"class="well"></div></div></body><scripttype="text/javascript">var socket ;var errorCount =0;var isConnected =false;var maxError =5;//连接functionconnect(url){//var opts = {//    query: 'userId='+userId//};//socket = io.connect(url, opts);

        socket = io.connect(url);//socket.nsp = "/socketIO";//定义命名空间

        console.log(socket)//监听本次连接回调函数
        socket.on('connect',function(){
            isConnected =true;
            console.log("连接成功");serverOutput('<span class="connect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>连接成功</span>');
            errorCount=0;});//监听消息
        socket.on('message',function(data){output('<span class="connect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>'+ data +' </span>');
            console.log(data);});//监听断开
        socket.on('disconnect',function(){
            isConnected =false;
            console.log("连接断开");serverOutput('<span class="disconnect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>'+'已下线! </span>');});//监听断开错误
        socket.on('connect_error',function(data){serverOutput('<span class="disconnect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>;'+'连接错误-'+data+' </span>');
            errorCount++;if(errorCount>=maxError){
                socket.disconnect();}});//监听连接超时
        socket.on('connect_timeout',function(data){serverOutput('<span class="disconnect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>'+'连接超时-'+data+' </span>');
            errorCount++;if(errorCount>=maxError){
                socket.disconnect();}});//监听错误
        socket.on('error',function(data){serverOutput('<span class="disconnect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>'+'系统错误-'+data+' </span>');
            errorCount++;if(errorCount>=maxError){
                socket.disconnect();}});/*socket.on('ack', function(data){

            console.log("ack:"+data)
            var str = '消息发送失败';
            if(data==1){
                str = '消息发送成功';
            }
            serverOutput('<span class="connect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>' + str+' </span>');

        });*/}functionoutput(message){var element =$("<div>"+" "+ message +"</div>");$('#console').prepend(element);}functionserverOutput(message){var element =$("<div>"+ message +"</div>");$('#console').prepend(element);}//连接$("#connect").click(function(){if(!isConnected){var url =$("#url").val();connect(url);}else{serverOutput('<span class="disconnect-msg"><font color="blue">'+getNowTime()+'&nbsp;</font>'+'已经成功建立连接，不要重复建立！！！ </span>');}})//断开连接$("#disconnect").click(function(){if(isConnected){
            socket.disconnect();}})//发送消息$("#send").click(function(){var socketEvent =$("#socketEvent").val();//自定义的事件名称var content  =$("#content").val();//发送的内容
        socket.emit(socketEvent,content,function(data1,data2){
            console.log("ack1:"+data1);
            console.log("ack2:"+data2);});})//清理消息$("#clean").click(function(){$('#console').html("");})functiongetNowTime(){var date=newDate();var year=date.getFullYear();//获取当前年份var mon=date.getMonth()+1;//获取当前月份var da=date.getDate();//获取当前日var h=date.getHours();//获取小时var m=date.getMinutes();//获取分钟var s=date.getSeconds();//获取秒var ms=date.getMilliseconds();var d=document.getElementById('Date');var date =year+'/'+mon+'/'+da+' '+h+':'+m+':'+s+':'+ms;return date;}</script></html>

html效果如下：
在这里插入图片描述

3、简单的演示

自己点击建立连接和断开连接按钮测试玩下
ps:http://localhost:9999?userId=12345是没有命名空间的请求
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

三、广播

1、SocketIO基础概念图

SocketIO、namespace（命名空间）、room（房间）的关系如下：
请添加图片描述
SocketIO广播是以namespace或者room为维度的，具体如下：

如果不定义namespace，默认是/
如果定义了namespace，没有定义room，房间默认的名字和namespace一样。

2、定义namespace

在这里插入图片描述

你也可以这样定义
server.addNamespace(“/test”);
server.addNamespace(“/socketIO”);

3、创建namespace所属的Handler

3.1 自定义Handler

packagecom.gzgs.socketio.common.handler;importcom.corundumstudio.socketio.AckRequest;importcom.corundumstudio.socketio.SocketIOClient;importcom.corundumstudio.socketio.annotation.OnEvent;importcom.fasterxml.jackson.core.JsonProcessingException;importlombok.extern.slf4j.Slf4j;importorg.springframework.stereotype.Component;@Slf4j@ComponentpublicclassTestHandler{//测试使用@OnEvent("testHandler")publicvoidtestHandler(SocketIOClient client,String data,AckRequest ackRequest)throwsJsonProcessingException{

        log.info("MyTestHandler:{}",data);if(ackRequest.isAckRequested()){//返回给客户端，说我接收到了
            ackRequest.sendAckData("MyTestHandler",data);}}}

packagecom.gzgs.socketio.common.handler;importcom.corundumstudio.socketio.AckRequest;importcom.corundumstudio.socketio.SocketIOClient;importcom.corundumstudio.socketio.annotation.OnEvent;importcom.fasterxml.jackson.core.JsonProcessingException;importlombok.extern.slf4j.Slf4j;importorg.springframework.stereotype.Component;@Slf4j@ComponentpublicclassSocketIOHandler{//测试使用@OnEvent("socketIOHandler")publicvoidtestHandler(SocketIOClient client,String data,AckRequest ackRequest)throwsJsonProcessingException{

        log.info("SocketIOHandler:{}",data);if(ackRequest.isAckRequested()){//返回给客户端，说我接收到了
            ackRequest.sendAckData("SocketIOHandler",data);}}}

在这里插入图片描述

3.2 监听自定义Handler

在启动类的SocketIO监听里面加入监听
在这里插入图片描述

packagecom.gzgs.socketio;importcom.corundumstudio.socketio.SocketIOServer;importcom.gzgs.socketio.common.handler.SocketIOHandler;importcom.gzgs.socketio.common.handler.TestHandler;importlombok.extern.slf4j.Slf4j;importorg.springframework.beans.factory.DisposableBean;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.boot.CommandLineRunner;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.stereotype.Component;@SpringBootApplicationpublicclassSocketioServerApplication{publicstaticvoidmain(String[] args){SpringApplication.run(SocketioServerApplication.class, args);}}@Component@Slf4jclassSocketIOServerRunnerimplementsCommandLineRunner,DisposableBean{@AutowiredprivateSocketIOServer socketIOServer;@AutowiredprivateTestHandler testHandler;@AutowiredprivateSocketIOHandler socketIOHandler;@Overridepublicvoidrun(String... args)throwsException{//namespace分别交给各自的Handler监听,这样就可以隔离，只有客户端指定namespace，才能访问对应Handler。//比如：http://localhost:9999/test?userId=12345
        socketIOServer.getNamespace("/test").addListeners(testHandler);
        socketIOServer.getNamespace("/socketIO").addListeners(socketIOHandler);
        socketIOServer.start();
        log.info("SocketIOServer==============================启动成功");}@Overridepublicvoiddestroy()throwsException{
        socketIOServer.stop();
        log.info("SocketIOServer==============================关闭成功");}}

3.3演示

3.3.1 正确演示

在这里插入图片描述
在这里插入图片描述

3.3.1 错误演示

在这里插入图片描述

四、常用方法

其他的一些测试我写在下面的代码上，自己去测试才能更好的理解

1、加入房间

//加入房间@OnEvent("joinRoom")publicvoidjoinRooms(SocketIOClient client,String data,AckRequest ackRequest)throwsJsonProcessingException{

        client.joinRoom(data);if(ackRequest.isAckRequested()){//返回给客户端，说我接收到了
            ackRequest.sendAckData("加入房间","成功");}}

2、离开房间

//离开房间@OnEvent("leaveRoom")publicvoidleaveRoom(SocketIOClient client,String data,AckRequest ackRequest)throwsJsonProcessingException{

        client.leaveRoom(data);if(ackRequest.isAckRequested()){//返回给客户端，说我接收到了
            ackRequest.sendAckData("离开房间","成功");}}

3、获取用户所有房间

//获取该用户所有房间@OnEvent("getUserRooms")publicvoidgetUserRooms(SocketIOClient client,String data,AckRequest ackRequest)throwsJsonProcessingException{String userId = client.getHandshakeData().getSingleUrlParam("userId");Set<String> allRooms = client.getAllRooms();for(String room:allRooms){System.out.println("房间名称："+room);}

        log.info("服务器收到消息,客户端用户id：{} | 客户发送的消息：{} | 是否需要返回给客户端内容:{} ",userId,data,ackRequest.isAckRequested());if(ackRequest.isAckRequested()){//返回给客户端，说我接收到了
            ackRequest.sendAckData("你好","哈哈哈");}}

4、发送消息给指定的房间

@OnEvent("sendRoomMessage")publicvoidsendRoomMessage(SocketIOClient client,String data,AckRequest ackRequest)throwsJsonProcessingException{String userId = client.getHandshakeData().getSingleUrlParam("userId");Set<String> allRooms = client.getAllRooms();for(String room:allRooms){
            log.info("房间：{}",room);//发送给指定空间名称以及房间的人，并且排除不发给自己
            socketIoServer.getNamespace("/socketIO").getRoomOperations(room).sendEvent("message",client, data);//发送给指定空间名称以及房间的人，包括自己//socketIoServer.getNamespace("/socketIO").getRoomOperations(room).sendEvent("message", data);;}if(ackRequest.isAckRequested()){//返回给客户端，说我接收到了
            ackRequest.sendAckData("发送消息到指定的房间","成功");}}

5、广播消息给指定的Namespace下所有客户端

//广播消息给指定的Namespace下所有客户端@OnEvent("sendNamespaceMessage")publicvoidsendNamespaceMessage(SocketIOClient client,String data,AckRequest ackRequest)throwsJsonProcessingException{

        socketIoServer.getNamespace("/socketIO").getBroadcastOperations().sendEvent("message",client, data);;if(ackRequest.isAckRequested()){//返回给客户端，说我接收到了
            ackRequest.sendAckData("发送消息到指定的房间","成功");}}

6、点对点发送

//点对点publicvoidsendMessageOne(String userId)throwsJsonProcessingException{HashMap<UUID,SocketIOClient> userClient = clientCache.getUserClient(userId);for(UUID sessionId : userClient.keySet()){
            socketIoServer.getNamespace("/socketIO").getClient(sessionId).sendEvent("message","这是点对点发送");}}
标签： spring boot 后端 java
本文转载自: https://blog.csdn.net/qq407995680/article/details/131956249
版权归原作者 蜗牛+火箭 所有， 如有侵权，请联系我们删除。
登录后发布评论

“日常记录-SpringBoot整合netty-socketio”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

网络安全法-网络运行安全

使用selenium/drissionpage时如何阻止chrome自动跳转http到https

docker desktop 里部署的Open WebUI 管理员密码忘记了的处理方法

在ubuntu20.04中搭建onsite比赛运行环境

利用开源的低代码表单设计器FcDesigner高效管理和渲染复杂表单结构

Kafka学习笔记

【前端】浏览器输入url到页面呈现发生了什么？

文章导航