Springboot2.7集成websocket及相关问题

最新推荐文章于 2024-05-01 12:30:00 发布
最新推荐文章于 2024-05-01 12:30:00 发布
阅读量761 收藏 2
点赞数
分类专栏： java 文章标签： websocket spring boot java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_30719815/article/details/132907229
版权

1、集成websocket完整代码

导入maven依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

服务端代码

（1）注入bean
@Configuration
@EnableWebSocket
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}
（2）服务端开放的服务及其业务逻辑
@Slf4j
@Component
@ServerEndpoint("/testcase/page/{clientId}")
//@Lazy
public class WsMessageService {

    //与某个客户端的连接会话
    private Session session;

    //存放每个客户端对应的WebSocket对象。
    private static Map<String, WsMessageService> webSocketsBeanMap = new ConcurrentHashMap<>();

    //每次连接都是一个新的会话对象，线程安全的
    String userId;

    //注入业务类。要注意setTestcaseService()的名称不能错，set后的字符串要和要注入的变量名一致。
    private static TestcaseService testcaseService;
    @Autowired
    public void setTestcaseService(TestcaseService testcaseService) {
        WsMessageService.testcaseService= testcaseService;
    }

    //private TestcaseService testcaseService = SpringContextUtil.getBean(TestcaseService.class);

    @OnOpen
    public void onOpen(Session session, @PathParam(value = "clientId") String userId) {
        this.session = session;
        this.userId = userId;
        webSocketsBeanMap.put(userId, this);
        log.info("OnOpen连接成功，userId：{}，当前在线人数：{}", userId, this.getOnLineCount());
    }

    @OnMessage
    public void onMessage(String message) throws IOException {
        Session session = webSocketsBeanMap.get(this.userId).session;
        if (session==null || !session.isOpen()) {
            return;
        }
        log.info("收到客户端的消息:" + message);
        //start业务
        Integer pageNum = null;
        Integer pageSize = null;
        String pid = null;
        String vid = null;
        if (session.getRequestParameterMap().get("pageNum")!= null) {
            pageNum = Integer.valueOf(session.getRequestParameterMap().get("pageNum").get(0));
        }
        if (session.getRequestParameterMap().get("pageNum")!= null) {
            pageSize = Integer.valueOf(session.getRequestParameterMap().get("pageSize").get(0));
        }
        if (session.getRequestParameterMap().get("pid")!= null) {
            pid = session.getRequestParameterMap().get("pid").get(0);
        }
        if (session.getRequestParameterMap().get("vid")!= null) {
            vid = session.getRequestParameterMap().get("vid").get(0);
        }
        PageInfo<TestcasePageVO> pageInfo = testcaseService.findTestcaseByMultiCondition(pageNum, pageSize, pid, vid);
        //end业务
        try {
            JSONObject object = new JSONObject();
            object.put("data", pageInfo);
            object.put("code", 200);
            object.put("message", "SUCCESS");
            this.session.getBasicRemote().sendText(String.valueOf(object.toString()));
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    @OnClose
    public void onClose() throws IOException {
        log.info("会话关闭，关闭会话的用户Id为：{}", this.userId);
        webSocketsBeanMap.remove(this.userId);
        log.info("当前在线人数：{}", this.getOnLineCount());
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("连接错误：" + error.getMessage());
        error.printStackTrace();
    }

    private int getOnLineCount() {
        return webSocketsBeanMap.size();
    }
}

测试服务端的可用性。在浏览器的控制台输入以下代码可以测试。

function initWebSocket(wsUri) {
            var websocket = new WebSocket(wsUri);
            websocket.onopen = function(evt) {
                console.log('连接建立中... '+wsUri);
            };
            websocket.onclose = function(evt) {
                console.log('连接关闭中...', evt);
            };
            websocket.onmessage = function(evt) {
                console.log('收到来自服务端的消息：', evt.data);
            };
            websocket.onerror = function(evt) {
                console.log('发生错误...', evt);
            };
            return websocket;
        }
    var websocket = initWebSocket("ws://ip:port/testcase/page/123?pid=5922cc3d03f74012a7112c931c8497d7&vid=fc2d7a6049ff4c7bafc40bf659b4e903");
        var msg, i = 0;
        var loop = setInterval(function(){
            msg = "Hello " +(i++);
            if(websocket.readyState == WebSocket.OPEN) {
                websocket.send(msg);
                console.log('已发送消息：' +msg);
            } else{
                clearInterval(loop);
                console.log('连接已关闭');
            }
        }, 10000);

2、集成websocket另一种方法（用控制台测试时返回的数据会乱码）

代码找不到了。但那种方法有一个特征就是使用的注解比当前的方法少。

3、解决业务类注入不进去的问题（两种方法，推荐第一种）

（1）第一种：就是当前使用的注入方法。注意命名，否则不会注入成功

//注入业务类。要注意setTestcaseService()的名称不能错，set后的字符串要和要注入的变量名一致。
    private static TestcaseService testcaseService;
    @Autowired
    public void setTestcaseService(TestcaseService testcaseService) {
        WsMessageService.testcaseService= testcaseService;
    }

（2）第二种：自己写一个SpringContextUtil工具类，协助注入

package cn.xxxxx.tmMaster.utils;

import lombok.extern.slf4j.Slf4j;
import org.mybatis.logging.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

import java.util.logging.Logger;

@Slf4j
@Component
public class SpringContextUtil implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringContextUtil.applicationContext = applicationContext;
    }

