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 相关文章推荐
SpringBoot实现异步事件驱动的方法
Jun 28 Java/Android
Java集成swagger文档组件
Jun 28 Java/Android
Java实现给Word文件添加文字水印
Feb 15 Java/Android
java executor包参数处理功能 
Feb 15 Java/Android
mybatis源码解读之executor包语句处理功能
Feb 15 Java/Android
解决persistence.xml配置文件修改存放路径的问题
Feb 24 Java/Android
Android超详细讲解组件ScrollView的使用
Mar 31 Java/Android
Java实战之课程信息管理系统的实现
Apr 01 Java/Android
Android Rxjava3 使用场景详解
Apr 07 Java/Android
java开发双人五子棋游戏
May 06 Java/Android
Springboot中如何自动转JSON输出
Jun 16 Java/Android
详解Spring Security如何在权限中使用通配符
Jun 28 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
解析PHP中intval()等int转换时的意外异常情况
2013/06/21 PHP
PHP连接sql server 2005环境配置及问题解决
2014/08/08 PHP
详解PHP数组赋值方法
2015/11/07 PHP
PHP实现的构造sql语句类实例
2016/02/03 PHP
PHP实现支付宝即时到账功能
2016/12/21 PHP
PHP ADODB生成HTML表格函数rs2html功能【附错误处理函数用法】
2018/05/29 PHP
一些有关检查数据的JS代码
2006/09/07 Javascript
解决3.01版的jquery.form.js中文乱码问题的解决方法
2012/03/08 Javascript
JSON.parse()和JSON.stringify()使用介绍
2014/06/20 Javascript
jquery 取子节点及当前节点属性值的方法
2014/08/24 Javascript
JavaScript中日期的相关操作方法总结
2015/10/24 Javascript
javascript实现uploadify上传格式以及个数限制
2015/11/23 Javascript
百度坐标(BD09)、国测局坐标(火星坐标,GCJ02)、和WGS84坐标系之间的转换
2016/02/19 Javascript
遍历js中对象的属性和值的实例
2016/11/21 Javascript
基于JS实现的随机数字抽签实例
2016/12/08 Javascript
12306 刷票脚本及稳固刷票脚本(防挂)
2017/01/04 Javascript
JavaScript框架Angular和React深度对比
2017/11/20 Javascript
vue2手机APP项目添加开屏广告或者闪屏广告
2017/11/28 Javascript
vue项目中实现缓存的最佳方案详解
2019/07/11 Javascript
vue2.x 通过后端接口代理,获取qq音乐api的数据示例
2019/10/30 Javascript
微信小程序清空输入框信息与实现屏幕往上滚动的示例代码
2020/06/23 Javascript
[10:04]国际邀请赛采访专栏:DK.Farseer,mouz.Black^,采访员Josh专访
2013/08/05 DOTA
[02:33]2018DOTA2亚洲邀请赛赛前采访——LGD
2018/04/04 DOTA
python 图片验证码代码分享
2012/07/04 Python
python批量读取txt文件为DataFrame的方法
2018/04/03 Python
Python实现的逻辑回归算法示例【附测试csv文件下载】
2018/12/28 Python
pandas 数据结构之Series的使用方法
2019/06/21 Python
Python使用py2neo操作图数据库neo4j的方法详解
2020/01/13 Python
html5 figure和figcaption的使用方法
2018/09/10 HTML / CSS
HTML5 图片预加载的示例代码
2020/03/25 HTML / CSS
英国时尚首饰品牌:Missoma
2020/06/29 全球购物
求职自荐信怎么写
2014/03/06 职场文书
2014年预备党员学习两会心得体会
2014/03/17 职场文书
党的群众路线整改落实情况汇报
2014/10/28 职场文书
力克胡哲观后感
2015/06/10 职场文书
Python面试不修改数组找出重复的数字
2022/05/20 Python