WebSocket的故事（六）—— Springboot中，实现更灵活的WebSocket

雨点打透心脏的1/2处 2021-09-24 08:36 487阅读 0赞

# 前言 #

最近，偶然在掘金上发现了一个大牛写的这篇文章，感觉作者写的非常好，防止以后找不到了，这里转载记录一下，方便以后使用。

## 概述 ##

WebSocket的故事系列计划分五大篇六章，旨在由浅入深的介绍WebSocket以及在Springboot中如何快速构建和使用WebSocket提供的能力。本系列计划包含如下几篇文章：

[第一篇，什么是WebSocket以及它的用途。][WebSocket]  
[第二篇，Spring中如何利用STOMP快速构建WebSocket广播式消息模式][Spring_STOMP_WebSocket]  
[第三篇，Springboot中，如何利用WebSocket和STOMP快速构建点对点的消息模式(1)][Springboot_WebSocket_STOMP_1]  
[第四篇，Springboot中，如何利用WebSocket和STOMP快速构建点对点的消息模式(2)][Springboot_WebSocket_STOMP_2]  
[第五篇，Springboot中，实现网页聊天室之自定义WebSocket消息代理][Springboot_WebSocket]  
**第六篇，Springboot中，实现更灵活的WebSocket**

## 本篇的主线 ##

本篇是这个系列的最后一篇，将介绍另一种实现WebSocket的方式。仍然会以一个简单聊天室为例子进行讲述。至此我们也可以根据具体情况，选择不同的实现方式。

## 本篇适合的读者 ##

想了解如何在Springboot上自定义实现更为复杂的WebSocket产品逻辑的各路有志青年。

## 使用Tomcat提供的WebSocket支持 ##

早在`Java EE 7`时，就发布了`JSR356`规范。Tomcat7.0.47开始，也支持了统一的`WebSocket`接口。在使用`Springboot`时，也可以轻松的使用`Tomcat`提供的这些API。今天我们就来体验一把`Tomcat`实现的`WebSocket`。

### 1. 引入依赖 ###

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

Springboot内置了tomcat，我们直接引入spring的这个高级组件即可。顺便多说一句，Springboot的高级组件会自动引用基础的组件，像`spring-boot-starter-websocket`就引入了`spring-boot-starter-web`和`spring-boot-starter`，所以不要重复引入。

### 2. 使用@ServerEndpoint创建WebSocket Endpoint ###

首先要注入`ServerEndpointExporter`，这个Bean会自动注册使用了`@ServerEndpoint`注解声明的WebSocket Endpoint。

package com.draw.wsdraw.websocket;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.socket.server.standard.ServerEndpointExporter;
    
    @Configuration
    public class WebSocketConfig {
        @Bean
        public ServerEndpointExporter serverEndpointExporter() {
            return new ServerEndpointExporter();
        }
    }

然后，我们动手实现WebSocket服务的实现类，这里是`WebSocketServer`，注意别忘了用`@ServerEndpint`和`@Component`声明下。虽然`@Component`默认是单例模式的，但Springboot还是会为每个WebSocket连接初始化一个`Bean`，所以可以用一个静态Map保存起来。换句话说，每当有一个用户向服务器发起连接时，都会创建一个`WebSocketServer`对象，将此对象按`roomId`保存在`HashMap`中，方便后续使用。

创建ServerEndpoint时，需要对应实现其所需的几个功能性方法：`OnOpen、OnMessage、OnClose、OnError`。

*  `@OnOpen`：客户端向服务端发起建立连接时，服务端调用,可传入的参数为Session(WebSocket的Session)和EndpointConfig。另外，还可以加入带@PathParam注解的参数。这里我们注解的参数是roomId，即在建立连接时，携带的请求地址上的参数，与我们上一篇中介绍的\{INFO\}是一样的作用。
 *  `@OnMessage`：客户端消息到来时调用，包含会话Session，根据消息的形式，如果是文本消息，传入String类型参数或者Reader，如果是二进制消息，传入byte\[\]类型参数或者InputStream。
 *  `@OnClose`：当断开连接，关闭WebSocket时调用。
 *  `@OnError`：当发生错误时调用，传入异常Session和错误信息。

