前面为大家讲述了 Spring Boot的整合Redis、RabbitMQ、Elasticsearch等各种框架组件;随着移动互联网的发展,服务端消息数据推送已经是一个非常重要、非常普遍的基础功能。今天就和大家聊聊在SpringBoot轻松整合WebSocket,实现Web在线聊天室,希望能对大家有所帮助。
创新互联从2013年成立,先为容城等服务建站,容城等地企业,进行企业商务咨询服务。为容城企业网站制作PC+手机+微官网三网同步一站式服务解决您的所有建站问题。
WebSocket协议是基于TCP的一种网络协议,它实现了浏览器与服务器全双工(Full-duplex)通信。它允许服务端主动向客户端推送数据,这使得客户端和服务器之间的数据交换变得更加简单高效。在WebSocket API中,浏览器和服务器只需要完成一次握手,两者之间就可以创建持久性的连接,并进行双向数据传输。
WebSocket 在握手之后便直接基于 TCP 进行消息通信,只是 TCP的基础上的一层非常轻的封装,它只是将TCP的字节流转换成消息流(文本或二进制),至于怎么解析这些消息的内容完全依赖于应用本身。
我们知道HTTP 协议有一个缺陷:通信只能由客户端发起,服务器端无法向某个客户端推送数据。然而,在某些场景下,数据推送是非常必要的功能,为了实现推送技术,所用的技术都是轮询,即:客户端在特定的的时间间隔(如每 1 秒),由浏览器对服务器发出 HTTP 请求,然后由服务器返回最新的数据给客户端的浏览器。
例如,在外卖场景下,当骑手位置更新时,服务器端向客户端推送骑手位置数据。如果使用HTTP协议,那么就只能轮询。轮询模式具有很明显的缺点,即浏览器需要不断地向服务器发出请求,然而 HTTP 请求可能包含较长的头部,其中真正有效的数据可能只是很小的一部分,显然这样会浪费很多的带宽等资源,同样,数据时效性较低,存在一定的数据延迟。
在这种情况下,WebSocket 出现了,使用 WebSocket 协议可以实现由服务端主动向客户端推送消息,同时也可以实现客户端向服务器端发送消息。这样能更好得节省服务器资源和带宽;并且能够更实时地进行通讯。随着HTML 5 的流行, WebSocket已经成为国际标准,目前主流的浏览器都已经支持。
随着移动互联网的发展,WebSocket的使用越来越广泛。基本上只要是时效性要求高的业务场景都可以使用WebSocket,例如:
除此之外,还有系统消息通知、用户上下线提醒、客户端数据同步,实时数据更新,多屏幕同步,用户在线状态,消息扫描二维码登录/二维码支付,弹幕、各类信息提醒,在线选座,实时监控大屏等等;
我们知道HTTP协议使用http和https的统一资源标志符。WebSocket与HTTP类似,使用的是 ws 或 wss(类似于 HTTPS),其中 wss 表示在 TLS 之上的Websocket。例如:
ws://cdxwcx.com/wsapiwss://secure.cdxwcx.com/
WebSocket 使用和 HTTP 相同的 TCP 端口,可以绕过大多数防火墙的限制。默认情况下, WebSocket 协议使用80 端口;运行在 TLS 之上时,默认使用 443 端口。
WebSocket 只是在 Socket 协议的基础上,非常轻的一层封装。在WebSocket API中定义了open、close、error、message等几个基本事件,这就使得WebSocket使用起来非常简单。 下面是在WebSocket API定义的事件:
事件 |
事件处理程序 |
描述 |
open |
Sokcket onopen |
连接建立时触发 |
message |
Sokcket onmessage |
客户端接收服务端数据时触发 |
error |
Sokcket onerror |
通讯发生错误时触发 |
close |
Sokcket onclose |
连接关闭时触发 |
Spring Boot 提供了 Websocket 组件 spring-boot-starter-websocket,用来支持在 Spring Boot环境下对Websocket 的使用。
下面我们就以多人在线聊天室为例,演示 Spring Boot 是如何整合Websocket 实现服务端消息推送的。
3.1 创建前端页面
首先,创建spring boot项目:spring-boot-starter-websocket。接下来,我们构建前台交互页面,创建index.html页面并在 js 中实现WebSocket通讯,完整页面代码如下所示:
Chat Room
上面的示例中,js中定义了WebSocket通讯相关的代码,如:ws.onopen、ws.onmessage、ws.onclose等事件。
接下来,我们开始创建后台WebSocket服务,实现WebSocket后台通讯服务。
首先,修改项目的pom.xml文件,主要添加 Web 和 Websocket 组件。具体代码如下所示:
org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-websocket org.springframework.boot spring-boot-starter-test test
首先创建ChatServerEndpoint类,并使用@ServerEndpoint注解创建WebSocket EndPoint实现客户端连接、消息的接收、等事件。具体示例代码如下所示:
@RestController@ServerEndpoint("/chat/{username}")public class ChatServerEndpoint { private static final Logger logger = LoggerFactory.getLogger(ChatRoomServerEndpoint.class);
@OnOpen public void openSession(@PathParam("username") String username, Session session) { ONLINE_USER_SESSIONS.put(username, session); String message = "欢迎用户[" + username + "] 来到聊天室!"; logger.info("用户登录:"+message); sendMessageAll(message); }
@OnMessage public void onMessage(@PathParam("username") String username, String message) { logger.info("发送消息:"+message); sendMessageAll("用户[" + username + "] : " + message); }
@OnClose public void onClose(@PathParam("username") String username, Session session) { //当前的Session 移除 ONLINE_USER_SESSIONS.remove(username); //并且通知其他人当前用户已经离开聊天室了 sendMessageAll("用户[" + username + "] 已经离开聊天室了!"); try { session.close(); } catch (IOException e) { logger.error("onClose error",e); } }
@OnError public void onError(Session session, Throwable throwable) { try { session.close(); } catch (IOException e) { logger.error("onError excepiton",e); } logger.info("Throwable msg "+throwable.getMessage()); }}
上面的示例中,我们使用 @ServerEndpoint("/chat/{username}") 注解监听此地址的 WebSocket 信息,客户端也是通过此地址向服务端接收和发送消息。同时使用@OnOpen注解实现客户端连接事件,@OnMessage注解实现消息发送事件,@OnClose注解实现客户端连接关闭事件,@OnError注解实现消息错误事件。
我们先创建一个 WebSocketUtils 工具类,用来存储聊天室在线的用户信息,以及向客户端发送消息的功能。具体代码如下所示:
public final class WebSocketUtils { private static final Logger logger = LoggerFactory.getLogger(WebSocketUtils.class);
// 存储 websocket session public static final MapONLINE_USER_SESSIONS = new ConcurrentHashMap<>();
/** * @param session 用户 session * @param message 发送内容 */public static void sendMessage(Session session, String message){ if (session == null) { return; } final RemoteEndpoint.Basic basic = session.getBasicRemote(); if (basic == null) { return; } try { basic.sendText(message); } catch (IOException e) { logger.error("sendMessage IOException ",e); } }
/** * 推送消息到其他客户端 * @param message */public static void sendMessageAll(String message){ ONLINE_USER_SESSIONS.forEach((sessionId, session) -> sendMessage(session, message)); }}
修改项目启动类,需要添加 @EnableWebSocket 开启 WebSocket 功能。具体示例代码如下所示:
@EnableWebSocket@SpringBootApplicationpublic class WebSocketApplication {
public static void main(String[] args){ SpringApplication.run(WebSocketApplication.class, args); }
@Beanpublic ServerEndpointExporter serverEndpointExporter(){ return new ServerEndpointExporter(); }}
以上,我们WebSocket服务端内容就实现完毕了。接下来我们验证整个聊天室功能是否正常?
前面,我们已经把整个WebSocket聊天室的前后台功能介绍完了。接下来我们验证整个聊天室功能是否正常?
首先,启动项目,在浏览器中分别输入地址:http://localhost:8080/ 打开三个聊天室页面。如下图所示:
然后,分别在三个聊天室页面中,输入三个昵称并加入聊天室,与服务端成功建立WebSocket连接,即可在聊天室发送消息。
点击页面上的离开聊天室,此页面与服务端建立的WebSocket连接就会断开。其他连接不受影响。
以上,我们就把Spring Boot整合WebSocket,实现BBS聊天室的功能介绍完了。WebSocket能够以非常简单的方式,实现客户端与服务器端的双向通讯。在实际项目开发过程中使用越来越广泛,希望大家能熟悉掌握。
本文题目:SpringBoot轻松整合WebSocket实现Web在线聊天室
当前网址:http://www.shufengxianlan.com/qtweb/news16/291916.html
网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等
声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联