STOMP实践：点对点和广播通信（系统推送公告和用户聊天功能）

Dear 丶 2022-03-17 02:51 386阅读 0赞

### 前言 ###

>         正如上文：[WebSocket实践：建立一个Web QQ应用][WebSocket_Web QQ] 所言，并不是所有的浏览器都能够支持WebSocket协议，为了使得WebSocket的应用能够兼容那些不支持的浏览器，我们可以使用STOMP协议进行处理。

### 关于WebSocket协议的一点补充： ###

http协议是无状态协议，即每次请求时都不知道前面发生了什么。而且请求只能由浏览器发起，服务器只能响应该请求，不能主动发送消息给浏览器。这种单向的协议显然在很多场景下是不适用的，比如消息推送，股票实时行情。在websocket之前，我们通常使用Ajax轮询服务器或者使用长轮询，这两种方式都极大消耗了服务端和客户端的资源。而使用websocket，我们只需要借用http协议进行握手，然后保持着一个websocket连接，直到客户端主动断开。相对于另外两种方式，websocket只发送了一次http请求，当服务器有数据时再向浏览器推送数据，减少了带宽的使用以及服务器CPU使用率。

HTTP、WebSocket 等应用层协议，都是基于 TCP 协议来传输数据的。 对于 WebSocket 来说，它必须依赖 HTTP 协议进行一次握手 ，握手成功后，数据就直接从 TCP 通道传输，与 HTTP 无关了。

### STOMP协议 ###

STOMP即Simple (or Streaming) Text Orientated Messaging Protocol，简单(流)文本定向消息协议，它提供了一个可互操作的连接格式，允许STOMP客户端与任意STOMP消息代理（Broker）进行交互。而就像HTTP在TCP套接字之上添加了请求-响应模型层一样，STOMP在WebSocket之上提供了一个基于帧的线路格式（frame-based wire format）层，用来定义消息的语义。STOMP帧由命令、一个或多个头信息以及负载所组成。例如，如下就是发送数据的一个STOMP帧：

SEND
    destination:/request/sendUser
    content-length:8
    
    user2,hi

在这个例子中，STOMP命令是send，表明会发送一些内容。紧接着是两个头信息：一个用来表示消息要发送到哪个目的地，另外一个则包含了负载的大小。然后，紧接着是一个空行。最后就是负载内容。而STOMP命令分为CONNECT、SEND、SUBSCRIBE、UNSUBSCRIBE、BEGIN、COMMIT、ABORT、ACK、NACK、DISCONNECT这几种。

在了解了STOMP的基本内容后，下面让我们看看在Spring中如何使用它吧。

### STOMP项目 ###

**1、pom.xml依赖**

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.1.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.scb</groupId>
        <artifactId>websocketdemo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>websocketdemo</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-websocket</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
    
            
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>jstl</artifactId>
                <version>1.2</version>
            </dependency>
            <dependency>
                <groupId>org.apache.tomcat.embed</groupId>
                <artifactId>tomcat-embed-jasper</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-security</artifactId>
                <version>2.0.6.RELEASE</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

其中加入了Spring Security的依赖，这是用来进行点对点通讯时使用的，后续将会看到。

**2、配置STOMP的服务端点和请求订阅前缀**

package com.scb.websocketdemo.config;
    
    import org.springframework.context.annotation.Configuration;
    import org.springframework.messaging.simp.config.MessageBrokerRegistry;
    import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
    import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
    import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
    
    @EnableWebSocketMessageBroker   //使用STOMP协议
    @Configuration
    public class StompConfig implements WebSocketMessageBrokerConfigurer {
        /**
         * 注册服务器端点
         * @param registry
         */
        @Override
        public void registerStompEndpoints(StompEndpointRegistry registry) {
            // 增加一个聊天服务端点
            registry.addEndpoint("/socket").withSockJS();
            // 增加一个用户服务端点
            registry.addEndpoint("/wsuser").withSockJS();
        }
    
        /**
         * 定义服务器端点请求和订阅前缀
         * @param registry
         */
        @Override
        public void configureMessageBroker(MessageBrokerRegistry registry) {
            // 客户端订阅路径前缀
            registry.enableSimpleBroker("/sub","/queue");
            // 服务端点请求前缀
            registry.setApplicationDestinationPrefixes("/request");
        }
    }

