SpringBoot集成websocket作为客户端和服务端的代码案例

最新推荐文章于 2024-07-29 13:25:32 发布
置顶 最新推荐文章于 2024-07-29 13:25:32 发布
阅读量2.5k 收藏 22
点赞数 30
分类专栏： springboot 文章标签： spring boot websocket 后端 websocket服务端 websocket客户端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hou_zi/article/details/136911831
版权
本文介绍了如何在SpringBoot项目中集成WebSocket，实现服务器主动向客户端推送数据，以及作为服务端和客户端的代码实现步骤。涵盖了WebSocket的基本概念、使用场景以及在前后端分离项目中的具体操作。
摘要由CSDN通过智能技术生成

websocket介绍：

WebSocket是一种在单个TCP连接上进行全双工通信的协议，允许服务端和客户端之间进行实时、双向的数据传输。

  • 长连接：WebSocket建立连接后，只要不关闭，会一直保持连接状态，使得服务器可以主动向客户端推送数据。
  • 双向通信：与HTTP请求-响应模式不同，WebSocket支持双向通信，即客户端和服务端都可以发送或接收数据。

使用场景：

在需要实时交互的场景中使用，例如聊天应用，实时数据推送，内容流式输出等。可实现实时向客户端进行数据推送。

1、SpringBoot集成websocket作为服务端

在前后端分离的项目中，前端作为websocket的客户端，后端服务作为websocket的服务端。

实现步骤：

  1. 添加websocket整合包

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

  2. 编写websocket配置类，暴露WebSocket

    @Configuration
public class WebSocketConfig {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

  3. 编写websocket服务监听程序及处理逻辑

    package com.houdehong.wsserver.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;

/**
 * @Author houdehong
 * @Date 2024/3/21 14:16
 * @Description
 **/
@Component
@ServerEndpoint("/api/ws/{sid}")
@Slf4j
public class WebSocketServer {

    private String sid;

    private static final ConcurrentHashMap<String, Session> SESSION_MAP = new ConcurrentHashMap<>();

    /**
     * 连接成功
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("sid") String sid) {
        this.sid = sid;
        SESSION_MAP.put(sid, session);
        log.info("有新连接：sid：{}，sessionId：{}，当前连接数：{}", sid, session.getId(), SESSION_MAP.size());
    }

    /**
     * 连接关闭
     */
    @OnClose
    public void onClose(Session session) {
        SESSION_MAP.remove(this.sid);
        log.info("连接关闭，sid：{}，session id：{}！当前连接数：{}", this.sid, session.getId(), SESSION_MAP.size());
    }

    /**
     * 收到消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("收到消息：{}，内容：{}", sid, message);
        if("ping".equals(message)){
            try {
                session.getBasicRemote().sendText("pong");
            } catch (IOException e) {
                log.error("onMessage 推送消息失败：{}，内容：{}", sid, message);
            }
        }else{
            // 排除自己
           // sendMeasureDataInfoExcludeSelf(message, sid);
            // 发给所有客户端包括自己
            sendMeasureDataInfo(message);
        }
    }


    /**
     * 连接错误
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("{} 发生错误", session.getId(), error);
    }

    /**
     * 群发消息
     */
    public void sendMeasureDataInfo(String message) {
        for (String sid : SESSION_MAP.keySet()) {
            Session session = SESSION_MAP.get(sid);
            try {
                session.getBasicRemote().sendText(message);
            } catch (IOException e) {
                log.error("推送消息失败：{}，内容：{}", sid, message);
            }
            log.info("推送消息：{}，内容：{}", sid, message);
        }
    }

    /**
     * 群发消息，排除消息发起者
     * @param message
     * @param sidSelf
     */
    private void sendMeasureDataInfoExcludeSelf(String message, String sidSelf){
        for(String sid : SESSION_MAP.keySet()){
            if(sidSelf.equals(sid)){
                continue;
            }
            Session session = SESSION_MAP.get(sid);
            try {
                session.getBasicRemote().sendText(message);
            } catch (IOException e) {
                log.error("sendMeasureDataInfoExcludeSelf 推送消息失败：{}，内容：{}", sid, message);
            }
            log.info("sendMeasureDataInfoExcludeSelf 推送消息：{}，内容：{}", sid, message);
        }
    }
}

  4. 测试

    至此，springboot整合websocket作为服务就搭建完成了，我们可以随便百度打开一个在线的websocket测试工具，请求一下试试，请求地址是ws://ip:port/api/ws/{sid}, 其中sid可以随便指定一个字符串，这里的sid主要是用来区分客户端，实际场景下可以在前端生成全局唯一的标识。

