SpringBoot 集成 WebSocket模仿社交聊天

最新推荐文章于 2022-07-26 17:37:42 发布

Hello,Anton

最新推荐文章于 2022-07-26 17:37:42 发布

阅读量152

点赞数

分类专栏： SpringBoot 文章标签： websocket spring boot java

本文链接：https://blog.csdn.net/weixin_43242089/article/details/124918852

版权

SpringBoot 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本章讲解使用 SpringBoot 集成WebSocket实现服务端推送消息到客户端

Github相关代码链接

1、简介

假设有这样一个场景：服务端的资源经常在更新，客户端需要尽量及时地了解到这些更新发生后展示给用户，如果是 HTTP 1.1，通常会开启 ajax 请求询问服务端是否有更新，通过定时器反复轮询服务端响应的资源是否有更新。
在这里插入图片描述

在长时间不更新的情况下，反复地去询问会对服务器造成很大的压力，对网络也有很大的消耗，如果定时的时间比较大，服务端有更新的话，客户端可能需要等待定时器达到以后才能获知，这个信息也不能很及时地获取到。

而有了 WebSocket 协议，就能很好地解决这些问题，WebSocket 可以反向通知的，通常向服务端订阅一类消息，服务端发现这类消息有更新就会不停地通知客户端。
在这里插入图片描述

WebSocket简介

WebSocket 协议是基于 TCP 的一种新的网络协议，它实现了浏览器与服务器全双工（full-duplex）通信—允许服务器主动发送信息给客户端，这样就可以实现从客户端发送消息到服务器，而服务器又可以转发消息到客户端，这样就能够实现客户端之间的交互。对于 WebSocket 的开发，Spring 也提供了良好的支持，目前很多浏览器已经实现了 WebSocket 协议，但是依旧存在着很多浏览器没有实现该协议，为了兼容那些没有实现该协议的浏览器，往往还需要通过 STOMP 协议来完成这些兼容。

下面我们在 Spring Boot 中集成 WebSocket 来实现服务端推送消息到客户端。

2、SpringBoot 集成 WebSocket

创建一个SpringBoot项目，需要Web场景；

2.1、引入依赖

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

2.2、开启Websocket服务

新增一个配置类， @EnableWebsocket开启websocket服务。
内部实例化 ServerEndpointExporter类，该 Bean 会自动注册
@ServerEndpoint 注解声明的端点，代码如下：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * @author ： IT丶Anton
 * @date ： 2022/5/22 22:41
 **/
@EnableWebSocket
@Configuration
public class WebSocketConfiguration {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

2.3、编写端点服务类

接下来使用 @ServerEndpoint 定义一个端点服务类，在端点服务类中，可以定义 WebSocket 的打开、关闭、错误和发送消息的方法，具体代码如下所示：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * @author ： IT丶Anton
 * @date ： 2022/5/22 22:44
 **/
@ServerEndpoint("/websocket/{userId}")
@Component
public class WebSocketServer {

    private static final Logger log = LoggerFactory.getLogger(WebSocketServer.class);

    /**
     * 当前在线连接数
     */
    private static AtomicInteger onlineCount = new AtomicInteger(0);

    /**
     * 用来存放每个客户端对应的 WebSocketServer 对象
     */
    private static ConcurrentHashMap<String, WebSocketServer> webSocketMap = new ConcurrentHashMap<>();

    /**
     * 与某个客户端的连接会话，需要通过它来给客户端发送数据
     */
    private Session session;

    /**
     * 接收 userId
     */
    private String userId = "";

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("userId") String userId) {
        this.session = session;
        this.userId = userId;
        if (webSocketMap.containsKey(userId)) {
            webSocketMap.remove(userId);
            webSocketMap.put(userId, this);
        } else {
            webSocketMap.put(userId, this);
            addOnlineCount();
        }
        log.info("用户连接:" + userId + ",当前在线人数为:" + getOnlineCount());
        try {
            sendMessage("连接成功！");
        } catch (IOException e) {
            log.error("用户:" + userId + ",网络异常!!!!!!");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        if (webSocketMap.containsKey(userId)) {
            webSocketMap.remove(userId);
            subOnlineCount();
        }
        log.info("用户退出:" + userId + ",当前在线人数为:" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("用户消息:" + userId + ",报文:" + message);
        if (message != null) {
            try {
                for (String userId : webSocketMap.keySet()) {
                    if (!userId.equals(session.getId())) {
                        webSocketMap.get(userId).sendMessage(message);
                    }
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 发生错误时调用
     *
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("用户错误:" + this.userId + ",原因:" + error.getMessage());
        error.printStackTrace();
    }

    /**
     * 实现服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

    public static synchronized AtomicInteger getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount.getAndIncrement();
    }

    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount.getAndDecrement();
    }
}

其中，@ServerEndpoint("/websocket/{userId}")表示让 Spring 创建 WebSocket 的服务端点，其中请求地址是 /websocket/{userId}。
另外 WebSocket 一共有四个事件，分别对应 JSR-356 定义的 @OnOpen、@OnMessage、@OnClose、@OnError 注解。
● @OnOpen：标注客户端打开 WebSocket 服务端点调用方法
● @OnClose：标注客户端关闭 WebSocket 服务端点调用方法
● @OnMessage：标注客户端发送消息，WebSocket 服务端点调用方法
● @OnError：标注客户端请求 WebSocket 服务端点发生异常调用方法

3、测试
使用 WebSocket 在线测试工具（http://www.easyswoole.com/wstool.html）进行测试，有能力的也可以自己写个 html 测试。

打开网页后，在服务地址中输入ws://127.0.0.1:8080/websocket/anton，点击开启连接按钮，消息记录中会多一条由服务器端发送的连接成功！。

接下来再打开一个网页，服务地址中输入ws://localhost:8080/websocket/test，点击开启连接按钮，然后回到第一次打开的网页在消息框中输入想要发送的信息，点击发送到服务端。

服务端与第二个网页中会收到第一个客户端发送过来的消息。