springboot集成WebSockets广播消息(推荐)

2024-11-30 15:52:11

一 WebScoketS 简介

RFC 6455 即 webSockets 协议提供了一种标准化的方式去建立全双工，双方面交流的通道在客户端和服务端甚至单一的TCP连接中进行通信； webSockets 协议其跟HTTP的tcp协议不同，但是其设计目的是通过HTTP协议进行工作，可以使用40或者443端口和重新使用现有的防火墙规则；

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

webSockets 的交互是以HTTP协议开始的，使用Upgrade header 转向使用Upgrade连接；如果非200状态成功响应就类似于下面的信息；如果WebSocket server 是运行在nginx是需要配置WebSocket upgrade requests ；如果是运行在云上，需要查阅相关的云是否支持WebSocket ；

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

二 HTTP 和 WebSocket 对比

在HTTP和REST中一个应用需要很多的URLs;应用和客户端是通过请求和响应的风格使用这些URLs进行交互；服务端会路由这些请求给基于HTTP 的URL或者方法或者头进行处理；

WebSockets 通常在初始化的时候就只有一个链接，所有应用的消息都是通过相同的TCP连接进行流动；这指向一个完全不同的异步、事件驱动的消息传递体系结构。

WebSocket 是一种低端的协议，不像HTTP，其不规定消息中内容中任何的语义信息；这意味着其没有任何方式去路由或者处理这些信息，除非客户端和服务端在语义上达成一致；

WebSocket 客户端和服务端其交流是通过使用更加高级的消息协议（比如STOMP）和基于HTTP握手请求的Sec-WebSocket-Protocol header ；

三注意事项

WebSockets可以使web页面具有动态性和交互性。然而，在许多情况下，Ajax和HTTP流或 long polling（轮询）可以提供一个简单有效的解决方案。HTTP流和polling适用于消息不频繁的交互，WebSockets适用于消息较频繁的交互；在因特网上由于没有Upgrade header 或者关闭了空闲的长链接，受限于在你有限的代理可能会将WebSockets的交互排除；

四 websocket配置和依赖

4.1 依赖

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

 <dependencies>
 <!-- websocket依赖-->
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-websocket</artifactId>
 </dependency>
 <!-- 模板引擎-->
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-thymeleaf</artifactId>
 </dependency>
 </dependencies>

4.2 配置

/**
 * @Author lsc
 * @Description <p>websocket配置类 </p>
 * @Date 2019/11/12 22:27
 */
//使用STOMP协议来传输基于消息代理的消息，控制器支持在@Controller类中使用@MessageMapping
@EnableWebSocketMessageBroker
@Configurable
@EnableWebSocket
@Component
public class WebConfig implements WebSocketMessageBrokerConfigurer {

 @Override
 public void registerStompEndpoints(StompEndpointRegistry registry) {
 // 注册 Stomp的端点（Endpoint），并且映射指定的url
 registry.addEndpoint("/websocket")
 .setAllowedOrigins("*") // 添加允许跨域访问
 .withSockJS();// 指定SockJS协议
 }

 @Override
 public void configureMessageBroker(MessageBrokerRegistry registry) {
 // 启动广播模式代理，只有符合的的路径才发送消息
 registry.enableSimpleBroker("/topic");
 }
}

五实体类

5.1 接受消息实体

/**
 * @Author lsc
 * @Description <p> 接受客户端消息</p>
 * @Date 2019/11/12 22:42
 */
public class AcceptMessages {

 private String name;

 public String getName() {
 return name;
 }
}

5.2 发送消息实体

/**
 * @Author lsc
 * @Description <p>发送消息给客户端 </p>
 * @Date 2019/11/12 22:42
 */
public class SendMessages {

 private String responseMessage;

 public String getResponseMessage() {
 return responseMessage;
 }

 public void setResponseMessage(String responseMessage) {
 this.responseMessage = responseMessage;
 }
}

六控制器

/**
 * @Author lsc
 * @Description <p>websockets 之 广播式</p>
 * @Date 2019/11/12 22:49
 */
@Controller
public class WebSocketsController {

 @MessageMapping("/welcome")//类似@RequestMapping，进行客户端请求地址映射
 @SendTo("/topic/getResponse")//订阅了@SendTo中的路径进行发送消息
 public SendMessages broadcast(AcceptMessages acceptMessages){
 System.out.println(acceptMessages.getName());
 SendMessages sendMessages = new SendMessages();
 sendMessages.setResponseMessage("知识追寻者:"+acceptMessages.getName());
 return sendMessages;
 }

}