这里使用了@EnableWebSocketMessageBroker注解，这个注解将会启动WebSocket下的子协议STOMP。为了配置这个协议，我们实现了Spring提供的WebSocketMessageBrokerConfigurer接口。其中registerStompEndpoints方法是用来注册服务器端点，这里定义了“/socket”和“/wsuser”两个服务端点，并且在定义端点时加入了withSockJS方法，这个方法代表这可以支持SockJS（SockJS是一个第三方关于支持WebSocket请求的JavaScript框架）。而configureMessageBroker方法可以注册请求的前缀和客户端订阅的前缀。

**3、STOMP控制器**

有了步骤二中的配置类后，Spring Boot就会自动创建SimpMessagingTemplate对象，它是一个可以进行转发消息的模板，通过这个模板可以发送消息到特定的地址，甚至是限定给特定的用户发送消息。

package com.scb.websocketdemo.controller;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.messaging.handler.annotation.MessageMapping;
    import org.springframework.messaging.handler.annotation.SendTo;
    import org.springframework.messaging.simp.SimpMessagingTemplate;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    import java.security.Principal;
    
    @Controller
    @RequestMapping("/stomp")
    public class StompController {
        @Autowired
        private SimpMessagingTemplate simpMessagingTemplate;
    
        // 发送页面
        @GetMapping("/send")
        public String send(){
            return "send";
        }
    
        // 接收界面
        @GetMapping("/receive")
        public String receive(){
            return "receive";
        }
    
        // 对特定用户发送消息界面
        @GetMapping("/sendUser")
        public String sendUser(){
            return "sendUser";
        }
    
        // 接收用户消息页面
        @GetMapping("/receiveUser")
        public String receiveUser(){
            return "receiveUser";
        }
    
        // 定义消息请求路径
        @MessageMapping("/send")
        // 定义结果发送到特定路径
        @SendTo("/sub/chat")
        public String sendMsg(String value){
            // 客户端发送消息到服务端
            System.out.println("receive message from client:"+value);
            // 这里返回消息到'/sub/chat'订阅路径
            return value;
        }
    
        // 将消息发送给特定用户
        @MessageMapping("/sendUser")
        public void sendToUser(Principal principal,String body){
            String srcUser=principal.getName();
            // 解析用户和消息
            String[] args=body.split(",");
            String desUser=args[0];
            String message="["+srcUser+"] send message to you:"+args[1];
            // 将消息发送到监听地址的特定用户
            simpMessagingTemplate.convertAndSendToUser(desUser,"/queue/customer",message);
        }
    }

这里的send、receive、sendUser、receiveUser四个方法都是定义了返回Spring MVC的视图。而sendMsg和sendToUser方法都使用了@MessageMapping注解标注，这个注解与Spring MVC的@RequestMapping注解类似，是用来定义WebSocket请求的路径。当客户端访问时，需要加上“/request”前缀，因为我们在步骤二中配置了。而@SendTo注解可以把消息广播到指定路径上去，例如上面可以把消息广播到”/sub/chat”,如果客户端在这个路径订阅消息，则可以接收到消息。

在sendToUser方法中，包含了Principal参数。因此当你使用了Spring Security时，我们就可以通过Principal参数来获取当前用户的消息，然后通过SimpMessagingTemplate的convertAndSendToUser方法，设置发送给对应目的地并且限定指定的用户消息。下面我们配置下Spring Security。

**4、Spring Security配置**

package com.scb.websocketdemo.config;
    
    import org.springframework.context.annotation.Configuration;
    import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
    import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
    import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
    import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
    import org.springframework.security.crypto.password.PasswordEncoder;
    
    @Configuration
    @EnableWebSecurity
    public class SecurityConfig extends WebSecurityConfigurerAdapter {
    
        // 定义3个可以登录的内存用户
        @Override
        protected void configure(AuthenticationManagerBuilder auth) throws Exception {
            // 密码加密器
            PasswordEncoder passwordEncoder=new BCryptPasswordEncoder();
            auth.inMemoryAuthentication().passwordEncoder(passwordEncoder)
                    .withUser("user1").password(passwordEncoder.encode("p1")).roles("USER").and()
                    .withUser("user2").password(passwordEncoder.encode("p2")).roles("ADMIN").and()
                    .withUser("user3").password(passwordEncoder.encode("p3")).roles("USER");
        }
    }

