SpringBoot整合Websocket（Java websocket怎么使用）

目录

    • 1 Websocket是什么
    • 2 Websocket可以做什么
    • 3 Springboot整合Websocket
      • 3.1 服务端
      • 3.2 客户端

1 Websocket是什么

WebSocket 是一种基于 TCP 协议的全双工通信协议，可以在浏览器和服务器之间建立实时、双向的数据通信。可以用于在线聊天、在线游戏、实时数据展示等场景。与传统的 HTTP 协议不同，WebSocket 可以保持长连接，实时传输数据，避免了频繁的 HTTP 请求和响应，节省了网络带宽和服务器资源，提高了应用程序的性能和用户体验。

2 Websocket可以做什么

项目中大部分的请求都是前台主动发送给后台，后台接收后返回数据给前台，返回数据后这个连接就终止了。如果要实现实时通信，通用的方式是采用 HTTP 协议

不断发送请求。但这种方式即浪费带宽（HTTP HEAD 是比较大的），又消耗服务器 CPU 占用（没有信息也要接受请求）。

websocket可以建立长连接实现双向通信，客户端和服务端都可以主动的向对方发送消息。

例如：

假设张三今天有个快递快到了，但是张三忍耐不住，就每隔十分钟给快递员或者快递站打电话，询问快递到了没，每次快递员就说还没到，等到下午张三的快递到了，但是，快递员不知道哪个电话是张三的，（可不是只有张三打电话，还有李四，王五），所以只能等张三打电话，才能通知他，你的快递到了。

而最好的情况是，张三给快递员第一次打电话时，说明自己的身份，快递员记录下来，让自己和快递员之间形成一对一的关系可以互相联系到。张三也不用再次给快递员打电话了，快递到了快递员会主动联系张三通知他来取。

后者就是websocket模式，在客户端断开WebSocket连接或Server端中断连接前，不需要客户端和服务端重新发起连接请求。在海量并发及客户端与服务器交互负载流量大的情况下，极大的节省了网络带宽资源的消耗，有明显的性能优势，且客户端发送和接受消息是在同一个持久连接上发起，实现了“真·长链接”，实时性优势明显。
在这里插入图片描述

在项目中聊天功能也是类似的逻辑，A发送了消息B立刻就要收到，A和B都属于前台客户端，不可能直接从一个前台不走服务器传输给另一个前台，过程一定是前台 —> 服务器 -> 前台。那前台客户端B接收消息是被动的，需要服务器主动发送消息请求，这就用到了WebSocket。大体流程如下图：
在这里插入图片描述

3 Springboot整合Websocket

3.1 服务端

  1. 添加依赖

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

  2. 添加Websocket配置文件

    @Configuration
public class WebSocketConfig {/***     注入ServerEndpointExporter，*     这个bean会自动注册使用了@ServerEndpoint注解声明的Websocket*/@Beanpublic ServerEndpointExporter serverEndpointExporter() {return new ServerEndpointExporter();}
}

  3. Webscoket操作类

    import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.logging.Logger;
import static java.util.logging.Level.WARNING;@Component
@ServerEndpoint("/websocket/{userId}")  // 接口路径 ws://localhost:9001/webSocket/userId;
public class WebSocket {private static final Logger log = Logger.getLogger(WebSocket.class.getName());//与某个客户端的连接会话，需要通过它来给客户端发送数据private Session session;/*** 用户ID*/private String userId;//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。//虽然@Component默认是单例模式的，但springboot还是会为每个websocket连接初始化一个bean，所以可以用一个静态set保存起来。//  注：底下WebSocket是当前类名private static CopyOnWriteArraySet<WebSocket> webSockets =new CopyOnWriteArraySet<>();// 用来存在线连接用户信息private static ConcurrentHashMap<String,Session> sessionPool = new ConcurrentHashMap<String,Session>();/*** 链接成功调用的方法*/@OnOpenpublic void onOpen(Session session, @PathParam(value="userId")String userId) {try {this.session = session;this.userId = userId;webSockets.add(this);sessionPool.put(userId, session);log.info("【websocket消息】有新的连接，总数为:"+webSockets.size());} catch (Exception e) {}}/*** 链接关闭调用的方法*/@OnClosepublic void onClose() {try {webSockets.remove(this);sessionPool.remove(this.userId);log.info("【websocket消息】连接断开，总数为:"+webSockets.size());} catch (Exception e) {}}/*** 收到客户端消息后调用的方法** @param message*/@OnMessagepublic void onMessage(String message) {log.info("【websocket消息】收到客户端消息:"+message);}/** 发送错误时的处理* @param session* @param error*/@OnErrorpublic void onError(Session session, Throwable error) {log.log(WARNING,"用户错误,原因:"+error.getMessage());error.printStackTrace();}/***	下面为服务端向客户端发送消息*/// 此为广播消息public void sendAllMessage(String message) {log.info("【websocket消息】广播消息:"+message);for(WebSocket webSocket : webSockets) {try {if(webSocket.session.isOpen()) {webSocket.session.getAsyncRemote().sendText(message);}} catch (Exception e) {e.printStackTrace();}}}// 此为单点消息public void sendOneMessage(String userId, String message) {Session session = sessionPool.get(userId);if (session != null&&session.isOpen()) {try {log.info("【websocket消息】 单点消息:"+message);session.getAsyncRemote().sendText(message);} catch (Exception e) {e.printStackTrace();}}}// 此为单点消息(多人)public void sendMoreMessage(String[] userIds, String message) {for(String userId:userIds) {Session session = sessionPool.get(userId);if (session != null&&session.isOpen()) {try {log.info("【websocket消息】 单点消息:"+message);session.getAsyncRemote().sendText(message);} catch (Exception e) {e.printStackTrace();}}}}
}

    上面的操作类中有几个主要的点需要注意

    • @ServerEndpoint注解：注解的value属性为调用时路径。类似于@RequestMapping("")设置的路径。添加该注解，才会被注册。
    • @OnOpen：链接成功调用的方法。
    • @OnMessage：客户端可以主动给服务端发送消息，此方法接受数据并处理。
    • @OnError：发送错误时的处理。

  4. 服务端主动向客户端发送消息

    测试用例

    @Resource