七前端页面

在 resource目录下新建templates目录存放WebSockets.html;在resource目录下新建static目录，继续在其子目录下新建js目录存放sockjs.min.js，stomp.min.js，jquery-3.3.1.min.js；

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
 <meta charset="UTF-8"/>
 <title>springboot广播式WebSocket</title>
</head>
<body onload="disconnect()">
<noscript><h2 style="color: #ffff0000;">Sorry,not support the WebSocket</h2></noscript>
<div>
 <div>
 <button id="connect" onclick="connect();">连接</button>
 <button id="disconnect" disabled="disabled" onclick="disconnect();">断开连接</button>
 </div>
 <div id="conversationDiv">
 <label>输入你的名字</label>
 <input type="text" id="name"/>
 <button id="sendName" onclick="sendName();">发送</button>
 <p id="response"></p>
 </div>
</div>
<script th:src="@{js/sockjs.min.js}"></script>
<script th:src="@{js/stomp.min.js}"></script>
<script th:src="@{js/jquery-3.3.1.min.js}"></script>
<script type="text/javascript">
 var stompClient = null;
 // 设置连接
 function setConnected(connected) {
 document.getElementById("connect").disabled = connected;
 document.getElementById("disconnect").disabled = !connected;
 document.getElementById("conversationDiv").style.visibility = connected ? 'visible' : 'hidden';
 $("#response").html();
 }
 // 连接
 function connect() {
 // 转向 endpoint 名为websocket
 var socket = new SockJS('/websocket');
 // 使用ssocket的协议
 stompClient = Stomp.over(socket);
 // 连接
 stompClient.connect({}, function (frame) {
 setConnected(true);
 console.log('Connected:' + frame);
 // @Sendto 中定义路径 向目标订阅消息
 stompClient.subscribe('/topic/getResponse', function (response) {
 showResponse(JSON.parse(response.body).responseMessage);
 })
 });
 }
 function disconnect() {
 if (stompClient != null) {
 stompClient.disconnect();
 }
 setConnected(false);
 console.log('Disconnected');
 }
 function sendName() {
 var name = $('#name').val();
 // 控制器@MessageMapping中定义向目标发送消息
 stompClient.send("/welcome", {}, JSON.stringify({'name': name}));
 }
 function showResponse(message) {
 $("#response").html(message);
 }
</script>
</body>
</html>

八视图转发

当客户端请求地址是localhost:8080/ws，经过springmvc视图转发器至WebSockets.html;

/**
 * @Author lsc
 * @Description <p> spingmvc视图映射转发</p>
 * @Date 2019/11/12 23:35
 */
@Configurable
@Component
public class WebMvcConfig implements WebMvcConfigurer {

 @Override
 public void addViewControllers(ViewControllerRegistry registry) {
 // 配置视图转发
 registry.addViewController("/ws").setViewName("/WebSockets");
 }
}

九效果图

即一个浏览器发送消息，其它连接的浏览器也能收到消息，即广播形式；

十参考文献

spring-web

源码

总结

以上所述是小编给大家介绍的springboot集成WebSockets广播消息，希望对大家有所帮助！

SpringBoot集成WebSocket【基于纯H5】进行点对点[一对一]和广播[一对多]实时推送

之前实现WebSocket基于STOMP的,觉得SpringBoot封装的太高,不怎么灵活,现在实现一个纯H5的,也大概了解webSocket在内部是怎么传输的. 1.环境搭建因为在上一篇基于STOMP协议实现的WebSocket里已经有大概介绍过Web的基本情况了,所以在这篇就不多说了,我们直接进入正题吧,在SpringBoot中,我们还是需要导入WebSocket的包. 在pox.xml加上对springBoot对WebSocket的支持:  <
SpringBoot webSocket实现发送广播、点对点消息和Android接收

1.SpringBoot webSocket SpringBoot 使用的websocket 协议,不是标准的websocket协议,使用的是名称叫做STOMP的协议. 1.1 STOMP协议说明 STOMP,Streaming Text Orientated Message Protocol,是流文本定向消息协议,是一种为MOM(Message Oriented Middleware,面向消息的中间件)设计的简单文本协议. 它提供了一个可互操作的连接格式,允许STOMP客户端与任意STOMP消
springboot集成WebSockets广播消息(推荐)