重写上述方法，即可实现WebSocket的服务端业务逻辑。

@ServerEndpoint("/webSocket/{roomId}")
    @Component
    public class WebSocketServer {
        private static ConcurrentHashMap<String, List<WebSocketServer>> webSocketMap =
                new ConcurrentHashMap<>(3);
    
        //与某个客户端的连接会话，需要通过它来给客户端发送数据
        private Session session;
    
        //接收roomId
        private String roomId = "";
    
        /**
         * 连接建立成功调用的方法
         */
        @OnOpen
        public void onOpen(Session session, EndpointConfig config, @PathParam("roomId") String roomId) {
            if (roomId == null || roomId.isEmpty()) return;
            this.session = session;
            this.roomId = roomId;
            addSocketServer2Map(this);
            try {
                sendMessage("连接成功", true);
            } catch (IOException e) {
            }
        }
    
        /**
         * 连接关闭调用的方法
         */
        @OnClose
        public void onClose() {
            List<WebSocketServer> wssList = webSocketMap.get(roomId);
            if (wssList != null) {
                for (WebSocketServer item : wssList) {
                    if (item.session.getId().equals(session.getId())) {
                        wssList.remove(item);
                        if (wssList.isEmpty()) {
                            webSocketMap.remove(roomId);
                        }
                        break;
                    }
                }
            }
        }
        
        /**
         * 收到客户端消息后调用的方法
         */
        @OnMessage
        public void onMessage(String message, Session session) {
            //群发消息
            String msg = filterMessage(message);
            if (msg != null) {
                sendInfo(msg, roomId, session);
            }
        }
    
        /**
         * 发生错误时，调用的方法
         */
        @OnError
        public void onError(Session session, Throwable error) {
        }

这样，服务端的代码就实现完了，这里仅贴出来部分源码，文后会给出项目源码地址。

### 3. 实现客户端页面 ###

客户端页面实现了简单的连接、断开和消息发送功能。这部分就不详细介绍了。

### 4. 演示截图 ###

![format_png][]

## 源码地址 ##

本篇的源码地址：

[另一种WebSocket的实现方式][WebSocket 1]

## 总结 ##

本篇直接使用了Tomcat提供的WebSocket，也是一种相对灵活的实现方式，只需要按照上述步骤来实现即可。集中精力编写业务逻辑代码。

整个一个系列下来，我们介绍了几种实现WebSocket的方式，有的集成度高，有些相对灵活。大家可以按实际业务需求来选取合适的方式。至此，这个系列就结束了。感谢大家阅读。

作者：xNPE  
链接：[https://juejin.im/post/5baf20525188255c425837ad][https_juejin.im_post_5baf20525188255c425837ad]  
来源：掘金  
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

写博客是为了记住自己容易忘记的东西，另外也是对自己工作的总结，希望尽自己的努力，做到更好，大家一起努力进步！  
  
如果有什么问题，欢迎大家评论，一起探讨，代码如有问题，欢迎各位大神指正！  
  
给自己的梦想添加一双翅膀，让它可以在天空中自由自在的飞翔！

[WebSocket]: https://blog.csdn.net/smilehappiness/article/details/106470136
[Spring_STOMP_WebSocket]: https://blog.csdn.net/smilehappiness/article/details/106470154
[Springboot_WebSocket_STOMP_1]: https://blog.csdn.net/smilehappiness/article/details/106470179
[Springboot_WebSocket_STOMP_2]: https://blog.csdn.net/smilehappiness/article/details/106470202
[Springboot_WebSocket]: https://blog.csdn.net/smilehappiness/article/details/106470221
[format_png]: /images/20210923/5fa5faa99727497da99d4cbb32c8ad65.png
[WebSocket 1]: https://github.com/chiuser/TomcatWebSocket
[https_juejin.im_post_5baf20525188255c425837ad]: https://juejin.im/post/5baf20525188255c425837ad