private WebSocket webSocket;@GetMapping("sendMessage")
public AjaxResult queryById(@Validated @NotNull Long id){//创建业务消息信息JSONObject obj = new JSONObject();obj.put("msgId", "00000001");//消息idobj.put("msgTxt", "服务端->客户端发送消息");//消息内容//全体发送webSocket.sendAllMessage(obj.toJSONString());//单个用户发送 (userId为用户id)//webSocket.sendOneMessage(userId, obj.toJSONString());//多个用户发送 (userIds为多个用户id，逗号‘,’分隔)//webSocket.sendMoreMessage(userIds, obj.toJSONString());return AjaxResult.success("执行成功");
}

3.2 客户端

<script>
export default {name: "index",data() {return {websock:null};},mounted() {//初始化websocketthis.initWebSocket()},destroyed: function () {//关闭连接this.websocketclose();},methods: {initWebSocket: function () { // 建立连接// WebSocket与普通的请求所用协议有所不同，ws等同于http，wss等同于httpsvar userId = "user-001";var url = "ws://localhost:9001/websocket/" + userId;this.websock = new WebSocket(url);this.websock.onopen = this.websocketonopen;this.websock.onerror = this.websocketonerror;this.websock.onmessage = this.websocketonmessage;this.websock.onclose = this.websocketclose;},// 连接成功后调用websocketonopen: function () {console.log("WebSocket连接成功");},// 发生错误时调用websocketonerror: function (e) {console.log("WebSocket连接发生错误");},// 接收后端消息websocketonmessage: function (e) {console.log("eee",e)var data = eval("(" + e.data + ")"); },// 关闭连接时调用websocketclose: function (e) {console.log("connection closed (" + e.code + ")");},//向后台发送消息sendMessage(){let params = {id:"00000",msg:"前端消息测试"}let a = JSON.stringify(params);this.websock.send(a)},}
</script>

websockke中内置了连接、错误、接收消息、接收消息、关闭的回调，下面自己定义的websocketonopen、websocketonmessage等方法的名字可以随便起，但需要在初始化时赋值给websocket对应的属性。

属性事件处理回调函数描述
onopenwebsocketonopen建立连接时触发
onerrorwebsocketonerror通信发生错误时触发
onmessagewebsocketonmessage客户端接收服务端消息时触发
onclosewebsocketclose连接关闭触发
send无不需要回调函数，建议直接调用websocket的send方法

下面测试下完整流程

  • 创建连接

    ws同http，wss同https，后面路径为服务段@ServerEndpoint注解的值，以此选择连接不同连接端。
    在这里插入图片描述

  • 前台客户端主动发送消息给服务端

    调用websock.send()方法，但消息的类型需要注意，socket本质是传输字节流，所以不能把任意类型的数据直接传入send方法，限制类型如下：
    在这里插入图片描述

    等接收到数据以后通过IO包装类都可以把数据还原。

    服务端成功接收到消息：
    在这里插入图片描述

  • 服务端主动向客户端发送消息

    客户端成功接收
    在这里插入图片描述
    在这里插入图片描述

    可以看到是一个请求长连接：

    • 绿色向上的箭头是客户端发送给服务端
    • 红色向下的箭头是服务端发送给客户端

上述测试的流程如下：
在这里插入图片描述

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

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

相关文章

回归预测 | MATLAB实现IBES-ELM改进的秃鹰搜索优化算法优化极限学习机多输入单输出回归预测（多指标，多图）

回归预测 | MATLAB实现IBES-ELM改进的秃鹰搜索优化算法优化极限学习机多输入单输出回归预测（多指标，多图）

回归预测 | MATLAB实现IBES-ELM改进的秃鹰搜索优化算法优化极限学习机多输入单输出回归预测&#xff08;多指标&#xff0c;多图&#xff09; 目录 回归预测 | MATLAB实现IBES-ELM改进的秃鹰搜索优化算法优化极限学习机多输入单输出回归预测&#xff08;多指标&#xff0c;多图…
阅读更多...
详解 SpringMVC 中获取请求参数

详解 SpringMVC 中获取请求参数

文章目录 1、通过ServletAPI获取2、通过控制器方法的形参获取请求参数3、[RequestParam ](/RequestParam )4、[RequestHeader ](/RequestHeader )5、[CookieValue ](/CookieValue )6、通过POJO获取请求参数7、解决获取请求参数的乱码问题总结 在Spring MVC中&#xff0c;获取请…
阅读更多...
图书管理系统

图书管理系统

作者简介&#xff1a; zoro-1&#xff0c;目前大一&#xff0c;正在学习Java&#xff0c;数据结构等 作者主页&#xff1a; zoro-1的主页 欢迎大家点赞 &#x1f44d; 收藏 ⭐ 加关注哦&#xff01;&#x1f496;&#x1f496; 图书管理系统 book包BookBookList operation包Add…
阅读更多...
【UE】Texture Coordinate 材质节点

【UE】Texture Coordinate 材质节点

目录 一、简介 二、属性介绍 &#xff08;1&#xff09;参数&#xff1a;U平铺 &#xff08;2&#xff09;参数&#xff1a;V平铺 &#xff08;3&#xff09;参数&#xff1a;解除镜像U &#xff08;4&#xff09;参数&#xff1a;解除镜像V 三、 节点构成原理 四、初级…
阅读更多...
几种Go版本管理工具

几种Go版本管理工具

缘起: 编译下面这段代码时,在Mac上没有什么问题,正常运行, 点击查看代码: package mainimport ( "bytes" "encoding/binary" "encoding/json" "fmt" "log" "math/rand" "net/http" "time")fu…
阅读更多...
Java 8 新特性——Lambda 表达式（1）

Java 8 新特性——Lambda 表达式（1）

Lambda 表达式&#xff08;Lambda expression&#xff09;是一个匿名函数&#xff0c;基于数学中的λ演算得名&#xff0c;也可称为闭包&#xff08;Closure&#xff09;。现在很多语言都支持 Lambda 表达式&#xff0c;如 C、C#、Java、 Python 和 JavaScript 等。Lambda 表达…
阅读更多...
Gin 框架入门实战系列（一）

Gin 框架入门实战系列（一）

GIN介绍 Gin是一个golang的微框架，封装比较优雅，API友好，源码注释比较明确，具有快速灵活，容错方便等特点 对于golang而言，web框架的依赖要远比Python，Java之类的要小。自身的net/http足够简单，性能也非常不错 借助框架开发，不仅可以省去很多常用的封装带来的时间，…
阅读更多...
多线程应用——阻塞队列

多线程应用——阻塞队列

阻塞队列 文章目录 阻塞队列1.队列的概念2.阻塞队列3.现实中的例子4.消息队列5.使用队列的优势1.解耦2.削峰填谷3.异步操作 6.实现 1.队列的概念 一种先进先出的数据结构 2.阻塞队列 队列写元素是从队尾插入&#xff0c;从对头取出 当插入元素时&#xff0c;先判断一下队列…
阅读更多...
Window10 安装 Lua

Window10 安装 Lua

1、下载地址&#xff1a;https://luabinaries.sourceforge.net/download.html 2、下载 3、解压后共有4个文件&#xff0c;这里我把这几个文件放到如下目录 D:\Program Files\lua-5.4.2\bin 4、定义环境变量 5、打开 powershell&#xff0c;运行 lua54 -v PS C:\Windows\syste…
阅读更多...
企业网络安全：威胁检测和响应 （TDR）

企业网络安全：威胁检测和响应 （TDR）

什么是威胁检测和响应 威胁检测和响应&#xff08;TDR&#xff09;是指识别和消除 IT 基础架构中存在的恶意威胁的过程。它涉及主动监控、分析和操作&#xff0c;以降低风险并防止未经授权的访问、恶意活动和数据泄露&#xff0c;以免它们对组织的网络造成任何潜在损害。威胁检…
阅读更多...
Dump文件的生成以及使用WinDbg静态分析

Dump文件的生成以及使用WinDbg静态分析

前言 本文章主要介绍了如何生成Dump文件&#xff0c;包括两种方式&#xff0c;通过代码生成和通过注册表生成。并且介绍了WinDbg工具的下载和使用&#xff0c;以及如何使用WinDbg工具去静态分析Dump文件&#xff0c;从而找到程序的崩溃位置。 生成Dump文件 通过调用WinAPI生成…
阅读更多...
django.core.exceptions.AppRegistryNotReady: Apps aren‘t loaded yet.

django.core.exceptions.AppRegistryNotReady: Apps aren‘t loaded yet.

运行django测试用例报错django.core.exceptions.AppRegistryNotReady: Apps arent loaded yet. 解决&#xff1a;在测试文件上方加上 django.setup() django.setup()是Django框架中的一个函数。它用于在非Django环境下使用Django的各种功能、模型和设置。 在常规的Django应用…
阅读更多...
堆对象数组

堆对象数组

C自学精简教程 目录(必读) 之前我们学习了基础类型的堆数组 现在我们来看堆数组的元素是类对象的场景 堆对象数组 堆对象数组的每一个元素都是一个类对象。 使用堆对象数组的语法和使用堆数组的语法是一样的。 #include <iostream> #include <string> using …
阅读更多...
ZMTP协议

ZMTP协议

ZoreMQ Transport Protocol是一个传输层协议&#xff0c;用于ZMQ的连接的信息交互&#xff0c;本文档描述的是3.0协议&#xff0c;主要分析基于NULL Security Mechanism 协议语法 ZMTP由三部分组成&#xff0c;分别是 greeting、handshake、traffic 部分描述构成greeting描述…
阅读更多...
移动基站ip的工作原理

移动基站ip的工作原理

原理介绍 Basic Principle 先说一下概念&#xff0c;大家在不使用 WIFI 网络的时候&#xff0c;使用手机通过运营商提供的网络进行上网的时候&#xff0c;目前都是在用户端使用私有IP&#xff0c;然后对外做 NAT 转换&#xff0c;这样的情况就导致大家统一使用一些 IP 段进行访…
阅读更多...
Unity中Shader的帧缓存区Clear(color+Z+stencil)

Unity中Shader的帧缓存区Clear(color+Z+stencil)

文章目录 前言一、什么是帧缓冲区二、片段运算三、随机扫描显示器&#xff08;可以按照自定义路径绘制帧&#xff09;四、光栅扫描显示器&#xff08;从左到右&#xff0c;从上到下&#xff0c;依次绘制&#xff09;五、缓冲的方式&#xff1a;单缓冲 和 双缓冲1、单缓冲2、双缓…
阅读更多...
VBA中如何将if写到一行

VBA中如何将if写到一行

在VBA中&#xff0c;可以使用以下两种方式来编写一行if语句&#xff1a; 使用三元运算符&#xff1a; Dim result As String result "Yes" If True Else "No"在这个例子中&#xff0c;如果条件为真&#xff0c;则result变量的值为"Yes"&#…
阅读更多...
pycharm 打开Terminal时报错activate.ps1，因为在此系统上禁止运行脚本，并因此无法进入虚拟环境

pycharm 打开Terminal时报错activate.ps1，因为在此系统上禁止运行脚本，并因此无法进入虚拟环境

pycharm 打开Terminal时报错activate.ps1&#xff0c;因为在此系统上禁止运行脚本&#xff0c;并因此无法进入虚拟环境 如下图所示&#xff1a; 网上说可以set_restrictFalse什么的&#xff0c;虽然也可但可能会降低电脑安全性&#xff0c;可以将下面的终端改为cmd.exe即可
阅读更多...
SpringCloudAlibaba Gateway(三)-整合Sentinel功能路由维度、API维度进行流控

SpringCloudAlibaba Gateway(三)-整合Sentinel功能路由维度、API维度进行流控

Gateway整合Sentinel ​ 前面使用过Sentinel组件对服务提供者、服务消费者进行流控、限流等操作。除此之外&#xff0c;Sentinel还支持对Gateway、Zuul等主流网关进行限流。 ​ 自sentinel1.6.0版开始&#xff0c;Sentinel提供了Gateway的适配模块&#xff0c;能针对路由(rou…
阅读更多...
Linux centos7 bash编程——-求质数和

Linux centos7 bash编程——-求质数和

训练项目&#xff1a;使用函数求质数和。 定义一个函数IsPrime()&#xff0c;据此判断一个数是否为质数 由用户输入一个整数&#xff0c;求出比此数大的两个最小质数之和。 一、解决思路: 1.先在键盘上输入一个整数 2.求出比此数大的最小质数 3.再求出比此质数大的另一个…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023