    图片：
    在这里插入图片描述控制台打印信息：
    在这里插入图片描述

2、SpringBoot集成websocket作为客户端

有时，我们需要调用第三方的websocket服务，然后将接收到的数据处理之后，或持久化到数据库，或是需要解析数据重新封装为前端需要的数据结构，这个时候我们就需要作为客户端来进行使用。

实现步骤：

  1. 添加springboot服务作为客户端的依赖

    <dependency>
    <groupId>org.java-websocket</groupId>
    <artifactId>Java-WebSocket</artifactId>
    <version>1.3.8</version>
</dependency>

  2. 继承WebSocketClient，重写方法，加入自己的逻辑

    @Slf4j
public class MyWebSocketClient extends WebSocketClient {

    public MyWebSocketClient(URI serverUri) {
        super(serverUri);
    }

    @Override
    public void onOpen(ServerHandshake arg0) {
        log.info("------ WebSocketClient onOpen ------");
    }

    @Override
    public void onClose(int arg0, String arg1, boolean arg2) {
        log.info("------ WebSocket onClose ------{}",arg1);
    }

    @Override
    public void onError(Exception arg0) {
        log.error("------ WebSocket onError ------{}",arg0);
    }

    @Override
    public void onMessage(String response) {
        log.info("-------- 接收到服务端数据： " + response + "--------");
    }

}

  3. 获取websocketClient实例

    在这里我写的wsServerUrl即为上面websocket作为服务端的地址

    @Component
public class WebSocketClientConfigurer {

    private final String wsServerUrl = "ws://127.0.0.1:8081/api/ws/123wer";

    @Bean
    public WebSocketClient webSocketClient() {
        try {
            MyWebSocketClient webSocketClient =
                    new MyWebSocketClient(new URI(wsServerUrl));
            webSocketClient.connect();
            return webSocketClient;
        } catch (URISyntaxException e) {
            e.printStackTrace();
        }
        return null;
    }

}

  4. 为了好演示我加了一个controller来进行调用

    @RestController
@RequestMapping("ws-client")
public class WebsocketClient {

    @Resource
    private MyWebSocketClient webSocketClient;

