SpringBoot轻松整合WebSocket实现Web在线聊天室

前面为大家讲述了 Boot的整合Redis、、等各种框架组件；随着移动互联网的发展，服务端消息数据推送已经是一个非常重要、非常普遍的基础功能。今天就和大家聊聊在轻松整合，实现Web在线聊天室，希望能对大家有所帮助。

一、简介1.1 什么是？

协议是基于TCP的一种网络协议，它实现了浏览器与服务器全双工（Full-）通信。它允许服务端主动向客户端推送数据，这使得客户端和服务器之间的数据交换变得更加简单高效。在 API中，浏览器和服务器只需要完成一次握手，两者之间就可以创建持久性的连接，并进行双向数据传输。

在握手之后便直接基于 TCP 进行消息通信，只是 TCP的基础上的一层非常轻的封装，它只是将TCP的字节流转换成消息流（文本或二进制），至于怎么解析这些消息的内容完全依赖于应用本身。

1.2 为什么需要？

我们知道HTTP 协议有一个缺陷：通信只能由客户端发起，服务器端无法向某个客户端推送数据。然而，在某些场景下，数据推送是非常必要的功能，为了实现推送技术，所用的技术都是轮询，即：客户端在特定的的时间间隔（如每 1 秒），由浏览器对服务器发出 HTTP 请求，然后由服务器返回最新的数据给客户端的浏览器。

例如，在外卖场景下，当骑手位置更新时，服务器端向客户端推送骑手位置数据。如果使用HTTP协议，那么就只能轮询。轮询模式具有很明显的缺点，即浏览器需要不断地向服务器发出请求，然而 HTTP 请求可能包含较长的头部，其中真正有效的数据可能只是很小的一部分，显然这样会浪费很多的带宽等资源，同样，数据时效性较低，存在一定的数据延迟。

在这种情况下，出现了，使用协议可以实现由服务端主动向客户端推送消息，同时也可以实现客户端向服务器端发送消息。这样能更好得节省服务器资源和带宽；并且能够更实时地进行通讯。随着HTML 5 的流行，已经成为国际标准，目前主流的浏览器都已经支持。

1.3 的优点

1.4 的应用场景

随着移动互联网的发展，的使用越来越广泛。基本上只要是时效性要求高的业务场景都可以使用，例如：

除此之外，还有系统消息通知、用户上下线提醒、客户端数据同步，实时数据更新，多屏幕同步，用户在线状态，消息扫描二维码登录/二维码支付，弹幕、各类信息提醒，在线选座，实时监控大屏等等；

二、的事件

我们知道HTTP协议使用http和https的统一资源标志符。与HTTP类似，使用的是 ws 或 wss（类似于 HTTPS），其中 wss 表示在 TLS 之上的。例如：

ws://example.com/wsapiwss://secure.example.com/

使用和 HTTP 相同的 TCP 端口，可以绕过大多数防火墙的限制。默认情况下，协议使用80 端口；运行在 TLS 之上时，默认使用 443 端口。

只是在协议的基础上，非常轻的一层封装。在 API中定义了open、close、error、等几个基本事件，这就使得使用起来非常简单。下面是在 API定义的事件：

事件

事件处理程序

描述

open

连接建立时触发

客户端接收服务端数据时触发

error

通讯发生错误时触发

连接关闭时触发

三、 Boot整合实现聊天室

Boot 提供了组件 -boot--，用来支持在 Boot环境下对的使用。

下面我们就以多人在线聊天室为例，演示 Boot 是如何整合实现服务端消息推送的。

3.1 创建前端页面

首先，创建 boot项目：-boot--。接下来，我们构建前台交互页面，创建index.html页面并在 js 中实现通讯，完整页面代码如下所示：

