springboot websocket 知识点汇总

以下是一个详细全面的 Spring Boot 使用 WebSocket 的知识点汇总

1. 配置 WebSocket

添加依赖

进入maven官网, 搜索spring-boot-starter-websocket,选择版本, 然后把依赖复制到pom.xml的dependencies标签中

在这里插入图片描述

配置 WebSocket

创建一个配置类 WebSocketConfig,并启用 WebSocket 支持:

这个类的主要作用就是

  • 启用 WebSocket 支持: 这个配置类通过返回 ServerEndpointExporter 实例来启用 WebSocket 支持。
  • 自动注册端点: 它会自动注册用 @ServerEndpoint 注解标识的 WebSocket 端点,使它们能够处理 WebSocket 请求。
package com.example.websocketdemo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;@Configuration
public class WebSocketConfig {@Beanpublic ServerEndpointExporter serverEndpointExporter() {return new ServerEndpointExporter();}
}

2. 创建 WebSocket 端点

创建一个 WebSocket 端点 WebSocketServer,处理客户端与服务器之间的 WebSocket 通信。

当一个用户向服务端发送socket连接时, 相当于创建了一个WebSocketServer 类的实例对象

代码中的Session 放到文章最后讲。

package com.example.websocketdemo.websocket;
import jakarta.websocket.*;
import jakarta.websocket.server.PathParam;
import jakarta.websocket.server.ServerEndpoint;
import org.springframework.stereotype.Component;@Component	// 下面路径最后面不要写 '/'这个符号
@ServerEndpoint("/websocket/{username}")	// 我们配置的有WebSocketConfig类, 所以可以使用这个注解
public class WebSocketServer {private Session session;@OnOpen	// 建立连接的时候会调用这个函数public void onOpen(Session session, @PathParam("username") String username) {this.session = session;System.out.println("Connected with username: " + username);}@OnMessage	// 接收到客户端的信息时调用public void onMessage(String message, Session session) {System.out.println("Received message: " + message);try {session.getBasicRemote().sendText("Server received [" + message + "]");} catch (IOException e) {e.printStackTrace();}}@OnClose	// 关闭连接的时候调用public void onClose(Session session) {System.out.println("Session closed");}@OnError	// 错误时调用public void onError(Session session, Throwable throwable) {throwable.printStackTrace();}
}

3. Spring Security 配置(可选)

如果你的应用使用了 Spring Security,可能需要配置忽略 WebSocket 端点的安全检查:

需要在你的SecurityConfig 类中添加下面内容才可以让服务器接收到websocket的请求。SecurityConfig是一个管理Spring Security的自定义类

package com.example.websocketdemo.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.WebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityCustomizer;@Configuration
public class SecurityConfig {@Beanpublic WebSecurityCustomizer webSecurityCustomizer() {return (web) -> web.ignoring().requestMatchers("/websocket/**");}
}

4. 客户端代码

可以使用 JavaScript 在前端与 WebSocket 服务器进行通信。