    @GetMapping("send/{message}")
    public void sendRequest(@PathVariable String message){
        webSocketClient.send(message);
    }
}

3. 测试

至此，我们已经搭好了一个websocket的服务器和一个websocket的客户端，我们可以同时把这两个服务跑起来，做一个调用。
注意：需要先启动服务端，再启动客户端，客户端会无法创建连接，报空指针异常。
服务端启动：
在这里插入图片描述客户端启动：
在这里插入图片描述现在我们向客户端的controller请求一个消息：
你可以用postman或者其他api工具，我现在图简单直接在浏览器发起：

在这里插入图片描述客户端控制台日志：

在这里插入图片描述服务端控制台日志：
在这里插入图片描述OK，大功告成。
整套源码包地址

侯德红
关注
  • 30
    点赞
  • 踩
  • 22
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
SpringBoot集成websocket作为客户端和服务端的代码案例完整源码
03-21
SpringBoot集成websocket作为客户端和服务端的代码案例完整源码。 springboot + maven 多模块项目。 开箱即用，注意启动时先启动WebsocketServerApplication，再启动WebsocketClientApplication。
【Java】SpringBoot快速整合WebSocket实现客户端服务端相互推送信息
m0_64210833的博客
12-26 5960
SpringBoot快速整合WebSocket，内涵详细代码加测试（跑不起来来打我）
02. Springboot实现websocket
kezhou的博客
05-22 1316
Java WebSocket 应用由一系列 Endpoint 组成。Endpoint 是一个 Java 对象，代表 WebSocket 链接的一端，对于服务端，我们可以视为处理具体 WebSocket 消息的接口。Endpoint 实例在 WebSocket 握手时创建，并在客户端与服务端链接过程中有效，链接关闭时结束。编写 WebSocketConfig 配置类，扫描添加了 @ServerEndpoint 注解的Bean。在定义 Endpoint 时，通过 @OnMessage 注解指定接收消息的方法。
基于springboot实现websocket客户端和服务端
04-29
环境配置 开发环境配置为： JDK 8 IntelliJ IDEA 2020.1.2 x64 Springboot集成的Websocket 使用Springboot集成的websocket需要使用到以下几个类/接口： WebSocketHandler：WebSocket消息以及生命周期事件的处理器。 WebSocketConfigurer：对WebSocket进行配置，包括配置拦截器、配置接口地址。 HttpSessionHandshakeInterceptor：拦截器，可以对Websocket通信过程中的请求进行拦截处理。 除了上述三个官方提供的类/接口之外，我们还需要实现一个WebSocket的包装类，用于为每一个WebSocket实例添加额外的信息，比如客户端的ID。在Spring内，WebSocket实例以WebSocketSession形式存在，每个session都代表了一个服务端与客户端的会话。
基于SpringBoot实现WebSocket实时通讯的服务端和客户端
户伟伟的博客
03-20 792
实现服务端注册的客户端的列表；服务端向客户端发送广播消息；服务端向指定客户端发送消息；服务端向多个客户端发送消息；客户端给服务端发送消息；
Spring WebSocket实现实时通信的详细教程
lucky_fd的博客
01-18 1801
WebSocket 是基于TCP/IP协议，独立于HTTP协议的通信协议。WebSocket 连接允许客户端和服务器之间的全双工通信，以便任何一方都可以通过已建立的连接将数据推送到另一方。我们常用的HTTP是客户端通过「请求-响应」的方式与服务器建立通信的，必须是客户端主动触发的行为，服务端只是做好接口被动等待请求。而在某些场景下的动作，是需要服务端主动触发的，比如向客户端发送消息、实时通讯、远程控制等。
SpringBoot集成WebSocket长连接实际应用详解
08-19
本文主要介绍了SpringBoot集成WebSocket长连接实际应用详解，通过示例代码详细介绍了WebSocket的应用场景和实现方式，对大家的学习或者工作具有一定的参考学习价值。 一、WebSocket概述 WebSocket是一种在单个TCP...
SpringBoot集成WebSocket实现前后端消息互传的方法
08-25
WebSocketServer是类似客户端服务端的形式（采用ws协议），那么这里的WebSocketServer其实就相当于一个ws协议的Controller。直接@ServerEndpoint("/websocket")、@Component启用即可，然后在里面实现@OnOpen、@...
websocket客户端和服务端
03-18
总的来说，WebSocket为Web应用程序提供了强大的实时通信能力，`WebSocketClient.java`和`WebSocketServer.java`是实现这一功能的核心代码，它们共同确保了客户端和服务器之间的高效交互。在开发WebSocket应用时，...
SpringBoot集成WebSocket实现客户端与服务端通信
lizjf
01-17 1887
2、自定义WebSocket客户端，继承WebSocketClient类，实现发送、接收等功能。3、创建连接封装类，uri对应socket服务的ip和端口号。2、添加配置文件 WebSocketConfig。3、编写WebSocket服务端接收、发送功能。话不多说，直接上代码看效果！
SpringBoot集成websocket（1）|（websocket客户端实现）
Oaklkm的博客
05-17 1964
WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。以上就是SpringBoot集成websocket客户端的内容，用于后端服务调用websocket请求。具体业务逻辑执行在代码中自己实现，这里只是给了具体的demo和实例。
1.Spring Boot 简介(Spring MVC+Mybatis-plus)
m0_61086522的博客
07-23 973
SpringBoot是Spring的子工程(或是spring的脚手架),快速搭建spring项目,自动配置了Spring 应用程序和第三方库（spring+mybaties+web（servlet）+ reids+ 消息中间件）,而且使用很少xml配文件，提高开发效率。一款基于mvc模式、请求驱动、轻量级web框架（封装了Servlet）给予MVC模式请求驱动轻量级web框架封装了Servlet程序。
{Spring Boot 原理篇} Spring Boot自动装配原理
yyd686874的博客
07-24 1327
1，Spring Boot 应用启动，@SpringBootApplication标注的类就是启动类，它去实现配置类中的Bean的自动装配 2，而@SpringBootApplicatiozn注解中包含了三个注解：@SpringBootConfiguration @EnableAutoConfiguration @ComponentScan @SpringBootConfiguration 这个注解包含了@Configuration，@Configuration里面又包含了一个@Component
Spring Boot集成Spring Batch快速入门Demo
HBLOG
07-20 1363
Spring Batch 是一个轻量级的开源框架，它提供了一种简单的方式来处理大量的数据。它基于Spring框架，提供了一套批处理框架，可以处理各种类型的批处理任务，如ETL、数据导入/导出、报表生成等。Spring Batch提供了一些重要的概念，如Job、Step、ItemReader、ItemProcessor、ItemWriter等，这些概念可以帮助我们构建可重用的批处理应用程序。
在Spring Boot中实现文件上传与管理
微赚淘客开发者博客
07-20 1435
在现代应用程序中，文件上传与管理是一个常见的需求。在 Spring Boot 中，可以非常方便地实现文件上传和管理。本文将详细介绍如何在 Spring Boot 中实现文件上传功能，包括创建上传接口、文件存储、文件访问等方面的内容。通过配置文件上传、创建文件上传、下载、列表和删除接口，我们可以轻松地处理文件操作。这个 HTML 文件提供了一个简单的文件上传表单，用户可以选择文件并提交上传请求。中添加相关的依赖，以支持文件上传功能。接下来，我们创建一个文件上传的控制器，处理文件上传请求。作为文件上传的对象。
easyui 多文件上传，demo
最新发布
极客栈
07-29 339
通过上述示例代码，你可以使用 EasyUI 实现多文件上传功能。确保前后端配合良好，以便正确处理文件上传请求并返回相应的结果。
TCP请求如何获取客户端真实源IP地址
ajax_beijing_java的博客
07-29 339
针对四层的TCP请求（TCP监听器），可以通过在后端主机配置TOA插件获取客户端的真实源IP地址。TOA是操作系统的内核模块，需要在ELB后端主机中安装TOA插件，以实现后端主机可获取客户端真实源IP地址的目的。c. 编译过程若未提示warning或者error，说明编译成功，检查当前目录下是否已经生成toa.ko文件。假如提示信息中包含“TOA: toa loaded”，则证明内核模块已经加载成功。f. 以下步骤是以Ubuntu、Debian环境为例，进行编译环境准备。主备、集群模式资源池列表见。
JavaWeb学习——请求响应、分层解耦
ping12138的博客
07-25 915
学习响应数据的设置。注：对于响应结果的设置我们一般有统一的模板规范，以便于后续前后端交流。");// }//// addr.setProvince("广东");// addr.setCity("深圳");// }//// addr.setProvince("广东");// addr.setCity("深圳");//// }");addr.setProvince("广东");addr.setCity("深圳");
后端采用SpringBoot框架开发的：ADR药物不良反应智能监测系统源码，用于监测和收集药品在使用过程中发生的不良反应的系统
baina666的博客
07-26 534
ADR药物不良反应智能监测系统的优势在于其能够快速、准确地识别潜在的不良反应事件，并及时采取相应的措施，从而减少药害事故的发生，保障公众用药安全。该系统基于医院临床数据中心，运用信息技术实现药品不良反应的智能监测、报告管理、知识库查询、统计分析等功能，旨在提高药品使用的安全性和患者的用药安全。：系统能够自动从各个数据源（如电子病历、实验室信息系统、药房管理系统等）收集相关的患者数据、药品使用信息和不良反应报告，并进行整合和清洗，以确保数据的准确性和一致性。
springboot集成websocket客户端
07-20
在Spring Boot中集成WebSocket客户端，你可以按照以下步骤进行操作： 1. 引入依赖：在你的项目的pom.xml文件中添加以下依赖： ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 创建WebSocket配置类：创建一个WebSocketConfig类，用于配置WebSocket相关的bean。可以按照以下示例进行配置： ```java @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myWebSocketHandler(), "/websocket-url").setAllowedOrigins("*"); } @Bean public WebSocketHandler myWebSocketHandler() { return new MyWebSocketHandler(); } } ``` 在上述示例中，我们定义了一个名为`myWebSocketHandler`的WebSocket处理程序，并将其映射到`/websocket-url`路径。你可以根据自己的需求进行修改。 3. 创建WebSocket处理程序：实现WebSocketHandler接口，创建一个自定义的WebSocket处理程序。例如： ```java public class MyWebSocketHandler extends TextWebSocketHandler { @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { // 处理接收到的消息 String payload = message.getPayload(); // ... } @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { // 连接建立后的处理逻辑 // ... } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { // 连接关闭后的处理逻辑 // ... } } ``` 4. 发起WebSocket连接：在需要使用WebSocket的地方，注入`WebSocketClient`并使用它创建WebSocket连接。例如： ```java @Autowired private WebSocketClient webSocketClient; public void connectToWebSocket() { webSocketClient.doHandshake(new MyWebSocketHandler(), "ws://websocket-server-url"); } ``` 在上述示例中，我们使用`webSocketClient`发起WebSocket连接，并指定了WebSocket服务器的URL。 通过以上步骤，你就可以在Spring Boot中集成WebSocket客户端了。你可以根据自己的需求，进一步扩展和定制WebSocket处理程序和配置类。希望对你有所帮助！如果你有更多问题，可以继续问我。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值