SpringBoot2整合WebSocket，实现后台向前端推送信息

野性酷女 2023-10-12 09:45 3阅读 0赞

> 背景是客户提出需要在 IOC 智能运营中心使用 Pad 控制页面进行跳转，类似于电视的遥控器一样。这样IOC的讲解员可以在 Pad 上面操作控制页面进行展示。我们的解决方案是通过使用 WebSocket 实现，前台监听，后台开放 API 给 Pad 上的页面，后台收到消息后推送给前台，前台再做出对应的反应。这样基本可以满足要求了~

## 什么是 WebSocket? ##

WebSocket 协议是基于 TCP 的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。

**WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据，在 WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。**

## 为什么需要 WebSocket？ ##

> 初次接触 WebSocket 的人，都会问同样的问题：我们已经有了 HTTP 协议，为什么还需要另一个协议？它能带来什么好处？

答案很简单，因为 HTTP 协议有一个缺陷：**通信只能由客户端发起，HTTP 协议做不到服务器主动向客户端推送信息。**

> 举例来说，我们想要查询当前的排队情况，只能是页面轮询向服务器发出请求，服务器返回查询结果。轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）。因此 WebSocket 就是这样发明的。如我们出去吃饭，在公众号上排队，不需要我们自己查询，当有变动时公众号实时将消息推送给我们，我们就可以知道排队的状态了，不必每次询问服务员。

## WebSocket ws 和 wss 的区别 ##

WS 协议和 WSS 协议两个均是 WebSocket 协议的 SCHEM，两者一个是非安全的，一个是安全的。也是统一的资源标志符。就好比 HTTP 协议和 HTTPS 协议的差别。非安全的没有证书，安全的需要 SSL 证书。

> 其中 WSS 表示在 TLS 之上的 WebSocket。WS 一般默认是 80 端口，而 WSS 默认是 443 端口，大多数网站用的就是 80 和 433 端口。

http 和 ws 的对应关系：

http -> new WebSocket('ws://xxx')
    
    https -> new WebSocket('wss://xxx')

## SpringBoot2整合WebSocket ##

### 添加 maven 依赖 ###

在 `pom.xml` 添加如下依赖

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-websocket</artifactId>
            </dependency>

### 新建 WebSocket 的配置类 ###

配置类会检测带有注解 `@ServerEndpoint` 的 bean 并注册它们。

> 记得加上 `@Configuration` 注解

import lombok.extern.slf4j.Slf4j;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    
    
    @Configuration
    @Slf4j
    public class WebSocketConfig {
       
        
    
        /**
         * 给spring容器注入这个ServerEndpointExporter对象
         * 相当于xml：
         * <beans>
         * <bean/>
         * </beans>
         * <p>
         * 检测所有带有@serverEndpoint注解的bean并注册他们。
         *
         * @return ServerEndpointExporter对象
         */
        @Bean
        public ServerEndpointExporter serverEndpointExporter() {
       
        
            log.info("WebSocketConfig 注入！");
            return new ServerEndpointExporter();
        }
    }

### 新建 WebSocketServer 的处理类 ###

import lombok.extern.slf4j.Slf4j;
    import org.springframework.stereotype.Component;
    
    import javax.websocket.OnClose;
    import javax.websocket.OnError;
    import javax.websocket.OnMessage;
    import javax.websocket.OnOpen;
    import javax.websocket.Session;
    import javax.websocket.server.PathParam;
    import javax.websocket.server.ServerEndpoint;
    import java.io.IOException;
    import java.util.Map;
    import java.util.concurrent.ConcurrentHashMap;
    import java.util.concurrent.atomic.AtomicInteger;
    
    @ServerEndpoint("/webSocket/{username}")
    @Component
    @Slf4j
    public class WebSocketServer {
       
        
    
        private static final AtomicInteger ONLINE_COUNT = new AtomicInteger(0);
        private static Map<String, WebSocketServer> clients = new ConcurrentHashMap<>();
        private Session session;
        private String username;
    
        @OnOpen
        public void onOpen(@PathParam("username") String username, Session session) throws IOException {
       
        
            this.username = username;
            this.session = session;
    
            clients