6个 Spring websocket注解:整体架构分析与注解应用案例(必须收藏)
toyiye 2024-09-14 13:31 3 浏览 0 评论
Spring Websocket是Spring框架中的一个关键组件,专门用于实现WebSocket通信。通过 @EnableWebSocket注解,它简化了WebSocket的配置和启用过程。利用 @ServerEndpoint注解,开发者可以轻松定义WebSocket端点,处理来自客户端的连接和消息。Spring Websocket支持全双工通信,允许服务器和客户端之间进行实时、双向的数据交换。此外,通过 @EnableWebSocketMessageBroker注解,它还能与STOMP消息代理集成,提供更高级的消息传递功能。这些注解的结合使用,为构建响应式和实时的Web应用程序提供了强大的支持。
肖哥弹架构 跟大家“弹弹” 框架注解使用,需要代码关注
欢迎 点赞,关注,评论。
关注公号Solomon肖哥弹架构获取更多精彩内容
历史热点文章
- 28个验证注解,通过业务案例让你精通Java数据校验(收藏篇)
- Java 8函数式编程全攻略:43种函数式业务代码实战案例解析(收藏版)
- 69 个Spring mvc 全部注解:真实业务使用案例说明(必须收藏)
- 24 个Spring bean 全部注解:真实业务使用案例说明(必须收藏)
- MySQL索引完全手册:真实业务图文讲解17种索引运用技巧(必须收藏)
- 一个项目代码讲清楚DO/PO/BO/AO/E/DTO/DAO/ POJO/VO
Spring Websocket架构图
这是一个高层次的架构图,用于展示Spring Websocket组件之间的基本关系。其中还会有更多的组件和配置,例如消息代理、安全配置、错误处理等
- 客户端 发起WebSocket请求到 WebSocket服务器。
- WebSocket服务器 可以是一个嵌入的服务器,如Tomcat或Netty,它处理WebSocket请求。
- ServerEndpointExporter 用于自动注册使用 @ServerEndpoint 注解的类。
- WebSocketConfigurer 允许自定义WebSocket配置,如注册额外的WebSocket处理器或拦截器。
- WebSocketHandlerRegistry 用于注册WebSocket处理器和它们的URL路径。
- @ServerEndpoint 定义了WebSocket服务器端点,它是客户端连接的入口点。
- WebSocketHandler 是一个接口,用于处理WebSocket生命周期事件。
- TextWebSocketHandler 和 BinaryWebSocketHandler 分别用于处理文本和二进制消息。
- @OnOpen, @OnMessage, @OnClose, @OnError 用于标记处理WebSocket连接的不同阶段的方法。
1. 配置和启用注解
@EnableWebSocket
- 注解作用介绍
@EnableWebSocket 注解用于Spring配置类上,启用基于 @ServerEndpoint的简单WebSocket支持。
- 注解属性介绍
无特定属性。
- 注解业务案例
@Configuration
@EnableWebSocket
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
@EnableWebSocketMessageBroker
- 注解作用介绍
@EnableWebSocketMessageBroker 注解用于Spring配置类上,启用STOMP协议支持和消息代理功能。
- 注解属性介绍
无特定属性。
- 注解业务案例
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketMessageBrokerConfig implements WebSocketMessageBrokerConfigurer {
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/ws").setAllowedOrigins("*").withSockJS();
}
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
registry.enableSimpleBroker("/topic", "/queue");
registry.setApplicationDestinationPrefixes("/app");
}
}
2. 定义WebSocket端点
@ServerEndpoint
- 注解作用介绍
@ServerEndpoint 注解用于类上,定义一个WebSocket服务器端点,指定客户端连接的URL路径。
- 注解属性介绍value: 指定WebSocket端点的URL路径。configurator: 指定自定义的 ServerEndpointConfigurator。
- 注解业务案例
@ServerEndpoint(value = "/ws/notifications", configurator = MyConfigurator.class)
public class NotificationEndpoint {
@OnOpen
public void onOpen(Session session) {
// 处理新连接
}
@OnMessage
public void onMessage(Session session, String message) {
// 处理接收到的消息
}
@OnClose
public void onClose(Session session) {
// 处理连接关闭
}
@OnError
public void onError(Session session, Throwable error) {
// 处理连接中的错误
}
}
public class MyConfigurator implements ServerEndpointConfigurator {
// 自定义配置
}
3. 处理WebSocket生命周期事件
@OnOpen
- 注解作用介绍
@OnOpen 注解用于方法上,当WebSocket连接打开时触发。
- 注解属性介绍
无特定属性。
- 注解业务案例
public class NotificationEndpoint {
@OnOpen
public void onOpen(Session session) {
// 可以记录日志、初始化资源或发送欢迎消息
}
}
@OnClose
- 注解作用介绍
@OnClose 注解用于方法上,当WebSocket连接关闭时触发。
- 注解属性介绍
无特定属性。
- 注解业务案例
public class NotificationEndpoint {
@OnClose
public void onClose(Session session) {
// 可以记录日志、清理资源
}
}
@OnError
- 注解作用介绍
@OnError 注解用于方法上,当WebSocket连接发生错误时触发。
- 注解属性介绍
无特定属性。
- 注解业务案例
public class NotificationEndpoint {
@OnError
public void onError(Session session, Throwable error) {
// 可以记录错误日志、执行错误恢复操作
}
}
4. 接收和发送消息
@OnMessage
- 注解作用介绍 @OnMessage 注解用于方法上,当服务器接收到客户端发送的WebSocket消息时触发。
- 注解属性介绍String: 方法参数可以直接接收文本消息。byte[]: 方法参数可以接收二进制消息。Object: 方法参数可以接收反序列化后的自定义对象消息。
- 注解业务案例
public class NotificationEndpoint {
@OnMessage
public void onMessage(Session session, String message) {
// 处理接收到的文本消息
}
@OnMessage
public void onMessage(Session session, byte[] data) {
// 处理接收到的二进制消息
}
// 假设有一个自定义的消息类
@OnMessage
public void onMessage(Session session, MyCustomMessage message) {
// 处理接收到的自定义对象消息
}
}
5、综合性的应用案例
1. Spring Boot启动类
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ChatApplication {
public static void main(String[] args) {
SpringApplication.run(ChatApplication.class, args);
}
}
2. WebSocket配置类
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.*;
@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
registry.addHandler(chatEndpoint(), "/chat")
.setAllowedOrigins("*")
.withSockJS();
}
@Bean
public ChatEndpoint chatEndpoint() {
return new ChatEndpoint();
}
}
3. WebSocket服务器端点
import org.springframework.web.socket.*;
import org.springframework.stereotype.Component;
@Component
@ServerEndpoint("/chat")
public class ChatEndpoint {
private final ChatService chatService;
@Autowired
public ChatEndpoint(ChatService chatService) {
this.chatService = chatService;
}
@OnOpen
public void onOpen(Session session) {
chatService.addSession(session);
}
@OnClose
public void onClose(Session session) {
chatService.removeSession(session);
}
@OnError
public void onError(Session session, Throwable error) {
chatService.removeSession(session);
}
@OnMessage
public void onMessage(Session session, String message) {
chatService.broadcast(message);
}
}
4. 聊天业务逻辑服务
import org.springframework.stereotype.Service;
import java.util.concurrent.ConcurrentHashMap;
@Service
public class ChatService {
private final Map<String, WebSocketSession> sessions = new ConcurrentHashMap<>();
public void addSession(WebSocketSession session) {
sessions.put(session.getId(), session);
}
public void removeSession(WebSocketSession session) {
sessions.remove(session.getId());
}
public void broadcast(String message) {
sessions.values().forEach(session -> {
try {
session.sendMessage(new TextMessage(message));
} catch (IOException e) {
// Handle exception
}
});
}
}
5. 前端页面JavaScript代码
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Chat App</title>
</head>
<body>
<ul id="messages"></ul>
<form id="form" onsubmit="return false;">
<input type="text" id="message" autocomplete="off">
<button type="submit" onclick="sendMessage()">Send</button>
</form>
<script type="text/javascript">
const socket = new WebSocket("ws://localhost:8080/chat");
const messages = document.getElementById('messages');
const form = document.getElementById('form');
const messageInput = document.getElementById('message');
form.onsubmit = () => sendMessage();
socket.onmessage = function(event) {
const message = document.createElement('li');
message.textContent = event.data;
messages.appendChild(message);
};
function sendMessage() {
const message = messageInput.value;
if (message) {
socket.send(message);
messageInput.value = '';
}
}
</script>
</body>
</html>
- 启动Spring Boot应用后, ChatApplication 类会初始化整个应用。
- WebSocketConfig 类通过 @EnableWebSocket 启用WebSocket支持,并注册 ChatEndpoint 端点。
- ChatEndpoint 类使用 @ServerEndpoint 注解定义WebSocket端点,并处理客户端连接、消息广播和异常。
- ChatService 类管理WebSocket会话,并提供广播消息的方法。
- 前端页面提供一个简单的聊天界面,用户可以输入消息并发送。消息通过WebSocket发送到服务器,服务器再将消息广播给所有连接的客户端。
相关推荐
- 为何越来越多的编程语言使用JSON(为什么编程)
-
JSON是JavascriptObjectNotation的缩写,意思是Javascript对象表示法,是一种易于人类阅读和对编程友好的文本数据传递方法,是JavaScript语言规范定义的一个子...
- 何时在数据库中使用 JSON(数据库用json格式存储)
-
在本文中,您将了解何时应考虑将JSON数据类型添加到表中以及何时应避免使用它们。每天?分享?最新?软件?开发?,Devops,敏捷?,测试?以及?项目?管理?最新?,最热门?的?文章?,每天?花?...
- MySQL 从零开始:05 数据类型(mysql数据类型有哪些,并举例)
-
前面的讲解中已经接触到了表的创建,表的创建是对字段的声明,比如:上述语句声明了字段的名称、类型、所占空间、默认值和是否可以为空等信息。其中的int、varchar、char和decimal都...
- JSON对象花样进阶(json格式对象)
-
一、引言在现代Web开发中,JSON(JavaScriptObjectNotation)已经成为数据交换的标准格式。无论是从前端向后端发送数据,还是从后端接收数据,JSON都是不可或缺的一部分。...
- 深入理解 JSON 和 Form-data(json和formdata提交区别)
-
在讨论现代网络开发与API设计的语境下,理解客户端和服务器间如何有效且可靠地交换数据变得尤为关键。这里,特别值得关注的是两种主流数据格式:...
- JSON 语法(json 语法 priority)
-
JSON语法是JavaScript语法的子集。JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔花括号保存对象方括号保存数组JS...
- JSON语法详解(json的语法规则)
-
JSON语法规则JSON语法是JavaScript对象表示法语法的子集。数据在名称/值对中数据由逗号分隔大括号保存对象中括号保存数组注意:json的key是字符串,且必须是双引号,不能是单引号...
- MySQL JSON数据类型操作(mysql的json)
-
概述mysql自5.7.8版本开始,就支持了json结构的数据存储和查询,这表明了mysql也在不断的学习和增加nosql数据库的有点。但mysql毕竟是关系型数据库,在处理json这种非结构化的数据...
- JSON的数据模式(json数据格式示例)
-
像XML模式一样,JSON数据格式也有Schema,这是一个基于JSON格式的规范。JSON模式也以JSON格式编写。它用于验证JSON数据。JSON模式示例以下代码显示了基本的JSON模式。{"...
- 前端学习——JSON格式详解(后端json格式)
-
JSON(JavaScriptObjectNotation)是一种轻量级的数据交换格式。易于人阅读和编写。同时也易于机器解析和生成。它基于JavaScriptProgrammingLa...
- 什么是 JSON:详解 JSON 及其优势(什么叫json)
-
现在程序员还有谁不知道JSON吗?无论对于前端还是后端,JSON都是一种常见的数据格式。那么JSON到底是什么呢?JSON的定义...
- PostgreSQL JSON 类型:处理结构化数据
-
PostgreSQL提供JSON类型,以存储结构化数据。JSON是一种开放的数据格式,可用于存储各种类型的值。什么是JSON类型?JSON类型表示JSON(JavaScriptO...
- JavaScript:JSON、三种包装类(javascript 包)
-
JOSN:我们希望可以将一个对象在不同的语言中进行传递,以达到通信的目的,最佳方式就是将一个对象转换为字符串的形式JSON(JavaScriptObjectNotation)-JS的对象表示法...
- Python数据分析 只要1分钟 教你玩转JSON 全程干货
-
Json简介:Json,全名JavaScriptObjectNotation,JSON(JavaScriptObjectNotation(记号、标记))是一种轻量级的数据交换格式。它基于J...
- 比较一下JSON与XML两种数据格式?(json和xml哪个好)
-
JSON(JavaScriptObjectNotation)和XML(eXtensibleMarkupLanguage)是在日常开发中比较常用的两种数据格式,它们主要的作用就是用来进行数据的传...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- r语言矩阵 (127)
- browsererror (114)
- exportexcel (119)
- cv2.bitwise_not (137)
- dump命令 (128)
- es6concat (126)
- heapify (127)
- java.security.egd (130)
- javax.annotation (117)
- jsstringsplit (117)
- js数字 (115)
- maven编译 (132)
- mysqlleft (128)
- nodejsbuffer (149)
- org.apache.commons.httpclient (126)
- org.jsoup (141)
- org.springframework.web (128)
- robotframework-ride (115)
- setnocounton (141)
- socket.gethostbyname (122)
- sqlmid (121)
- time.strptime (133)
- vscode格式化 (125)
- win32con (129)
- window.localstorage (126)