**5、发送STOMP请求的客户端页面（/WEB-INF/views/send.jsp）**

这里我们使用的是JSP视图，所以在application.yml中配置下：

spring:
      mvc:
        view:
          prefix: /WEB-INF/views/
          suffix: .jsp

下面看看如何配置STOMP客户端

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
    <!DOCTYPE html>
    <html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>My WebSocket</title>
        <script type="text/javascript" src="./../js/jquery-3.3.1.min.js"></script>
        <script type="text/javascript" src="./../js/sockjs.min.js"></script>
        <script type="text/javascript" src="./../js/stomp.min.js"></script>
    </head>
    <script type="text/javascript">
        var stompClient = null;
    
        // 设置页面按钮响应事件
        function setConnected(connected) {
            $("#connect").attr({"disabled": connected});
            $("#disconnect").attr({"disabled": !connected});
            if (connected) {
                $("#conversationDiv").show();
            } else {
                $("#conversationDiv").hide();
            }
            $("#response").html("");
        }
    
        // 开启socket连接
        function connect() {
            // 定义请求服务器的端点
            var socket = new SockJS('/socket');
            // 创建stomp客户端
            stompClient = Stomp.over(socket);
            // 连接服务器端点
            stompClient.connect({}, function (frame) {
                // 建立连接后的回调
                setConnected(true);
            });
        }
    
        // 断开socket连接
        function disconnect() {
            if (stompClient != null) {
                stompClient.disconnect();
            }
            setConnected(false);
            console.log("Disconnected");
        }
    
        // 向'/request/send'服务端发送消息
        // 其中'/request'是服务器定义的请求前缀，而'/send'是@MessageMapping所配置的路径
        function sendMsg() {
            var value = $("#message").val();
            stompClient.send("/request/send", {}, value);
        }
        // 当浏览器加载页面时，会运行该函数，即默认打开连接
        connect();
    </script>
    <body>
    <div>
        <div>
            <button id="connect" onclick="connect();">连接</button>
            <button id="disconnect" disabled="disabled" onclick="disconnect();">断开连接</button>
        </div>
        <div id="conversationDiv">
            <p><label>发送的内容</label></p>
            <p><textarea id="message" rows="5"></textarea></p>
            <button id="sendMsg" onclick="sendMsg();">Send</button>
            <p id="response"></p>
        </div>
    </div>
    </body>
    </html>

这里用到了三个JavaScript库，需要自行下载，下载后放入“/resources/static/js”目录下。代码注释中已经详细解释了它们的作用下面，我们来配置个接收广播信息的页面代码。

**6、客户端订阅消息（/WEB-INF/views/receive.jsp）**

**7、广播结果截图与分析**

运行程序，访问[http://localhost:8080/stomp/send][http_localhost_8080_stomp_send]和[http://localhost:8080/stomp/receive][http_localhost_8080_stomp_receive]路径（需要先使用配置的用户登陆）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70][]

当发送数据时：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 1][]

![20190222114742654.png][]

结果分析：

send.jsp页面加载时通过connect()方法连接到服务端的“/socket”端点，然后发送数据时调用sendMsg()方法，并通过stomp客户端对象来将消息发送到服务器的“/request/send”请求处。此时StompController类的sendMsg将接收到消息，并控制台输出，最后将消息转发到"/sub/chat"订阅路径。而receive.jsp页面也连接到了服务端的“/socket”端点并订阅了该路径，所以当接收到消息时，会调用函数将id为receive的元素（这里是span标签）的html设置为消息内容。

以上就是广播的运行流程，下面我们看看点对点通讯。

