springboot集成Websocket

已于 2024-08-27 10:48:31 修改
阅读量528 收藏 6
点赞数 3
分类专栏： 客户端服务端消息推送 文章标签： java
于 2024-07-29 10:48:20 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/w_t_y_y/article/details/140765547
版权

目录

一、集成

1、pom依赖

2、webSocket端口处理消息 

3、注册websocket端口

二、demo

1、pom依赖

2、dto

3、constant 

4、webSocket端口处理

5、webSocket端口注册

6、controller接口

7、前端文件

8、application.properties配置文件

9、启动类

10、测试

10.1、user消息

10.2、menu消息 

一、集成

1、pom依赖
 <!--WebSocket的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
2、webSocket端口处理消息 

一般extends  TextWebSocketHandler即可

3、注册websocket端口
implements WebSocketConfigurer

二、demo

1、pom依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>websocket-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.2.4</version>
        <relativePath/>
    </parent>

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.10.1</version>
        </dependency>


        <!--WebSocket的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>

<!--        <dependency>-->
<!--            <groupId>javax.websocket</groupId>-->
<!--            <artifactId>javax.websocket-api</artifactId>-->
<!--            <version>1.1</version>-->
<!--            <scope>provided</scope>-->
<!--        </dependency>-->
    </dependencies>

</project>
2、dto
package org.example.dto;

import lombok.Data;

@Data
public class MenuDTO {

    private String url;

    private String code;

    private String name;
}

package org.example.dto;

import lombok.Data;

@Data
public class UserDTO {
    private String userName;

    private Integer age;

    private String userAccount;
}
3、constant 

这里常量是为了所有线程共享WebSocketSession

package org.example.constant;

import lombok.Getter;
import org.springframework.web.socket.WebSocketSession;

import java.util.HashSet;
import java.util.Set;

public class MenuSessionConstant {

    @Getter
    private static Set<WebSocketSession> sessions = new HashSet<>();

    public static void add(WebSocketSession session) {
        sessions.add(session);
    }

    public static void remove(WebSocketSession session) {
        sessions.remove(session);
    }
}

package org.example.constant;

import lombok.Getter;
import org.springframework.web.socket.WebSocketSession;

import java.util.HashSet;
import java.util.Set;

public class UserSessionConstant {

    @Getter
    private static Set<WebSocketSession> sessions = new HashSet<>();

    public static void add(WebSocketSession session) {
        sessions.add(session);
    }

    public static void remove(WebSocketSession session) {
        sessions.remove(session);
    }
}
4、webSocket端口处理

包括连接、断开连接、发送消息

package org.example.config;

import lombok.extern.slf4j.Slf4j;
import org.example.constant.UserSessionConstant;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

import java.io.IOException;

