springboot 集成websocket

阿雷由

已于 2022-07-07 17:55:46 修改

阅读量8.2k

点赞数 3

CC 4.0 BY-SA版权

分类专栏：开发文章标签： websocket spring boot

于 2022-05-29 12:18:29 首次发布

本文为博主原创文章，未经博主允许可以转载。

本文链接：https://blog.youkuaiyun.com/helloexp/article/details/125029306

开发专栏收录该内容

32 篇文章

订阅专栏

本文介绍如何利用SpringBoot实现WebSocket服务，通过三个步骤完成：添加依赖、编写服务端业务逻辑及配置类。文中提供了示例代码及在线测试方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

websocket 协议，作为对于http 的扩展，解决只能客户端发起请求，服务端被动响应的协议，全双工通信，非常好用，这里说一下springboot 中的实现

具体实现很简单，只有以下三步

添加pom 依赖

无需指定websocket 版本，默认使用springboot 版本

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

添加server 端业务逻辑

这里只实现个简单功能，收到客户端消息后，将收到的内容大写后，再返回给客户端

@Slf4j
@Component
@ServerEndpoint("/info")    // 指定websocket 连接的url
public class WebSocketServer {
    @OnOpen
    public void onOpen(Session session) {
        log.info("客户端：{}连接成功",session.getId());
    }

    @OnClose
    public void onClose(Session session) {
        log.info("客户端：{}连接断开",session.getId());

    }

    @OnMessage
    public String onMsg(String message,Session session) {
        log.info("从客户端：{} 收到<--:{}", session.getId(),message);

        String send=message.toUpperCase();
        String result="客户：%s您好，来自server 的消息:%s";
        result = String.format(result, session.getId(), send);
        return "来自server 的消息：" + result;
    }

}

添加websocket 配置类

配置类非常简单，将对象交给spring 容器进行处理

@Slf4j
@Configuration
@EnableWebSocket
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpoint(){
        return new ServerEndpointExporter();
    }

}

功能测试

使用在线测试网站

https://www.dute.org/websocket
http://www.websocket-test.com/

测试截图如下，可以正常使用

客户端界面1

在这里插入图片描述

客户端界面2

在这里插入图片描述

服务端打印内容

2022-05-29 12:13:31.530  INFO 16776 --- [           main] .d.s.w.r.o.CachingOperationNameGenerator : Generating unique operation named: getProductByIdUsingGET_2
2022-05-29 12:13:31.532  INFO 16776 --- [           main] .d.s.w.r.o.CachingOperationNameGenerator : Generating unique operation named: getProductByIdUsingGET_3
2022-05-29 12:13:31.556  INFO 16776 --- [           main] com.kk.MaicaiApplication                 : Started MaicaiApplication in 2.922 seconds (JVM running for 3.889)
2022-05-29 12:13:52.231  INFO 16776 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2022-05-29 12:13:52.232  INFO 16776 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2022-05-29 12:13:52.233  INFO 16776 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 1 ms
2022-05-29 12:13:52.259  INFO 16776 --- [nio-8080-exec-1] com.kk.websocket.WebSocketServer         : 客户端：0连接成功
2022-05-29 12:14:04.214  INFO 16776 --- [nio-8080-exec-4] com.kk.websocket.WebSocketServer         : 从客户端：0 收到<--:aaaa
2022-05-29 12:14:17.699  INFO 16776 --- [nio-8080-exec-3] com.kk.websocket.WebSocketServer         : 客户端：1连接成功
2022-05-29 12:14:23.867  INFO 16776 --- [nio-8080-exec-2] com.kk.websocket.WebSocketServer         : 从客户端：1 收到<--:bbbb
2022-05-29 12:14:28.288  INFO 16776 --- [nio-8080-exec-9] com.kk.websocket.WebSocketServer         : 客户端：1连接断开
2022-05-29 12:14:31.624  INFO 16776 --- [nio-8080-exec-6] com.kk.websocket.WebSocketServer         : 客户端：0连接断开