    /**
     * 获取 applicationContext
     */
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    /**
     * 通过 name 获取 bean 对象
     */
    public static Object getBean(String name) {

        return getApplicationContext().getBean(name);
    }

    /**
     * 通过 class 获取 bean 对象
     */
    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    /**
     * 通过 name，clazz  获取指定的 bean 对象
     */
    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }
}

在WsMessageService中使用如下代码注入进去，但在类上必须要@Lazy进行懒加载，否则会报错

@Lazy
public class WsMessageService {
……
    private TestcaseService testcaseService = SpringContextUtil.getBean(TestcaseService.class);
……
}

不加@Lazy报错如下：org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'wsMessageService' defined in file [D:\javaworkspace\test-xxxx\tm-master\target\classes\cn\xxxxx\tmMaster\service\testcase\WsMessageService.class]: Instantiation of bean failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [cn.xxxxx.tmMaster.service.testcase.WsMessageService]: Constructor threw exception; nested exception is java.lang.NullPointerException

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'wsMessageService' defined in file [D:\javaworkspace\test-xxxx\tm-master\target\classes\cn\xxxxx\tmMaster\service\testcase\WsMessageService.class]: Instantiation of bean failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [cn.xxxxx.tmMaster.service.testcase.WsMessageService]: Constructor threw exception; nested exception is java.lang.NullPointerException
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateBean(AbstractAutowireCapableBeanFactory.java:1334) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBeanInstance(AbstractAutowireCapableBeanFactory.java:1232) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:582) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:542) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.AbstractBeanFactory.lambda$doGetBean$0(AbstractBeanFactory.java:335) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:234) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:333) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:955) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:921) ~[spring-context-5.3.29.jar:5.3.29]
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:583) ~[spring-context-5.3.29.jar:5.3.29]
    at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:147) ~[spring-boot-2.7.14.jar:2.7.14]
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:731) [spring-boot-2.7.14.jar:2.7.14]
    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:408) [spring-boot-2.7.14.jar:2.7.14]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:307) [spring-boot-2.7.14.jar:2.7.14]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1303) [spring-boot-2.7.14.jar:2.7.14]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1292) [spring-boot-2.7.14.jar:2.7.14]
    at cn.xxxxx.tmMaster.MasterApplication.main(MasterApplication.java:17) [classes/:na]
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_382]
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:1.8.0_382]
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_382]
    at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_382]
    at org.springframework.boot.devtools.restart.RestartLauncher.run(RestartLauncher.java:50) [spring-boot-devtools-2.7.14.jar:2.7.14]
Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [cn.xxxxx.tmMaster.service.testcase.WsMessageService]: Constructor threw exception; nested exception is java.lang.NullPointerException
    at org.springframework.beans.BeanUtils.instantiateClass(BeanUtils.java:224) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:87) ~[spring-beans-5.3.29.jar:5.3.29]
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateBean(AbstractAutowireCapableBeanFactory.java:1326) ~[spring-beans-5.3.29.jar:5.3.29]
    ... 22 common frames omitted
Caused by: java.lang.NullPointerException: null
    at cn.xxxxx.tmMaster.utils.SpringContextUtil.getBean(SpringContextUtil.java:55) ~[classes/:na]
    at cn.xxxxx.tmMaster.service.testcase.WsMessageService.<init>(WsMessageService.java:48) ~[classes/:na]
    at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method) ~[na:1.8.0_382]
    at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:62) ~[na:1.8.0_382]
    at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:45) ~[na:1.8.0_382]
    at java.lang.reflect.Constructor.newInstance(Constructor.java:423) ~[na:1.8.0_382]
    at org.springframework.beans.BeanUtils.instantiateClass(BeanUtils.java:211) ~[spring-beans-5.3.29.jar:5.3.29]
    ... 24 common frames omitted