@Component
@Slf4j
public class UserWebSocketHandler extends TextWebSocketHandler {

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        UserSessionConstant.add(session);
        log.info("user有新的连接，sessionId:{}",session.getId());
    }

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理接收到的消息
        log.info("user服务端Received message: {}",message.getPayload());
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        UserSessionConstant.remove(session);
        log.info("user连接已断开sessionId:{}",session.getId());
    }

    public void sendMessageToAll(String message) {
        for(WebSocketSession session : UserSessionConstant.getSessions()) {
            if (session.isOpen()) {
                try {
                    session.sendMessage(new TextMessage(message));
                    log.info("user发送消息给{}成功",session.getId());
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}
package org.example.config;

import lombok.extern.slf4j.Slf4j;
import org.example.constant.MenuSessionConstant;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
import java.io.IOException;

@Component
@Slf4j
public class MenuWebSocketHandler extends TextWebSocketHandler {


    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        MenuSessionConstant.add(session);
        log.info("menu有新的连接，sessionId:{}",session.getId());
    }

    @Override
    public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理接收到的消息
        log.info("menu服务端Received message: {}",message.getPayload());
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        MenuSessionConstant.remove(session);
        log.info("menu连接已断开sessionId:{}",session.getId());
    }

    public void sendMessageToAll(String message) {
        for(WebSocketSession session : MenuSessionConstant.getSessions()) {
            if (session.isOpen()) {
                try {
                    session.sendMessage(new TextMessage(message));
                    log.info("menu发送消息给{}成功",session.getId());
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}
5、webSocket端口注册
package org.example.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(userWebSocketHandler(), "/user-websocket-endpoint").setAllowedOrigins("*");
        registry.addHandler(menuWebSocketHandler(), "/menu-websocket-endpoint").setAllowedOrigins("*");
    }

    public UserWebSocketHandler userWebSocketHandler() {
        return new UserWebSocketHandler();
    }

    public MenuWebSocketHandler menuWebSocketHandler() {
        return new MenuWebSocketHandler();
    }
}
6、controller接口
package org.example.controller;

import org.example.config.UserWebSocketHandler;
import org.example.dto.UserDTO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/userMsg")
public class UserMsgController {

    @Autowired
    private UserWebSocketHandler userWebSocketHandler;

    @RequestMapping("/send")
    public void sendMessage(UserDTO messageDTO) {
        userWebSocketHandler.sendMessageToAll(messageDTO.toString());
    }
}

package org.example.controller;

import org.example.config.MenuWebSocketHandler;
import org.example.config.UserWebSocketHandler;
import org.example.dto.MenuDTO;
import org.example.dto.UserDTO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/menuMsg")
public class MenuMsgController {

    @Autowired
    private MenuWebSocketHandler menuWebSocketHandler;

    @RequestMapping("/send")
    public void sendMessage(MenuDTO messageDTO) {
        menuWebSocketHandler.sendMessageToAll(messageDTO.toString());
    }
}
7、前端文件

在resource下面新建static文件夹，在static下新建user.html、menu.html

（1）user.html

<!DOCTYPE html>
<html>
<head>
    <title>WebSocket Example</title>
</head>
<body>
<script>
    var socket = new WebSocket("ws://localhost:5555/websocketDemo/user-websocket-endpoint");

    socket.onopen = function(event) {
        console.log("User WebSocket is open now.");
        socket.send("Hello Server! This is user client");
    };

    socket.onmessage = function(event) {
        console.log("Message from server ", event.data);
    };

    socket.onclose = function(event) {
        console.log("WebSocket is closed now.");
    };

    socket.onerror = function(error) {
        console.log("WebSocket Error: " + error);
    };
</script>
</body>
</html>

（2） menu.html

<!DOCTYPE html>
<html>
<head>
    <title>WebSocket Example</title>
</head>
<body>
<script>
    var socket = new WebSocket("ws://localhost:5555/websocketDemo/menu-websocket-endpoint");

    socket.onopen = function(event) {
        console.log("Menu WebSocket is open now.");
        socket.send("Hello Server! This is menu client");
    };

    socket.onmessage = function(event) {
        console.log("Message from server ", event.data);
    };

    socket.onclose = function(event) {
        console.log("WebSocket is closed now.");
    };

    socket.onerror = function(error) {
        console.log("WebSocket Error: " + error);
    };
</script>
</body>
</html>
8、application.properties配置文件
server.port=5555
server.servlet.context-path=/websocketDemo
9、启动类
package org.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableMBeanExport;
import org.springframework.jmx.support.RegistrationPolicy;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.web.socket.config.annotation.EnableWebSocket;

@SpringBootApplication
public class WebsocketApplication {

    public static void main(String[] args) {
        SpringApplication.run(WebsocketApplication.class, args);

    }
}
10、测试

启动项目。

10.1、user消息

（1）先在浏览器中f12，浏览器访问http:5555/websocketDemo/user.html

idea控制台打印：

2024-08-27T10:40:07.316+08:00  INFO 40188 --- [nio-5555-exec-2] o.example.config.UserWebSocketHandler    : user有新的连接，sessionId:745333c6-5f19-3fc1-bc18-9f9a377fa539
2024-08-27T10:40:07.321+08:00  INFO 40188 --- [nio-5555-exec-2] o.example.config.UserWebSocketHandler    : user服务端Received message: Hello Server! This is user client

 刷新浏览器，idea再次打印新的连接信息，可见每次刷新浏览器都相当于产生一个新的连接

（2）postman调用/userMsg/send接口

查看浏览器，成功接收

 

（3）重复（1）打开一个窗口

（4）重复（2），查看两个浏览器都接收到消息了：

10.2、menu消息 

打开一个浏览器窗口，访问http://localhost:5555/websocketDemo/menu.html

postman访问

 查看浏览器消息：menu的窗口成功接收了，非menu（user）的没有接收到

w_t_y_y
关注
专栏目录
SpringBoot集成WebSocket
一切简单化
02-03 406
广播是服务器与客户端“一对所有”的连接方式。广播意味着服务器向每一个成员都投递一份数据包，不论这些主机是否乐于接收该数据包。应用于发布游戏公告等场景。单播是客户端与服务器之间的“一对一”的连接。是在一个单个的发送者和一个接收者之间通过进行的通信。应用于私信私聊等场景。组播是在服务端和客户端之间实现“一对一组”的连接方式。应用于多人聊天室等场景。访问接口地址：127.0.0.1:8080/open/socket/test。index.html （文件在resources/static目录下）
SpringBoot集成WebSocket长连接实际应用详解
08-19
SpringBoot集成WebSocket长连接实际应用详解 本文主要介绍了SpringBoot集成WebSocket长连接实际应用详解，通过示例代码详细介绍了WebSocket的应用场景和实现方式，对大家的学习或者工作具有一定的参考学习价值。 ...
【Unity】在Unity下使用websocket的一些经验
好吃的和好看的都需要用实力来争取
05-08 3237
webSocket是什么:1、WebSocket是一种在单个TCP连接上进行全双工通信的协议2、WebSocket使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据3、在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输4、需要安装第三方包：cmd中：go get -u -v（我这里使用的是WebSocketSharp库，一个很简单的dll文件）
springboot集成websocket
热门推荐
大爱仙尊
10-21 2万+
​ 这里我们使用springboot搭建一个轻量级的websocket服务，同时提供4个入参。使用websocket服务可以轻松和微信小程序、支付宝小程序、网页就行双向通讯，非常实用方便。wss地址这里是我们自己搭建的中转服务websocket地址。参数说明。
websocket的介绍及springBoot集成示例
最新发布
cj_eryue的博客
08-22 1189
websocket的介绍及springBoot集成示例
spring boot学习第六篇:SpringBoot 集成WebSocket详解
heming20122012的专栏
01-09 2935
WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。
Springboot超仔细整合websocket(附案例代码)
qq_55272229的博客
06-30 4979
添加依赖：确保在pom.xml中添加Spring WebSocket和WebSocket依赖。创建WebSocket处理器(端点)：编写一个处理WebSocket消息的处理器。完成对应的生命周期如果需要传递http第一次握手时候处理信息 需要添加对应的处理配置配置WebSocket：配置WebSocket相关的Bean和端点(值得注意的是每一个端点对象对一个用户线程 所以spring的单实列bean和异步处理再这里无法生效 具体会在踩坑笔记中提及)
Springboot集成websocket
囚徒之困
05-23 4217
Springboot集成websocket
SpringBoot 集成WebSocket
m0_67907445的博客
08-29 1515
在海量并发及客户端与服务器交互负载流量大的情况下，极大的节省了网络带宽资源的消耗，有明显的性能优势，且客户端发送和接受消息是在同一个持久连接上发起，实现了“真·长链接”，实时性优势明显。* 要注意，如果项目使用外置的servlet容器，而不是直接使用springboot内置容器的话，就不要注入ServerEndpointExporter，因为它将由容器自己提供和管理。长轮询的间隔期一般很长，例如 30s、60s，并且服务端 hold 住连接不会消耗太多服务端资源。降低轮询的间隔，延迟降低，压力增加；
SpringBoot 集成 WebSocket
功不唐捐，玉汝于成
04-21 5994
SpringBoot 整合 websocket、websocket 的通信应用
Springboot 整合 WebSocket
原名：@程序员大禹
11-16 9016
WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工（full-duplex）通信，即允许服务器主动发送信息给客户端。因此，在WebSocket中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输，客户端和服务器之间的数据交换变得更加简单。
SpringBoot集成WebSocket实现前后端消息互传的方法
08-25
SpringBoot集成WebSocket实现前后端消息互传的方法 SpringBoot集成WebSocket实现前后端消息互传的方法是当前互联网技术中的一种常见的实现方式。WebSocket是一种基于TCP的网络协议，能够实现浏览器与服务器的全双工...
Springboot集成websocket+protobuf基本Demo，可实现后端与前端数据实时发送与接收.zip
01-04
WebSocket是一种在客户端和服务器之间建立长连接的协议，它允许双方进行全双工通信，即...这个示例项目"Springboot集成websocket+protobuf基本Demo"提供了一个基础的实现，可以帮助开发者快速理解和实践这一技术组合。
springboot集成websocket的简单例子
03-02
首先，为了集成WebSocket，我们需要引入相关的依赖。在Spring Boot项目中，我们通常通过添加`spring-boot-starter-websocket`依赖来启用WebSocket功能。在`pom.xml`或`build.gradle`文件中添加如下依赖： ```xml <!...
springboot集成websocket实现简单聊天
03-29
在本项目中，我们将探讨如何利用Spring Boot集成WebSocket，以实现一个简单的聊天应用。 首先，我们需要在Spring Boot项目中引入WebSocket的相关依赖。Spring Boot本身并不直接支持WebSocket，但可以通过Spring ...
SpringBoot整合WebSocket服务 springboot整合websocket springboot使用websocket springboot使用websocket
半只
07-19 4038
仅使用 SpringBoot封装好的服务，并不是使用第三方Netty或者: 底层使用实现: 底层使用Netty实现(没有使用过，不知道具体)官方文档1官方文档2。
Springboot整合Websocket
qq_45443475的博客
10-21 7543
Springboot整合Websocket
JAVA (Springboot) 集成WebSocket
weixin_47054648的博客
05-29 2228
WebSocket是一种在单个TCP连接上进行全双工通信的协议。它允许服务端主动向客户端推送数据，同时也允许客户端向服务器发送数据。WebSocket通信协议于2011年被IETF定为标准RFC 6455，并由RFC7936补充规范。WebSocket API也被W3C定为标准。
SpringBoot——集成WebSocket
吴声子夜歌的博客
07-29 1437
对于WebSocket的使用，可以先通过Spring创建Java配置文件。//创建服务器端点 @Bean public ServerEndpointExporter serverEndpointExporter() {} }有了这个Bean，就可以使用@ServerEndpoint定义一个端点服务类。//静态变量，用来记录当前在线连接数。应该设计为线程安全的 private static int onlineCount = 0;
springboot集成 websocket
05-27
SpringBoot集成WebSocket可以使用Spring框架提供的WebSocket API来实现。在SpringBoot中，使用WebSocket需要进行以下几个步骤： 1. 添加依赖：在pom.xml文件中添加spring-boot-starter-websocket依赖。 2. 创建WebSocket配置类：创建一个WebSocket配置类，用于配置WebSocket相关的参数，如注册EndPoint、消息编解码器、拦截器等。 3. 创建EndPoint：创建一个WebSocket的EndPoint类，用于处理WebSocket连接、消息发送、关闭等操作。可以通过实现Spring提供的WebSocketHandler接口或者继承TextWebSocketHandler来实现。 4. 添加拦截器：可以添加自定义的拦截器，用于处理WebSocket连接建立、消息发送等事件。 5. 配置WebSocket消息代理：使用Spring提供的消息代理，可以实现WebSocket消息的广播和点对点传递。 以下是一个简单的SpringBoot集成WebSocket的示例代码： 1. 添加依赖 ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 创建WebSocket配置类 ``` @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myHandler(), "/myHandler") .addInterceptors(new WebSocketInterceptor()); } @Bean public WebSocketHandler myHandler() { return new MyHandler(); } } ``` 3. 创建EndPoint ``` public class MyHandler extends TextWebSocketHandler { @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { // 处理连接建立事件 } @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { // 处理消息事件 } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { // 处理连接关闭事件 } } ``` 4. 添加拦截器 ``` public class WebSocketInterceptor extends HandshakeInterceptor { @Override public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception { // 处理连接建立前事件 return true; } @Override public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex) { // 处理连接建立后事件 } } ``` 5. 配置WebSocket消息代理 ``` @Configuration @EnableWebSocketMessageBroker public class WebSocketMessageBrokerConfig implements WebSocketMessageBrokerConfigurer { @Override public void configureMessageBroker(MessageBrokerRegistry registry) { registry.enableSimpleBroker("/topic"); registry.setApplicationDestinationPrefixes("/app"); } @Override public void registerStompEndpoints(StompEndpointRegistry registry) { registry.addEndpoint("/myEndpoint") .setAllowedOrigins("*") .withSockJS(); } } ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

w_t_y_y

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值