<script>let socket = null;function connect() {let username = "your user name";// @ServerEndpoint("/websocket/{username}")	这里也可以传递其他参数, 比如token, 它会被服务端的这个注解接收到socket = new WebSocket('ws://localhost:8080/websocket/' + username);// 建立连接时会调用socket.onopen = function(event) {};// 接收到服务端的信息时调用socket.onmessage = function(event) {};// 关闭连接时调用socket.onclose = function(event) {};// 错误时调用socket.onerror = function(event) {};// 也可以通过close()手动关闭连接, 他会调用onclose(), 一般vue中在取消挂在组件时手动关闭连接socket.close(); // 向服务端发送信息, message最好是json格式, JSON.stringify()socket.send(message)}
</script>

5. 处理 JSON 消息

在信息交换的时候, 我们一般用JSON格式的信息。Java 标准库中并不包含直接处理 JSON 的功能。因此,需要引入第三方库来处理 JSON 数据。
这里我们讲的是 Alibaba 提供的 fastjson, 还是在 maven官网 搜索 fastjson 选择对应版本, 引入到pom.xml的dependencies标签中。

// 将 Java 对象序列化为 JSON 字符串
String jsonString = JSON.toJSONString(user);// 将 JSON 字符串反序列化为 Java 对象
User deserializedUser = JSON.parseObject(jsonString, User.class);// 创建一个 JSONObject
JSONObject jsonObject = new JSONObject();
jsonObject.put("name", "John");
// 转换成JSON字符串
jsonObject.toString()// 解析 JSON 字符串
String jsonString = "{\"name\":\"ld\",\"age\":18,\"city\":\"ShangHai\"}";
JSONObject parsedObject = JSONObject.parseObject(jsonString);
// 获取value, 输出 ld
System.out.println("Name: " + parsedObject.getString("name"));

6. Session

Session 在 WebSocket 中是一个重要的概念,它代表了客户端和服务器之间的 WebSocket 连接。通过 Session 对象,你可以发送和接收消息、获取连接信息、管理连接状态以及处理连接中的错误。

1. 创建 WebSocket 服务器端点

在 Java 中使用 WebSocket 的第一步是创建一个 WebSocket 服务器端点。通过使用 @ServerEndpoint 注解,你可以定义 WebSocket 服务器端点,并处理连接、关闭、消息和错误事件。

示例代码

import jakarta.websocket.OnClose;
import jakarta.websocket.OnError;
import jakarta.websocket.OnMessage;
import jakarta.websocket.OnOpen;
import jakarta.websocket.Session;
import jakarta.websocket.server.ServerEndpoint;
import java.io.IOException;@ServerEndpoint("/websocket")
public class WebSocketServer {@OnOpenpublic void onOpen(Session session) {System.out.println("Connected: " + session.getId());}@OnMessagepublic void onMessage(String message, Session session) throws IOException {System.out.println("Received: " + message);session.getBasicRemote().sendText("Echo: " + message);}@OnClosepublic void onClose(Session session) {System.out.println("Disconnected: " + session.getId());}@OnErrorpublic void onError(Session session, Throwable throwable) {throwable.printStackTrace();}
}
2. Session 对象的常用方法
  • 获取连接的唯一 IDsession.getId()
  • 发送消息
    • 发送文本消息:session.getBasicRemote().sendText("message")
    • 发送二进制消息:session.getBasicRemote().sendBinary(ByteBuffer buffer)
  • 获取连接的基本信息
    • 获取连接的 URI:session.getRequestURI()
    • 获取连接的参数:session.getPathParameters()
    • 获取连接的请求参数:session.getRequestParameterMap()
  • 关闭连接session.close()
  • 检查连接状态session.isOpen()
3. 处理消息

在 WebSocket 中,处理消息是通过 @OnMessage 注解的方法实现的。你可以在这个方法中处理来自客户端的消息,并使用 Session 对象发送响应。

示例代码

@OnMessage
public void onMessage(String message, Session session) throws IOException {System.out.println("Received: " + message);// 向客户端发送回显消息session.getBasicRemote().sendText("Echo: " + message);
}
4. 处理连接和断开

@OnOpen@OnClose 注解的方法分别用于处理连接建立和连接断开事件。在这些方法中,你可以执行一些初始化或清理操作。

示例代码

@OnOpen
public void onOpen(Session session) {System.out.println("Connected: " + session.getId());
}@OnClose
public void onClose(Session session) {System.out.println("Disconnected: " + session.getId());
}
5. 处理错误

@OnError 注解的方法用于处理 WebSocket 连接中的错误。在这个方法中,你可以记录错误信息或执行其他的错误处理操作。

示例代码

@OnError
public void onError(Session session, Throwable throwable) {throwable.printStackTrace();
}

6. 使用 Session 进行高级操作

6.1 保存和共享用户状态

在 WebSocket 应用中,你可以使用 Session 对象来保存和共享用户状态。例如,你可以在 Session 对象中存储用户的身份信息,并在后续的消息处理中使用这些信息。

示例代码

@OnOpen
public void onOpen(Session session) {session.getUserProperties().put("username", "John");
}@OnMessage
public void onMessage(String message, Session session) throws IOException {String username = (String) session.getUserProperties().get("username");session.getBasicRemote().sendText("Hello, " + username + "! You sent: " + message);
}
6.2 广播消息

你可以使用 Session 对象的集合来实现消息的广播,即将消息发送给所有连接的客户端。

示例代码

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;@ServerEndpoint("/websocket")
public class WebSocketServer {private static Set<Session> sessions = Collections.synchronizedSet(new HashSet<>());@OnOpenpublic void onOpen(Session session) {sessions.add(session);System.out.println("Connected: " + session.getId());}@OnClosepublic void onClose(Session session) {sessions.remove(session);System.out.println("Disconnected: " + session.getId());}@OnMessagepublic void onMessage(String message, Session session) throws IOException {for (Session s : sessions) {if (s.isOpen()) {s.getBasicRemote().sendText("Broadcast: " + message);}}}@OnErrorpublic void onError(Session session, Throwable throwable) {throwable.printStackTrace();}
}

文章到这里就这束了!~

其他文章地址:

快速入门,springboot知识点汇总

springboot常用注解大全(超详细, 30个)

springboot websocket知识点汇总

spring cloud知识点汇总, 待更

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/379102.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【机器学习】机器学习与图像分类的融合应用与性能优化新探索

文章目录 引言第一章&#xff1a;机器学习在图像分类中的应用1.1 数据预处理1.1.1 数据清洗1.1.2 数据归一化1.1.3 数据增强 1.2 模型选择1.2.1 卷积神经网络1.2.2 迁移学习1.2.3 混合模型 1.3 模型训练1.3.1 梯度下降1.3.2 随机梯度下降1.3.3 Adam优化器 1.4 模型评估与性能优…

SD-WAN组网搭建5G备份方案实现方式

SD-WAN&#xff08;Software-Defined Wide Area Network&#xff0c;软件定义广域网&#xff09;结合5G作为备份链路是现代企业网络弹性策略的一部分&#xff0c;尤其是在需要高可用性和快速故障切换的场景下。以下是实现SD-WAN组网并集成5G备份方案的一般步骤&#xff1a; 1. …

Postfix+Dovecot+Roundcube开源邮件系统搭建系列1-2:系统搭建目标+MariaDB数据库配置(MySQL)

1. 系统搭建目标 通过本系列文章&#xff0c;最终可以部署一套提供如下服务的邮件系统&#xff1a; SMTP服务&#xff1a;由Postfix提供&#xff0c;监听25、465、587端口。POP3服务&#xff1a;由Dovecot提供&#xff0c;监听110、995端口。IMAP服务&#xff1a;由Dovecot提…

2024全球和国内最常用的弱密码,有没有你的?

密码管理器NordPass分析了来自公开来源的超过4.3TB 的密码数据&#xff0c;找出了当前为止&#xff08;2024年&#xff09;最常用&#xff08;最脆弱&#xff09;的密码。 这些密码主要有下面这些特征&#xff1a; 简单且常用&#xff0c;万年弱密码&#xff0c;比如123456、a…

Qt支持LG高级汽车内容平台

Qt Group与LG 电子&#xff08;简称LG&#xff09;正携手合作&#xff0c;将Qt软件框架嵌入其基于 webOS的ACPLG车载娱乐平台&#xff0c;用于应用程序开发。该合作旨在让原始设备制造商&#xff08;OEM&#xff09;的开发者和设计师能为汽车创建更具创新性的沉浸式汽车内容流媒…

Flutter应用开发:掌握StatefulWidget的实用技巧

前言 随着移动应用的日益复杂&#xff0c;状态管理成为了 Flutter 应用开发中的一项重要挑战。 状态&#xff0c;即应用中的可变数据&#xff0c;它驱动着用户界面的渲染和交互。 在 Flutter 这样的声明式 UI 框架中&#xff0c;如何高效、可维护地管理状态&#xff0c;对于…

linux环境安装mongoDB

一、安装单体mogodb 目标&#xff1a;在Linux中部署一个单机的MongoDB&#xff0c;作为生产环境下使用。 提示&#xff1a;和Windows下操作差不多。 步骤如下&#xff1a; &#xff08;1&#xff09;先到官网下载压缩包 mongod-linux-x86_64-4.0.10.tgz 。 &#xff08;2&…

WEB前端06-BOM对象

BOM浏览器对象模型 浏览器对象模型&#xff1a;将浏览器的各个组成部分封装成对象。是用于描述浏览器中对象与对象之间层次关系的模型&#xff0c;提供了独立于页面内容、并能够与浏览器窗口进行交互的对象结构。 组成部分 Window&#xff1a;浏览器窗口对象 Navigator&…

【STC89C51单片机】定时器中断系统

中断概念 中断是一种重要的硬件机制&#xff0c;用于在处理器正在执行程序时&#xff0c;能够及时响应某些外部或内部事件。中断可以临时中止当前正在执行的指令序列&#xff0c;转而去执行专门的中断服务程序&#xff08;ISR&#xff0c;Interrupt Service Routine&#xff0…

Linux系统部署MySQL数据库

1.Linux插入光盘&#xff0c;使用df-h获取光盘信息&#xff0c;默认/dev/sr0文件为光盘文件 使用命令 mount -o ro /dev/sr0 /media进行手动挂载 mount -o ro /dev/sr0 /media 2.进入cd /etc/yum.repos.d目录 编辑配置yum库&#xff0c;编辑vim yum.repos [BaseOS] nameba…

Re:从零开始的C++世界——类和对象(下)

文章目录 前言1.再谈构造函数&#x1f34e;构造函数体赋值&#x1f34e;初始化列表&#x1f34e;特性&#x1f34c;特性一&#x1f34c;特性二&#x1f34c;特性三&#x1f34c;特性四&#x1f34c;特性五 &#x1f34e;explicit 关键字 2.static成员&#x1f34e;概念&#x1…

边缘设备使用记录--阿加犀AIBox 6490

边缘设备使用记录--阿加犀AIBox 6490 设备介绍设备连接glog && gflagsonnx2tfliteAidLite SDK for C模型输入输出的shape执行推断 OpenCV使用 设备介绍 阿加犀AIBox 6490是一款基于高通QCS6490平台的高性价比智能边缘计算终端&#xff0c;具有14TOPS AI算力&#xff0…

Springboot整合ShardingJdbc实现分库分表方案

一、创建库表 1、创建两个数据库 CREATE SCHEMA shard_db_0 DEFAULT CHARACTER SET utf8 ; CREATE SCHEMA shard_db_1 DEFAULT CHARACTER SET utf8 ; 2、在每个数据库各创建三个分表 CREATE TABLE tb_order_0 (order_id bigint(20) NOT NULL,buyer_id bigint(20) not null …

dom4j 操作 xml 之按照顺序插入标签

最近学了一下 dom4j 操作 xml 文件&#xff0c;特此记录一下。 public class Dom4jNullTagFiller {public static void main(String[] args) throws DocumentException {SAXReader reader new SAXReader();//加载 xml 文件Document document reader.read("C:\\Users\\24…

【数据结构】探索排序的奥秘

若有不懂地方&#xff0c;可查阅我之前文章哦&#xff01; 个人主页&#xff1a;小八哥向前冲~_csdn博客 所属专栏&#xff1a;数据结构_专栏 目录 排序的概念 几种排序方法介绍 冒泡排序 选择排序 插入排序 堆排序 向上调整建堆排序 向下调整建堆排序 希尔排序 快速…

前后端数据交互设计到的跨域问题

前后端分离项目的跨域问题及解决办法 一、跨域简述 1、问题描述 这里前端vue项目的端口号为9000&#xff0c;后端springboot项目的端口号为8080 2、什么是跨域 当一个请求url的协议、域名、端口三者之间任意一个与当前页面url不同即为跨域 当前页面url被请求页面url是否…

K8S 上部署 Emqx

文章目录 安装方式一&#xff1a;1. 快速部署一个简单的 EMQX 集群&#xff1a;2. 部署一个持久化的 EMQX 集群&#xff1a;3. 部署 EMQX Edge 集群和 EMQX 企业版集群&#xff1a; 安装方式二&#xff1a;定制化部署1. 使用 Pod 直接部署 EMQX Broker2. 使用 Deoloyment 部署 …

Jmeter关联

案例脚本实现&#xff1a;选择商品加入购物车 客户端发送一个登录的HTTP请求&#xff0c;服务端返回一个带着token的响应&#xff0c;后续发出一个带token信息的加入购物车的HTTP请求&#xff0c;返回响应。 关联&#xff1a;当请求直接由依赖关系的时候&#xff0c;比如一个请…

LLM基础模型系列:Prompt-Tuning

------->更多内容&#xff0c;请移步“鲁班秘笈”&#xff01;&#xff01;<------ 大型预训练语言模型的规模不断扩大&#xff0c;在许多自然语言处理 &#xff08;NLP&#xff09; 基准测试中取得了最先进的结果。自GPT和BERT开发以来&#xff0c;标准做法一直是在下游…

IDEA中Git常用操作及Git存储原理

Git简介与使用 Intro Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git是一款分布式版本控制系统&#xff08;VCS&#xff09;&#xff0c;是团队合作开发…