**8、发送用户消息页面（/WEB-INF/views/sendUser.jsp）**

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
    <!DOCTYPE html>
    <html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>My WebSocket</title>
        <script type="text/javascript" src="./../js/jquery-3.3.1.min.js"></script>
        <script type="text/javascript" src="./../js/sockjs.min.js"></script>
        <script type="text/javascript" src="./../js/stomp.min.js"></script>
    </head>
    <script type="text/javascript">
        var stompClient = null;
    
        function setConnected(connected) {
            $("#connect").attr({"disabled": connected});
            $("#disconnect").attr({"disabled": !connected});
            if (connected) {
                $("#conversationDiv").show();
            } else {
                $("#conversationDiv").hide();
            }
            $("#response").html("");
        }
    
        function connect() {
            // 连接到'/wsuser'服务端点
            var socket = new SockJS('/wsuser');
            stompClient = Stomp.over(socket);
            stompClient.connect({}, function (frame) {
                setConnected(true);
            });
        }
    
        function disconnect() {
            if (stompClient != null) {
                stompClient.disconnect();
            }
            setConnected(false);
            console.log("Disconnected");
        }
    
        // 向'/request/sendUser'服务端发送消息
        function sendMsg() {
            var value = $("#message").val();
            var user = $("#user").val();
            // 用户名和消息组成的字符串
            var text = user + "," + value;
            stompClient.send("/request/sendUser", {}, text);
        }
    
        connect();
    </script>
    <body>
    <div>
        <div>
            <button id="connect" onclick="connect();">连接</button>
            <button id="disconnect" disabled="disabled" onclick="disconnect();">断开连接</button>
        </div>
        <div id="conversationDiv">
            <p><label>发送给用户</label></p>
            <p><input type="text" id="user"/></p>
            <p><label>发送的内容</label></p>
            <p><textarea id="message" rows="5"></textarea></p>
            <button id="sendMsg" onclick="sendMsg();">Send</button>
            <p id="response"></p>
        </div>
    </div>
    </body>
    </html>

上诉代码基本与send.jsp相同，唯一不同的是连接的服务器端点为“/wsuser”，而请求路径为“/request/sendUser”（这样就对应了StompController的sendToUser方法）。这里发送的消息由用户名和消息组成，将在StompController的sendToUser方法里分割成接收方用户名和要发送的消息。

**9、订阅指定用户的消息（/WEB-INF/views/receiveUser.jsp）**

**10、点对点通讯结果截图与分析**

运行程序，访问[http://localhost:8080/stomp/sendUser][http_localhost_8080_stomp_sendUser]和[http://localhost:8080/stomp/receiveUser][http_localhost_8080_stomp_receiveUser]页面（发送页面使用user1登陆，接收页面打开两个，分别用user2和user3登陆）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 2][]

从浏览器的控制台中，我们可以看到STOMP的帧信息。

当我们发送数据给user3时，user1和user2将不能接收到消息，仅user3接收到消息。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 3][]

下面是user3登陆后的浏览器控制台输出：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 4][]

可以看到user3订阅了“/user/queue/customer”，这里的“/user”前缀是不能缺少的，它代表订阅指定用户的消息。

结果分析：

sendUser.jsp页面加载时通过connect()方法连接到服务端的“/wsuser”端点，然后发送数据时调用sendMsg()方法，并通过stomp客户端对象来将消息发送到服务器的“/request/sendUser”请求处。此时StompController类的sendToUser方法将接收到消息，通过principal.getName()来获取当前的用户名，并分割信息，最后将消息转发到"/queue/customer"订阅路径给desUser用户。而receiveUser.jsp页面也连接到了服务端的“/wsuser”端点并订阅了该路径，所以当接收到消息时，会调用函数将id为receive的元素（这里是span标签）的html设置为消息内容。

[WebSocket_Web QQ]: https://blog.csdn.net/qq_37771475/article/details/87775613
[http_localhost_8080_stomp_send]: http://localhost:8080/stomp/send
[http_localhost_8080_stomp_receive]: http://localhost:8080/stomp/receive
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70]: /images/20220317/81a764080a62494fa6f31ae100243fb6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 1]: /images/20220317/338051927974475aa66b92b2c616064e.png
[20190222114742654.png]: /images/20220317/b568f0299c8e4c99969dcc1f162d876b.png
[http_localhost_8080_stomp_sendUser]: http://localhost:8080/stomp/sendUser
[http_localhost_8080_stomp_receiveUser]: http://localhost:8080/stomp/receiveUser
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 2]: /images/20220317/b60bc616cd1143d1a10a4e36e62c1c21.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 3]: /images/20220317/9edd828eae924faea735e3992c1ea6f1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NzcxNDc1_size_16_color_FFFFFF_t_70 4]: /images/20220317/08dab81c887e4bdc88f7170494630aa9.png