<html xmlns="http://www.w3.org/1999/xhtml"><head>    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    <title>Chat Roomtitle>    <script type="text/javascript">        var urlPrefix ='ws://localhost:8080/chat/';        var ws = null;        // 加入        function join() {            var username = document.getElementById('uid').value;            var url = urlPrefix + username;            ws = new WebSocket(url);            ws.onmessage = function(event){                var ta = document.getElementById('responseText');                ta.value += event.data+"\r\n";            };            ws.onopen = function(event){                var ta = document.getElementById('responseText');                ta.value += "建立 websocket 连接... \r\n";            };            ws.onclose = function(event){                var ta = document.getElementById('responseText');                ta.value += "用户["+username+"] 已经离开聊天室! \r\n";                ta.value += "关闭 websocket 连接. \r\n";            };        }
        // 退出        function exit(){            if(ws) {                ws.close();            }        }
        // 发送消息        function send(){            var message = document.getElementById('message').value;            if(!window.WebSocket){return;}            if(ws.readyState == WebSocket.OPEN){                ws.send(message);            }else{                alert("WebSocket 连接没有建立成功！");            }        }script>head><body><form onSubmit="return false;">    <h3>BBS聊天室h3>    <textarea id="responseText" style="width: 1024px;height: 300px;">textarea>    <br/>    <br />    <label>昵称 : label><input type="text" id="uid" />      <input type="button" value="加入聊天室" onClick="join()" />  
    <input type="button" value="离开聊天室" onClick="exit()" />    <br />    <br />    <label>消息 : label><input type="text" id="message" />   <input type="button" value="发送消息" onClick="send()" />form>body>html>

上面的示例中，js中定义了通讯相关的代码，如：ws.、ws.、ws.等事件。

3.2 创建后端服务

接下来，我们开始创建后台服务，实现后台通讯服务。

step 1 ：引入相关依赖

首先，修改项目的pom.xml文件，主要添加 Web 和组件。具体代码如下所示：

<dependency>            <groupId>org.springframework.bootgroupId>            <artifactId>spring-boot-starter-webartifactId>        dependency>        <dependency>            <groupId>org.springframework.bootgroupId>            <artifactId>spring-boot-starter-websocketartifactId>        dependency>        <dependency>            <groupId>org.springframework.bootgroupId>            <artifactId>spring-boot-starter-testartifactId>            <scope>testscope>        dependency>

step2：消息接收

首先创建类，并使用@注解创建实现客户端连接、消息的接收、等事件。具体示例代码如下所示：

@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());    }}

上面的示例中，我们使用 @("/chat/{}") 注解监听此地址的信息，客户端也是通过此地址向服务端接收和发送消息。同时使用@注解实现客户端连接事件，@注解实现消息发送事件，@注解实现客户端连接关闭事件，@注解实现消息错误事件。

step3：消息发送

我们先创建一个工具类，用来存储聊天室在线的用户信息，以及向客户端发送消息的功能。具体代码如下所示：

public final class WebSocketUtils {    private static final Logger logger = LoggerFactory.getLogger(WebSocketUtils.class);
    // 存储 websocket session    public static final Map ONLINE_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));    }}

step4：开启功能

修改项目启动类，需要添加 @ 开启功能。具体示例代码如下所示：

@EnableWebSocket@SpringBootApplicationpublic class WebSocketApplication {
    public static void main(String[] args) {        SpringApplication.run(WebSocketApplication.class, args);    }
    @Bean    public ServerEndpointExporter serverEndpointExporter() {        return new ServerEndpointExporter();    }}

以上，我们服务端内容就实现完毕了。接下来我们验证整个聊天室功能是否正常？

3.3 验证测试

前面，我们已经把整个聊天室的前后台功能介绍完了。接下来我们验证整个聊天室功能是否正常？

首先，启动项目，在浏览器中分别输入地址：:8080/ 打开三个聊天室页面。如下图所示：

然后，分别在三个聊天室页面中，输入三个昵称并加入聊天室，与服务端成功建立连接，即可在聊天室发送消息。

点击页面上的离开聊天室，此页面与服务端建立的连接就会断开。其他连接不受影响。

最后

以上，我们就把 Boot整合，实现BBS聊天室的功能介绍完了。能够以非常简单的方式，实现客户端与服务器端的双向通讯。在实际项目开发过程中使用越来越广泛，希望大家能熟悉掌握。

聊天

SpringBoot轻松整合WebSocket实现Web在线聊天室

相关推荐：

评论（0）