SpringBoot集成SocketIO

已于 2022-11-14 18:21:10 修改
阅读量4.9k 收藏 19
点赞数
分类专栏： SpringBoot集成 文章标签： spring boot java spring
于 2022-09-18 15:20:31 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43334498/article/details/126917544
版权

一.快速入门

1.导依赖

        <!-- socket.io依赖-->
        <dependency>
            <groupId>com.corundumstudio.socketio</groupId>
            <artifactId>netty-socketio</artifactId>
            <version>1.7.7</version>
        </dependency>

        <dependency>
            <groupId>io.socket</groupId>
            <artifactId>socket.io-client</artifactId>
            <version>1.0.0</version>
        </dependency>

2.在配置文件中做一些配置

这个配置写在服务端，客户端不用写，主要是一些socket.io的配置信息。

#socket.io配置
socketio.host=127.0.0.1(别写localhost，写服务器的ip)
socketio.port=9999
# 设置最大每帧处理数据的长度，防止他人利用大数据来攻击服务器
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

3.用上面配置文件中的信息创建Bean对象(服务端)

package com.guguo.config;

import com.corundumstudio.socketio.SocketConfig;
import com.corundumstudio.socketio.SocketIOServer;
import com.corundumstudio.socketio.annotation.SpringAnnotationScanner;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@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;

    @Bean
    public 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);
    }

    //这个对象是用来扫描socketio的注解，比如 @OnConnect、@OnEvent
    @Bean
    public SpringAnnotationScanner springAnnotationScanner() {
        return new SpringAnnotationScanner(socketIOServer());
    }
}

4.写Handler,里面包含了处理基本事件的方法(服务端)


import com.corundumstudio.socketio.SocketIOClient;
import com.corundumstudio.socketio.SocketIOServer;
import com.corundumstudio.socketio.annotation.OnConnect;
import com.corundumstudio.socketio.annotation.OnDisconnect;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;


@Slf4j
@Component
public class SocketIOHandler {
    @Autowired
    private SocketIOServer socketIoServer;//服务端对象

    //Spring IoC容器创建之后，在加载SocketIOService Bean之后启动
    //服务端启动
    @PostConstruct
    private void autoStartup() throws Exception {
        try {
            socketIoServer.start();
        }catch (Exception ex){
            ex.printStackTrace();
            log.error("SocketIOServer启动失败");
        }
    }

    //Spring IoC容器在销毁SocketIOService Bean之前关闭,避免重启项目服务端口占用问题
    //服务端关闭
    @PreDestroy
    private void autoStop() throws Exception {
        socketIoServer.stop();
    }

    //客户端连接的时候触发
    @OnConnect
    public void onConnect(SocketIOClient client) {
        String username = client.getHandshakeData().getSingleUrlParam("userName");
        SocketIOService.clientMap.put(username,client);
        //客户端:/127.0.0.1:64540  sessionId:9acac9ab-a000-43a7-bf97-31fac791e4f4 username: 张三已连接
        log.info("客户端:" + client.getRemoteAddress() + "  sessionId:" + client.getSessionId() +" username: "+ username+ "已连接");
    }

    //客户端关闭连接时触发
    @OnDisconnect
    public void onDisconnect(SocketIOClient client) {
        //客户端:9acac9ab-a000-43a7-bf97-31fac791e4f4断开连接
        log.info("客户端:" + client.getSessionId() + "断开连接");

    }

}

5.客户端测试,Controller层代码：

import com.itheima.boot.service.SocketIOClientService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;

@RestController
public class SocketIOClientController {
    @Autowired
    private SocketIOClientService socketIOClientService;
    //测试和服务端的连接
    @GetMapping("/testConnect")
    public void testConnect() throws IOException {
        socketIOClientService.sendMessage("张三");
    }
}

6.客户端测试,Service层代码：

package com.itheima.boot.service;

import io.socket.client.IO;
import io.socket.client.Socket;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

