Spring Boot 实现 WebSocket


Posted in Java/Android onApril 30, 2022

参考资料

The WebSocket Protocol(RFC 6455)

Spring Boot 2.6.6 官方文档

SockJS

什么是 WebSocket ?

WebSocket协议提供了一种标准化的方法,通过单个TCP连接在客户机和服务器之间建立全双工、双向的通信通道。它是一种不同于HTTP的TCP协议,但被设计为在HTTP上工作,使用端口80和443,并允许重用现有的防火墙规则。

WebSocket 协议是独立的基于 TCP 协议。它与 HTTP 的唯一关系是,它的握手会被 HTTP 服务器解释为 Upgrade 请求。

使用“Upgrade: websocket”切换到 websocket 协议:

GET /spring-websocket-portfolio/portfolio HTTP/1.1
Host: localhost:8080
Upgrade: websocket 
Connection: Upgrade 
Sec-WebSocket-Key: Uc9l9TMkWGbHFD2qnFHltg==
Sec-WebSocket-Protocol: v10.stomp, v11.stomp
Sec-WebSocket-Version: 13
Origin: http://localhost:8080

websocket 服务器返回 “101”:

HTTP/1.1 101 Switching Protocols 
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: 1qVdfYHU9hPOl4JYYNXF623Gzn0=
Sec-WebSocket-Protocol: v10.stomp

HTTP vs WebSocket

HTTP 中,应用会提供很多 URLs。客户端通过 请求-响应风格访问这些 URLs。服务器根据请求的 URL、方法、请求头路由这些请求到合适的处理。

WebSocket 初始化连接只使用1个 URL。之后,所有的消息使用相同的 TCP 连接。WebSocket 是一个低等级的协议,它没有规定消息内容的任何语义。这意味着,除非客户机和服务器在消息语义上达成一致,否则无法路由或处理消息。

WebSocket 客户端与服务器可以通过HTTP 握手请求的 Sec-WebSocket-Protocol 请求头商定更高级别的消息协议(像 STOMP)

什么时候使用 WebSocket?

WebSockets可以使网页具有动态和交互性。然而,在许多情况下,Ajax和HTTP流或长轮询的组合可以提供一个简单而有效的解决方案。

例如,新闻、邮件和社交源需要动态更新,但每隔几分钟更新一次可能完全没有问题。另一方面,协作、游戏和金融应用需要更接近实时。

代码示例

1. SpringBoot 使用原生 WebSocket

1.1 引入 spring-boot-starter-websocket jar

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

1.2 编写 WebSocketHandler

通过以下方式实现 WebSocket 服务端:

实现 WebSocketHandler 接口继承 BinaryWebSocketHandler、TextWebSocketHandler 类

package org.spring.boot.websocket;
import java.nio.charset.StandardCharsets;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
/**
 * websocket 处理类:在请求信息的基础上加上“服务器返回:”,然后返回给客户端
 * @author black
 *
 */
public class EchoTextWebSocketHandler extends TextWebSocketHandler {
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 收到的信息
        String requestMsg  =  message.getPayload();
        System.out.println("服务器收到:" + requestMsg );
        // 组织响应信息
        String responseMsg = "服务器返回: " + requestMsg;
        System.out.println(responseMsg );
        TextMessage respMsg = new  TextMessage(responseMsg.getBytes(StandardCharsets.UTF_8));
         // 返回给客户端
        session.sendMessage( respMsg);
    }
}

1.3 编写 WebSocket 配置

package org.spring.boot.websocket;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistration;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
/**
 * WebSocket 配置类
 * @author black
 *
 */
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        //  为指定的URL 配置具体的 WebSocketHandler
        WebSocketHandlerRegistration registration =  registry.addHandler(echoHandler(), "/echo");
        // registration 能够对 WebSocketHandler 进行配置
    }
    @Bean
    public WebSocketHandler echoHandler() {
        return new EchoTextWebSocketHandler();
    }
}

1.4 启动类

package org.spring.boot.websocket;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
/**
 * Spring boot 使用 websocket 代码示例
 *
 */
@SpringBootApplication
public class SpringBootWebSocketBootstrap 
{
    public static void main( String[] args )
    {
        SpringApplication.run(SpringBootWebSocketBootstrap.class, args);
    }
}

应用默认端口为 8080 ,嵌入式容器是 tomcat。

1.5 测试

使用 Postman 进行 WebSocket 测试.

新建WebSocket 请求:

Spring Boot 实现 WebSocket

输入“localhost:8080”

Spring Boot 实现 WebSocket

点击【Connect】,下面显示:

Spring Boot 实现 WebSocket

展开 “Connected to localhost:8080/echo”,具体内容:

