@serverendpoint注解_SpringBoot 使用WebSocket打造在线聊天室(基于注解)
推荐WebSocket的三大理由:
- 1、采用全双工通信,摆脱传统HTTP轮询的窘境。
- 2、采用W3C国际标准,完美支持HTML5。
- 3、简单高效,容易上手。
学习目标
快速学会通过WebSocket编写简单聊天功能。
温馨提示:
1、WebSocket是HTML5开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。在WebSocket API中,浏览器和服务器只需要做一个握手的动作,然后,浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。
2、浏览器通过 JavaScript 向服务器发出建立 WebSocket 连接的请求,连接建立以后,客户端和服务器端就可以通过 TCP 连接直接交换数据。
3、当你获取 Web Socket 连接后,你可以通过 send() 方法来向服务器发送数据,并通过 onmessage 事件来接收服务器返回的数据。
使用教程
一、打造 WebSocket 聊天客户端
温馨提示:得益于W3C国际标准的实现,我们在浏览器JS就能直接创建WebSocket对象,再通过简单的回调函数就能完成WebSocket客户端的编写,非常简单!接下来让我们一探究竟。
使用说明:
使用步骤:1、获取WebSocket客户端对象。
例如: var webSocket = new WebSocket(url);
使用步骤:2、获取WebSocket回调函数。
例如:webSocket.onmessage = function (event) {console.log('WebSocket收到消息:' + event.data);
使用步骤:3、发送消息给服务端
例如:webSokcet.send(jsonStr) 结合实际场景 本案例采用JSON字符串进行消息通信。
具体实现:
下面是本案例在线聊天的客户端实现的JS代码,附带详细注释。
========================================================================
二、打造 WebSocket 聊天服务端
温馨提示:得益于SpringBoot提供的自动配置,我们只需要通过简单注解@ServerEndpoint就就能创建WebSocket服务端,再通过简单的回调函数就能完成WebSocket服务端的编写,比起客户端的使用同样非常简单!
使用说明:
首先在POM文件引入spring-boot-starter-websocket 、thymeleaf 、FastJson等依赖。
使用步骤:1、开启WebSocket服务端的自动注册。
【这里需要特别提醒:ServerEndpointExporter 是由Spring官方提供的标准实现,用于扫描ServerEndpointConfig配置类和@ServerEndpoint注解实例。使用规则也很简单:1.如果使用默认的嵌入式容器 比如Tomcat 则必须手工在上下文提供ServerEndpointExporter。2. 如果使用外部容器部署war包,则不要提供提供ServerEndpointExporter,因为此时SpringBoot默认将扫描服务端的行为交给外部容器处理。】
@Configurationpublic class WebSocketConfig { @Bean public ServerEndpointExporter serverEndpointExporter() { return new ServerEndpointExporter(); }}
使用步骤:2、创建WebSocket服务端。
核心思路:
- ① 通过注解@ServerEndpoint来声明实例化WebSocket服务端。
- ② 通过注解@OnOpen、@OnMessage、@OnClose、@OnError 来声明回调函数。
- ③ 通过ConcurrentHashMap保存全部在线会话对象。
@Component@ServerEndpoint("/chat")//标记此类为服务端public class WebSocketChatServer { /** * 全部在线会话 PS: 基于场景考虑 这里使用线程安全的Map存储会话对象。 */ private static Map onlineSessions = new ConcurrentHashMap<>(); /** * 当客户端打开连接:1.添加会话对象 2.更新在线人数 */ @OnOpen public void onOpen(Session session) { onlineSessions.put(session.getId(), session); sendMessageToAll(Message.jsonStr(Message.ENTER,