@Slf4j
@Service
public class SocketIOClientService{
    public void sendMessage(String name) {
        // 服务端socket.io连接通信地址
        String url = "http://127.0.0.1:9999?userName="+name;
        System.out.println("lalalala");
        try {
            IO.Options options = new IO.Options();
            options.transports = new String[]{"websocket"};
            //失败后重试次数
            options.reconnectionAttempts = 2;
            // 失败重连的时间间隔
            options.reconnectionDelay = 1000;
            // 连接超时时间(ms)
            options.timeout = 500;

            final Socket socket = IO.socket(url, options);

            socket.connect();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

7.结果

二.服务端发数据，客户端接收

1.服务端Controller代码

package com.guguo.controller;

import com.guguo.service.SocketIOService;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SocketIOController {
    @Autowired
    private SocketIOService socketIOService;

    @GetMapping("/sendMessage")
    public void sendMessage(String message){
        socketIOService.sendMessageToAllUsers(message);
    }
    
}

2.服务端Service代码

import com.corundumstudio.socketio.SocketIOClient;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

@Slf4j
@Service
public class SocketIOService {
    //使用ConcurrentMap来存储客户端
    public static Map<String, SocketIOClient> clientMap = new ConcurrentHashMap<>();

    //给每个事件进行定义，用于客户端和服务端之间的通信
    private static final String TEST_EVENT = "test_event";

    //给容器内所有的客户端发送信息
    public void sendMessageToAllUsers(String message){
        if(clientMap.isEmpty()){
            return;
        }
        for(String key:clientMap.keySet()) {
            SocketIOClient socketIOClient = clientMap.get(key);
            socketIOClient.sendEvent(TEST_EVENT,message);
        }
    }

}

3.客户端接收代码

package com.itheima.boot.service;


import io.socket.client.IO;
import io.socket.client.Socket;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

@Slf4j
@Service
public class SocketIOClientService{
    public void sendMessage(String name) {
        // 服务端socket.io连接通信地址
        String url = "http://127.0.0.1:9999?userName="+name;
        try {
            IO.Options options = new IO.Options();
            options.transports = new String[]{"websocket"};
            //失败后重试次数
            options.reconnectionAttempts = 2;
            // 失败重连的时间间隔
            options.reconnectionDelay = 1000;
            // 连接超时时间(ms)
            options.timeout = 500;
            final Socket socket = IO.socket(url, options);

            //客户端监听某个事件,这个是系统定义的事件(链接事件)
            socket.on(Socket.EVENT_CONNECT, message -> System.out.println("连接成功"));

            // 自定义事件`test_event` -> 接收服务端成功连接消息
            socket.on("test_event", objects -> System.out.println(objects[0].toString()));
            socket.connect();

            while (true) {
                Thread.sleep(4000);
                // 向服务端发送消息
                socket.emit("push_data_event", "发送数据 " + "oejfjefwfwefw");
            }

        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

4.注意问题和结果展示

服务端的逻辑是，向所有已经连接的客户端发送数据。所以，客户端要先向服务端发送请求连接，连接之后服务端将该客户端存到本地，然后再执行发送数据的逻辑。

客户端控制台：

 服务端控制台：

别是雨萧吧
关注
  • 0
    点赞
  • 踩
  • 19
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SocketIO介绍+SpringBoot整合SocketIO完成实时通信
目标检测专栏持续更新中，改进YOLO系列通用，适用v5、v7、v8、所有博客均是团队原创博客，所有文章禁止转载，违者必究。
08-02 9458
即时通信是基于TCP长连接，建立连接之后，客户段/服务器可以无限次随时向对端发送数据，实现服务器数据发送的即时性。
springboot集成socketio
angeltangc的博客
12-07 908
不说废话，直接上干货，代码只贴关键代码。后端使用netty-socketio。前端 使用html+js。socketio启动类。socketio配置类。
详细介绍一下Socket.IO是什么
u012903034的博客
06-23 927
Socket.IO 是一个强大且灵活的库，通过提供对WebSocket及其回退机制的封装，实现了跨平台的实时双向通信。它的自动回退机制、事件驱动模型、命名空间和房间功能使得它非常适合于需要实时通信的应用，如聊天室、实时协作工具和在线游戏等。通过以上的介绍和示例代码，可以帮助开发者快速上手并实现稳定可靠的实时通信功能。
springboot集成socketIo，实现webSocket
weixin_43241706的博客
12-18 3181
之前都是使用http接口请求，最近有用到WebSocket的场景，客户端之间长连接通讯，记录一下spring boot整合socketIO的过程。 国际惯例，引入依赖 application.yml（或者是application.properties）配置文件添加socketIo配置 添加socketIoConfig配置类 @Configuration public class SocketConfig { private static final Logger logger = Logge
springboot集成socketIo遇到的问题
lin351550660的专栏
06-03 1144
不知道为什么 不设置通讯方式为 transports:['websocket'] 会包跨域问题，而且是是好是坏 没有头绪，网上找了一堆解决跨域的文章一个都不好用。这里host配置，一开始我配置成 localhost或者127.0.0.1，或者具体ip，后面发现 0.0.0.0 可以通配（解决问题2）2、nginx（https）+K8S+docker+springboot（集群）+socket集成后，端口开放问题。nginx配置k8s的pod被外部访问到（半成品没用 k8s的ingress）
Vue3和SpringBoot集成SocketIO（WebSocket）
weixin_43292559的博客
08-24 1423
由于公司业务需要，需要使用WebSocket发送消息提示，但一开始的技术选型是使用SocketIO，但由于SocketIO独占一个端口，所以就放弃了，但是换原生WebSocket之前已经把SocketIO全部测试ok了，所以今天就把SocketIO和WebSocket一起过一遍。使用的过程也都参考其他文章，这里主要记录一下自己的使用思路以及方法。下面开始我们今天的学习吧！这些我也是看着其他帖子实现的，大体思路差不多，细节不太一样，实现还是没问题的。
springboot集成SocketIO实时通信
热门推荐
王人冉的博客
04-27 1万+
https://blog.csdn.net/zsj777/article/details/83212776 概述 基于 socket.io 来说，采用 node 实现更加合适，本文使用两个后端的Java开源框架实现。 服务端使用 netty-socketio 客户端使用 socket.io-client-java 业务需求是将之前通过轮询方式调动RESTFul API改成使用WebSocket长连...
springboot实现socketio
qq_36532060的博客
04-27 636
springboot实现socketio
java中springboot项目集成socketIo实现实时推送
zhuguang10的博客
03-20 1250
今天在这里跟大家分享一下springboot项目集成socketIo实现实时推送功能。不多说什么直接上代码，然后慢慢讲解。 第一步项目中准备socketIo的运行环境 <dependency> <groupId>com.corundumstudio.socketio</groupId> <artifactId&g...
springboot集成datax的demo
08-26
springboot集成datax的demo，下载及能运行
Springboot集成activity过程图解
08-19
Springboot集成Activity过程图解 Springboot集成Activity过程图解是指将Activiti Workflow引擎集成到Springboot应用程序中，以便于在应用程序中使用工作流引擎来管理和自动化业务流程。下面是Springboot集成...
SpringBoot集成各种功能合集
04-07
这个"SpringBoot集成各种功能合集"很可能是一个包含上述各种功能的示例项目，通过`springboot-inter-function-master`这个文件夹，开发者可以学习如何在SpringBoot项目中实际应用这些功能，加深对SpringBoot的理解和...
基于springboot集成hbase过程解析
08-25
"基于SpringBoot集成HBase过程解析" SpringBoot集成HBase是当前大数据处理和存储解决方案中的一种常见组合。HBase是基于Hadoop的分布式、可扩展的NoSQL数据库，能够存储大量的结构化和非结构化数据。SpringBoot则...
Springboot集成restTemplate过程详解
08-19
主要介绍了Springboot集成restTemplate过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Spring Boot + Shiro 实现 Session 持久化实现思路及遗留问题
DN金猿的博客
07-23 167
从这个角度而言，我们可以通过 Session 监听器监听 Session 创建销毁，属性变更，并将所有创建的SessionId 存储起来，当要踢出某个用户时，用户的Request请求到来时判断Request中SessionId是否一致，一致的话令Session失效，从而实现这个功能！6、上图显示，我们可以拿到所有获得的session，并且内部用户信息无误，此时我们只需要将上述代码中的（1）、（2）打开在完全遵守Shiro的应用规则下理应可以删除对应用户！在用户基础服务中，需要实现删除用户功能。
Spring Boot停车场管理系统方案设计：实现车辆进出场的自动识别与记录
qq_40623672的博客
07-22 887
本文是记录最近接的一个单子项目的设计方案，并且已经投入使用，所以简述一下架构思路，可以借鉴来设计其他项目。
布隆过滤器：大数据的高效守门员（在 Spring Boot 项目中实现布隆过滤器）
最新发布
weixin_68020300的博客
07-23 1404
探讨布隆过滤器这一概率数据结构如何通过节省空间和加速查询，在大数据处理中扮演关键角色。文章分析其工作原理，以及在缓存、数据库和网络应用中的实践案例，展示如何用Google Guava库在Java环境构建布隆过滤器，实现数据处理的高效优化。
配置三个Spring Boot应用并通过Nginx进行反向代理 讨论中
wangqiaowq的博客
07-23 393
这样，你就有了三个通过Nginx反向代理的Spring Boot应用，每个应用都运行在不同的容器中，并且可以通过各自的路径前缀访问。确保每个Spring Boot应用都有不同的端口号。例如，你可以设置第一个应用监听8080端口，第二个监听8081端口，第三个监听8082端口。然后分别为每个应用构建Docker镜像，使用不同的Dockerfile或者在同一个Dockerfile中通过ARGs参数来区分不同应用的构建。编辑Nginx配置文件，使每个Spring Boot应用都有自己的。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值