参考资料：

SpringBoot集成WebSocket实现客户端与服务端长连接通信_springboot实现websocket客户端_拄杖忙学轻声码的博客-CSDN博客 SpringBoot集成WebSocket实现客户端与服务端长连接通信

快速搭建springboot websocket客户端_springboot实现websocket客户端_wcybaonier的博客-CSDN博客 快速搭建springboot websocket客户端

春季觉醒
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
springboot集成webSocket 通过javax的方式实现
macSun_jh的博客
05-08 1433
pom.xml导入的包 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ...
SpringBoot集成WebSocket长连接实际应用详解
08-19
SpringBoot集成WebSocket长连接实际应用详解 本文主要介绍了SpringBoot集成WebSocket长连接实际应用详解，通过示例代码详细介绍了WebSocket的应用场景和实现方式，对大家的学习或者工作具有一定的参考学习价值。 ...
在Spring Boot 2.7中基于Stomp使用WebSocket与Vue2实现通信
最新发布
大唐锦绣的博客
05-01 262
近期在研究远程遥控空调，需要通过接口记录前端的一些动作，那么前端需要实现主动通知接口，并接收来自接口的通知。
使用Springboot 2.7+Websocket+js实现服务端消息实时推送
龙飞的博客
01-30 1737
在页面中使用JavaScript实现Websocket的前端实现，建立连接，接收并显示消息。在页面关闭时通过JavaScript关闭Websocket连接，以确保连接正常关闭。编写一个WebSocketServer类，实现服务端主动推送消息的逻辑(此处服务端推送客户端消息的逻辑采用定时任务自动推送，模拟服务端主动推送消息给客户端，同时展示客户端发送给客户端的消息以及服务端推送给客户的消息。//防止每次刷新页面产生新的WebSocket连接，在此加入判断。//建立websocket连接。
springboot项目 集成websocket
qq_42038565的博客
02-02 759
/ 8080未默认端口,可自行替换 接口为后端 NoticeWebsocket。// 监听整个过程中websocket的状态。//完成通信后关闭WebSocket连接。// 接听服务器发回的信息并处理展示。// 监听并处理error事件。'接收到来自服务器的消息：'//连接成功则发送一个数据。// 监听连接关闭事件。//监听是否连接成功。
SpringBoot整合 - WebSocket
JavaSE_991226的博客
08-31 111
注入service或者bean。修饰的类中, 无法直接通过。原因及解决方法: 查看。
Springboot 搭建 WebSocket
wsgjcxy13的博客
07-01 546
需求？开玩笑，干就完了！ application.yml： build.gradle WebSocketApplication.java WebSocketConfigurator.java WebSocketConfig.java WebSocketServer.java 后台部分写到这里启动程序基本没什么问题了，idea 直接启动...
spring boot+websocket
04-27
在本文中，我们将深入探讨如何在Spring Boot框架中集成WebSocket技术，以便实现实时通信功能。结合jQuery在前端的应用，可以构建出一个高效、实时的Web应用。首先，让我们了解Spring Boot和WebSocket的基本概念。 ...
SpringBoot集成WebSocket实现前后端消息互传的方法
08-25
在SpringBoot集成WebSocket实现前后端消息互传的方法中，需要注意的一些问题，例如WebSocket的协议升级、长连接的维护、数据传输的加密等问题。在实现时需要详细考察这些问题，确保系统的安全和稳定。 SpringBoot...
springboot集成WebSocket源码
05-14
1. **添加依赖**：在项目中，我们需要添加Spring Websocket相关的依赖。在Maven的pom.xml文件中，可以加入以下依赖： ```xml <groupId>org.springframework.boot <artifactId>spring-boot-starter-websocket ...
springboot+websocket分布式实现
11-17
首先，WebSocket与SpringBoot的集成主要依赖于Spring Framework提供的WebSocket支持。在SpringBoot项目中，可以通过添加`spring-boot-starter-websocket`依赖来启用WebSocket功能。配置WebSocket端点（通常以`@...
SpringBoot 集成WebSocket
m0_67907445的博客
08-29 1441
在海量并发及客户端与服务器交互负载流量大的情况下，极大的节省了网络带宽资源的消耗，有明显的性能优势，且客户端发送和接受消息是在同一个持久连接上发起，实现了“真·长链接”，实时性优势明显。* 要注意，如果项目使用外置的servlet容器，而不是直接使用springboot内置容器的话，就不要注入ServerEndpointExporter，因为它将由容器自己提供和管理。长轮询的间隔期一般很长，例如 30s、60s，并且服务端 hold 住连接不会消耗太多服务端资源。降低轮询的间隔，延迟降低，压力增加；
Springboot 整合 WebSocket
原名：@程序员大禹
11-16 8916
WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工（full-duplex）通信，即允许服务器主动发送信息给客户端。因此，在WebSocket中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输，客户端和服务器之间的数据交换变得更加简单。
spring boot学习第六篇:SpringBoot 集成WebSocket详解
heming20122012的专栏
01-09 2679
WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。
SpringBoot项目整合WebSocket+netty实现前后端双向通信（同时支持前端webSocket和socket协议哦）
小米吃辣椒的博客
07-03 7550
最近做了一个硬件设备通信项目，需求是这样，前端使用webSocket向后端进行tcp协议的通信，后端netty服务端收到数据后，将数据发往socket客户端，客户端收到数据之后需要进行响应数据显示到前端页面供用户进行实时监控。
【Java】Spring Boot整合WebSocket
微信公众号: 后端码匠
03-05 3335
WebSocket是一种协议，用于实现客户端和服务器之间的双向通信。它可以在单个TCP连接上提供全双工通信，避免了HTTP协议中的请求-响应模式，从而实现更高效的数据交换。WebSocket协议最初由HTML5规范提出，现在已成为一种通用的网络协议，被广泛用于Web应用程序中。WebSocket协议在Web应用程序中广泛使用，例如实现实时通信、在线游戏、即时消息等功能。
SpringBoot集成WebSocket--------Spring方式集成（一）
豢龙先生
06-29 5330
二、配置 1、WebSocketConfigurer配置器 2、@EnableWebSocket注解 （1）注解引入一个配置类DelegatingWebSocketConfiguration.class （2）DelegatingWebSocketConfiguration配置类会被容器自动加载，同时会注入容器中所有的WebSocketConfigurer实现到configurers中；同时registerWebSocketHandlers()方法会遍历configurers并回调所有WebSocketC
SpringBoot——SpringBoot集成WebSocket实现简单的多人聊天室
★★光亭★★
06-20 9918
SpringBoot——SpringBoot集成WebSocket实现简单的多人聊天室
Springboot集成websocket踩坑备忘
Di Qiang 的博客
07-08 1591
最近使用spring websocket做个简单的实时交互功能，发现使用@ServerEndpoint注解配置完 websocket服务后前端无法建立连接，排查问题绕了弯路最后发现是忘记了配置Bean ServerEndpointExporter （因为websocket依赖于web容器，当使用springboot内置web容器时无论是tomcat还是undertow都必须定义此Bean才能扫描到@ServerEndpoint标注的类，如果使用独立的servlet容器，而不是直接使用springboot的
springboot vue集成websocket
09-20
在Spring Boot中集成WebSocket可以通过以下步骤实现： 1. 首先，在pom.xml文件中添加WebSocket的依赖： ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 创建一个WebSocketConfig类，用于配置WebSocket相关的参数和处理器： ``` @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(new WebSocketHandler(), "/websocket"); // 指定WebSocket处理器和连接的路径 } } ``` 3. 创建一个WebSocketHandler类，实现WebSocketHandler接口： ``` @Component public class WebSocketHandler extends TextWebSocketHandler { private static final List<WebSocketSession> sessions = new CopyOnWriteArrayList<>(); @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { sessions.add(session); } @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { // 处理收到的文本消息 String payload = message.getPayload(); // 发送消息给所有连接的客户端 for (WebSocketSession webSocketSession : sessions) { webSocketSession.sendMessage(new TextMessage(payload)); } } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { sessions.remove(session); } } ``` 4. 在Vue中使用WebSocket连接服务器： ``` new Vue({ created() { this.socket = new WebSocket('ws://localhost:8080/websocket'); this.socket.onmessage = this.handleMessage; }, methods: { handleMessage(event) { // 收到消息后的处理逻辑 } } }) ``` 以上是Spring Boot和Vue集成WebSocket的基本步骤。通过配置WebSocketConfig类和创建WebSocketHandler类实现服务器端的消息处理和推送，然后在Vue中创建WebSocket对象进行连接并处理收到的消息。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值