# Handshake Details
Request URL: http://localhost:8080/echo
Request Method: GET
Status Code: 101 
# Request Headers
Sec-WebSocket-Version: 13
Sec-WebSocket-Key: 1bNYHBOf9wqNuy2WUOYIsQ==
Connection: Upgrade
Upgrade: websocket
Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits
Host: localhost:8080
# Response Headers
Upgrade: websocket
Connection: upgrade
Sec-WebSocket-Accept: uh9IkfewEg11GuuAKnbXmpH+Yqo=
Sec-WebSocket-Extensions: permessage-deflate;client_max_window_bits=15
Date: Sat, 30 Apr 2022 05:53:23 GMT

输入“hello, 我是 black!”

Spring Boot 实现 WebSocket

点击【Send】

Spring Boot 实现 WebSocket

上图可以看出消息是按倒序展示的。

最后点击url旁边的【Disconnect】按钮关闭连接:

Spring Boot 实现 WebSocket

验证结束。

到此这篇关于Spring Boot 实现 WebSocket 示例的文章就介绍到这了!


Tags in this post...

Java/Android 相关文章推荐
解决Maven项目中 Invalid bound statement 无效的绑定问题
Jun 15 Java/Android
Spring Data JPA使用JPQL与原生SQL进行查询的操作
Jun 15 Java/Android
Java用自带的Image IO给图片添加水印
Jun 15 Java/Android
详解java如何集成swagger组件
Jun 21 Java/Android
Mybatis-plus在项目中的简单应用
Jul 01 Java/Android
Spring Security中用JWT退出登录时遇到的坑
Oct 16 Java/Android
Java8中接口的新特性使用指南
Nov 01 Java/Android
Android自定义scrollview实现回弹效果
Apr 01 Java/Android
Java字符缓冲流BufferedWriter
Apr 09 Java/Android
详解Flutter自定义应用程序内键盘的实现方法
Jun 14 Java/Android
springboot实现string转json json里面带数组
Jun 16 Java/Android
使用Postman测试需要授权的接口问题
Jun 21 Java/Android
Android存储中最基本的文件存储方式
Jmerte 分布式压测及分布式压测配置
Java存储没有重复元素的数组
Apr 29 #Java/Android
Java对文件的读写操作方法
Apr 29 #Java/Android
Java设计模式中的命令模式
Apr 28 #Java/Android
Android开发之底部导航栏的快速实现
Apr 28 #Java/Android
Java8 CompletableFuture 异步回调
Apr 28 #Java/Android
You might like
用Apache反向代理设置对外的WWW和文件服务器
2006/10/09 PHP
php 数组的合并、拆分、区别取值函数集
2010/02/15 PHP
那些年一起学习的PHP(二)
2012/03/21 PHP
php字符串过滤与替换小结
2015/01/26 PHP
php获取远程文件大小
2015/10/20 PHP
JavaScript语法着色引擎(demo及打包文件下载)
2007/06/13 Javascript
JS之小练习代码
2008/10/12 Javascript
使用JQuery和CSS模拟超链接的用户单击事件的实现代码
2012/05/23 Javascript
如何使用jquery动态加载js,css文件实现代码
2013/04/03 Javascript
javascript预加载图片、css、js的方法示例介绍
2013/10/14 Javascript
教你如何使用node.js制作代理服务器
2014/11/26 Javascript
高效Web开发的10个jQuery代码片段
2016/07/22 Javascript
关于JavaScript限制字数的输入框的那些事
2016/08/14 Javascript
学习Angular中作用域需要注意的坑
2016/08/17 Javascript
vue.js加载新的内容(实例代码)
2017/06/01 Javascript
安装vue-cli报错 -4058 的解决方法
2017/10/19 Javascript
jQuery实现使用sort方法对json数据排序的方法
2018/04/17 jQuery
webstorm和.vue中es6语法报错的解决方法
2018/05/08 Javascript
Node.js 中判断一个文件是否存在
2020/08/24 Javascript
整理Python最基本的操作字典的方法
2015/04/24 Python
Python合并同一个文件夹下所有PDF文件的方法
2019/03/11 Python
Python实现操纵控制windows注册表的方法分析
2019/05/24 Python
Python Gitlab Api 使用方法
2019/08/28 Python
python requests抓取one推送文字和图片代码实例
2019/11/04 Python
numpy中三维数组中加入元素后的位置详解
2019/11/28 Python
使用PyOpenGL绘制三维坐标系实例
2019/12/24 Python
MNIST数据集转化为二维图片的实现示例
2020/01/10 Python
解决TensorFlow GPU版出现OOM错误的问题
2020/02/03 Python
Django通过设置CORS解决跨域问题
2020/11/26 Python
印度尼西亚最大的电商平台:Tokopedia(印尼版淘宝)
2017/12/02 全球购物
营销与策划专业毕业生求职信
2013/11/01 职场文书
九年级历史教学反思
2014/01/27 职场文书
贺卡寄语大全
2014/04/11 职场文书
会计实训总结范文
2015/08/03 职场文书
JavaScript实现队列结构过程
2021/12/06 Javascript
CSS元素定位之通过元素的标签或者元素的id、class属性定位详解
2022/09/23 HTML / CSS