首页 > 文章列表 > SpringBoot怎么使用WebSocket实现群发消息

SpringBoot怎么使用WebSocket实现群发消息

springboot websocket
361 2023-05-13

SpringBoot怎么使用WebSocket实现群发消息

WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议,已被 W3C 定为标准。使用 WebSocket 可以使得客户端和服务器之间的数据交换变得更加简单。在 WebSocket 协议中,浏览器和服务器只需要完成一次握手,两者之间就可以直接创建持久性的连接,并进行双向数据传输。

特点

  • WebSocket 使用时需要先创建连接,这使得 Websocket 成为一种有状态的协议,在之后的通信过程中可以省略部分状态信息(例如身份认证等)。

  • WebSocket 连接在端口 80(ws)或者 443(wss)上创建,与 HTTP 使用的端口相同,这样,基本上所有的防火墙都不会阻止 WebSocket 连接。

  • WebSocket 使用 HTTP 协议进行握手,因此它可以自然而然地集成到网络浏览器和 HTTP 服务器中,而不需要额外的成本。

  • 心跳消息(ping 和 pong)将被反复的发送,进而保持 WebSocket 连接一直处于活跃状态。

  • 使用该协议,当消息启动或者到达的时候,服务端和客户端都可以知道。

  • WebSocket 连接关闭时将发送一个特殊的关闭消息。

  • WebSocket 支持跨域,可以避免 Ajax 的限制。

  • HTTP 规范要求浏览器将并发连接数限制为每个主机名两个连接,但是当我们使用 Websocket 的时候,当握手完成之后,该限制就不存在了,因为此时的连接已经不再是 HTTP 连接了。

  • WebSocket 协议支持扩展,用户可以扩展协议,实现部分自定义的子协议。

  • WebSocket 拥有更好的二进制支持以及更好的压缩效果。

一、添加依赖

<dependency>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-starter-websocket</artifactId>

</dependency>

二、配置 WebSocket

Spring 框架提供了基于 WebSocket 的 STOMP 支持,STOMP 是一个简单的可互操作的协议,通常被用于通过中间服务器在客户端之间进行异步消息传递。

@Configuration

@EnableWebSocketMessageBroker

public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

 

    @Override

    public void configureMessageBroker(MessageBrokerRegistry config) {

        // 设置消息代理的前缀,如果消息的前缀为"/topic",就会将消息转发给消息代理(broker)

        // 再由消息代理广播给当前连接的客户端

        config.enableSimpleBroker("/topic");

        // 下面方法可以配置一个或多个前缀,通过这些前缀过滤出需要被注解方法处理的消息。

        // 例如这里表示前缀为"/app"的destination可以通过@MessageMapping注解的方法处理

        // 而其他 destination(例如"/topic""/queue")将被直接交给 broker 处理

        config.setApplicationDestinationPrefixes("/app");

    }

 

    @Override

    public void registerStompEndpoints(StompEndpointRegistry registry) {

        // 定义一个前缀为"/chart"的endpoint,并开启 sockjs 支持。

        // sockjs 可以解决浏览器对WebSocket的兼容性问题,客户端将通过这里配置的URL建立WebSocket连接

        registry.addEndpoint("/chat").withSockJS();

    }

}

三、服务端代码

根据上面 WebSocketConfig 的配置,@MessageMapping("/hello") 注解的方法将用来接收“/app/hello”路径发送来的消息,在注解方法中对消息进行处理后,再将消息转发到 @SendTo 定义的路径上。而 @SendTo 路径是一个前缀为“/topic”的路径,因此该消息被交给消息代理 broker,再由 broker 进行广播。

@Controller

public class DemoController {



    @MessageMapping("/hello")

    @SendTo("/topic/greetings")

    public Message greeting(Message message) throws Exception {

        return message;

    }



}
@Data

public class Message {



    private String name;

    

    private String content;



}

四、前端代码 

在 resources/static 目录下创建 chat.html 页面作为聊天页面。

<!DOCTYPE html>

<html lang="en">

<head>

    <meta charset="UTF-8">

    <title>群聊</title>

    <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.3.1/jquery.min.js"></script>

    <script src="https://cdn.bootcdn.net/ajax/libs/sockjs-client/1.1.2/sockjs.min.js"></script>

    <script src="https://cdn.bootcdn.net/ajax/libs/stomp.js/2.3.3/stomp.min.js"></script>

    <script>

        var stompClient = null;



        // 根据是否已连接设置页面元素状态

        function setConnected(connected) {

            $("#connect").prop("disabled", connected);

            $("#disconnect").prop("disabled", !connected);

            if (connected) {

                $("#conversation").show();

                $("#chat").show();

            }

            else {

                $("#conversation").hide();

                $("#chat").hide();

            }

            $("#greetings").html("");

        }



        // 建立一个WebSocket连接

        function connect() {

            // 用户名不能为空

            if (!$("#name").val()) {

                return;

            }

            // 首先使用 SockJS 建立连接

            var socket = new SockJS('/chat');

            // 然后创建一个STOMP实例发起连接请求

            stompClient = Stomp.over(socket);

            // 连接成功回调

            stompClient.connect({}, function (frame) {

                // 进行页面设置

                setConnected(true);

                // 订阅服务端发送回来的消息

                stompClient.subscribe('/topic/greetings', function (greeting) {

                    // 将服务端发送回来的消息展示出来

                    showGreeting(JSON.parse(greeting.body));

                });

            });

        }



        // 断开WebSocket连接

        function disconnect() {

            if (stompClient !== null) {

                stompClient.disconnect();

            }

            setConnected(false);

        }



        // 发送消息

        function sendName() {

            stompClient.send("/app/hello",

                {},

                JSON.stringify({'name': $("#name").val(),'content':$("#content").val()}));

        }



        // 将服务端发送回来的消息展示出来

        function showGreeting(message) {

            $("#greetings")

                .append("<div>" + message.name+":"+message.content + "</div>");

        }



        // 页面加载后进行初始化动作

        $(function () {

            $( "#connect" ).click(function() { connect(); });

            $( "#disconnect" ).click(function() { disconnect(); });

            $( "#send" ).click(function() { sendName(); });

        });

    </script>

</head>

<body>

<div>

    <label for="name">请输入用户名:</label>

    <input type="text" id="name" placeholder="用户名">

</div>

<div>

    <button id="connect" type="button">连接</button>

    <button id="disconnect" type="button" disabled="disabled">断开连接</button>

</div>

<div id="chat" >

    <div>

        <label for="name">请输入聊天内容:</label>

        <input type="text" id="content" placeholder="聊天内容">

    </div>

    <button id="send" type="button">发送</button>

    <div id="greetings">

        <div id="conversation" >群聊进行中...</div>

    </div>

</div>

</body>

</html>
  • SockJS 是一个浏览器JavaScript库,提供类似于WebSocket的对象。SockJS为您提供了一个一致的,跨浏览器的Javascript API,该API在浏览器和Web服务器之间创建了低延迟,全双工,跨域的通信通道。

  • STOMP 即Simple (or Streaming) Text Orientated Messaging Protocol,简单(流)文本定向消息协议,它提供了一个可互操作的连接格式,允许STOMP客户端与任意STOMP消息代理(Broker)进行交互。

  • @SendTo 注解,该注解将方法处理过的消息转发到 broker,再由 broker 进行消息广播。

五、验证结果

我们请求地址:http://127.0.0.1:8086/chat.html

登录用户:piao

登录用户:admin