一 WebScoketS 简介 RFC 6455 即 webSockets 协议提供了一种标准化的方式去建立全双工,双方面交流的通道在客户端和服务端甚至单一的TCP连接中进行通信: webSockets 协议其跟HTTP的tcp协议不同,但是其设计目的是通过HTTP协议进行工作,可以使用40或者443端口和重新使用现有的防火墙规则: GET /spring-websocket-portfolio/portfolio HTTP/1.1 Host: localhost:8080 Upgrade: w
SpringBoot集成Redis实现消息队列的方法

list 原理说明 Redis 的 list 是按照插入顺序排序的字符串链表. 如图所示,可以通过 lpush 和 rpop 或者 rpush 和 lpop 实现消息队列. 1 lpush 和 rpop 2 rpush 和 lpop 消息队列功能实现引入 Redis 依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data
SpringBoot集成RocketMQ发送事务消息的原理解析

目录简介原理具体实现消费者消费者生产者消息监听器消息事务测试正常测试异常测试代码调整执行结果总结简介 RocketMQ 事务消息(Transactional Message)是指应用本地事务和发送消息操作可以被定义到全局事务中,要么同时成功,要么同时失败.RocketMQ 的事务消息提供类似 X/Open XA 的分布事务功能,通过事务消息能达到分布式事务的最终一致. 原理 RocketMQ事务消息通过异步确保方式,保证事务的最终一致性.设计的思想可以借鉴两个阶段提交事
SpringBoot集成kafka全面实战记录

本文是SpringBoot+Kafka的实战讲解,如果对kafka的架构原理还不了解的读者,建议先看一下<大白话kafka架构原理>.<秒懂kafka HA(高可用)>两篇文章. 一.生产者实践普通生产者带回调的生产者自定义分区器 kafka事务提交二.消费者实践简单消费指定topic.partition.offset消费批量消费监听异常处理器消息过滤器消息转发定时启动/停止监听器一.前戏 1.在项目中连接kafka,因为是外网,首先要开放kafka配置文件
SpringBoot集成WebSocket实现前后端消息互传的方法

什么是WebSocket? WebSocket 协议是基于 TCP 的一种新的网络协议.它实现了浏览器与服务器全双工 (full-duplex) 通信-允许服务器主动发送信息给客户端. 为什么需要WebSocket? 大家都知道以前客户端想知道服务端的处理进度,要不停地使用 Ajax 进行轮询,让浏览器隔个几秒就向服务器发一次请求,这对服务器压力较大.另外一种轮询就是采用 long poll 的方式,这就跟打电话差不多,没收到消息就一直不挂电话,也就是说,客户端发起连接后,如果没消息,就一直不返
详解SpringBoot集成消息队列的案例应用

目录背景方案规划统一设计集成Redis消息队列集成ActiveMQ消息队列使用示例背景最近在对公司开发框架进行优化,框架内涉及到多处入库的日志记录,例如登录日志/操作日志/访问日志/业务执行日志,集成在业务代码中耦合度较高且占用业务操作执行时间,所以准备集成相关消息队列进行代码解耦方案规划现有的成熟消息队列组件非常多,例如RabbitMQ,ActiveMQ,Kafka等,考虑到业务并发量不高且框架已经应用于多个项目平稳运行,准备提供基于Redis的消息队列和集成ActiveM
Springboot详解RocketMQ实现广播消息流程

RocketMQ消息模式主要有两种:广播模式.集群模式(负载均衡模式) 广播模式是每个消费者,都会消费消息: 负载均衡模式是每一个消费只会被某一个消费者消费一次: 我们业务上一般用的是负载均衡模式,当然一些特殊场景需要用到广播模式,比如发送一个信息到邮箱,手机,站内提示: 我们可以通过@RocketMQMessageListener的messageModel属性值来设置,MessageModel.BROADCASTING是广播模式,MessageModel.CLUSTERING是默认集群负载均衡
springboot集成websocket的四种方式小结

目录 1. 原生注解 2. Spring封装 3. TIO STOMP Session 共享的问题如何选择其它参考链接 1. 原生注解 pom.xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> WebSocketConfi
SpringBoot集成Kafka 配置工具类的详细代码

目录 1.单播模式,只有一个消费者组 2.广播模式,多个消费者组 spring-kafka 是基于 java版的 kafka client与spring的集成,提供了 KafkaTemplate,封装了各种方法,方便操作,它封装了apache的kafka-client,不需要再导入client依赖  <dependency> <groupId>org.springframework.kafka</groupId> <arti

springboot集成WebSockets广播消息(推荐)

相关推荐

随机推荐