SpringBoot 集成 WebSocket

最新推荐文章于 2024-08-22 16:17:31 发布

wangweijie_

最新推荐文章于 2024-08-22 16:17:31 发布

阅读量4.5k

点赞数 1

分类专栏： demo

本文链接：https://blog.csdn.net/refuse_wwj/article/details/117749781

版权

demo 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

SpringBoot 集成 WebSocket ；轻松实现消息推送

一、什么是websocket？

WebSocket 协议是基于 TCP 的一种新的网络协议。

它实现了客户端与服务器之间的全双工通信，学过计算机网络都知道，既然是全双工，就说明了服务器可以主动发送信息给客户端。

这与我们的推送技术或者是多人在线聊天的功能不谋而合。
socket通信模型
为什么不使用 HTTP 协议呢？

这是因为HTTP是单工通信，通信只能由客户端发起，客户端请求一下，服务器处理一下，这就太麻烦了。

于是 websocket 应运而生。
通信对比
下面我们就直接开始使用 Spring Boot 开始整合。以下案例都在我自己的电脑上测试成功，你可以根据自己的功能进行修改即可。
我的项目结构如下：

二、使用步骤

1.新建项目

新建springboot项目，勾选以下依赖
新建项目

2.启用Springboot对WebSocket的支持

启用 WebSocket 的支持也是很简单，几句代码搞定。

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

/**
 * 开启WebSocket支持
 *
 * @author WangWeiJie
 * @date 2021/6/9 16:02
 */
@Configuration
public class WebSocketConfig {

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

3.核心配置：WebSocketServer

因为 Web Socket 是类似客户端服务端的形式(采用 ws 协议)，那么这里的 WebSocketServer 其实就相当于一个 ws 协议的 Controller。

@ServerEndpoint 注解这是一个类层次的注解，它的功能主要是将目前的类定义成一个 websocket 服务器端。注解的值将被用于监听用户连接的终端访问 URL 地址，客户端可以通过这个 URL 来连接到 WebSocket 服务器端

再新建一个 ConcurrentHashMap webSocketMap 用于接收当前 userId 的 WebSocket，方便传递之间对 userId 进行推送消息。

下面是具体业务代码：

import lombok.extern.slf4j.Slf4j;
import org.jetbrains.annotations.NotNull;
import org.springframework.stereotype.Service;

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

/**
 * 核心配置
 *
 * @author WangWeiJie
 * @ ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
 * * 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
 * @date 2021/6/9 16:03
 */
@Slf4j
@Service
@ServerEndpoint("/websocket/{sid}")
public class WebSocketServer {

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

    /**
     * 存放每个客户端对应的 WebSocketServer 对象
     */
    private static CopyOnWriteArrayList<WebSocketServer> webSocketServers = new CopyOnWriteArrayList<>();

    private Session session;

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

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("sid") String sid) {
        this.session = session;
        // 加入集合中
        webSocketServers.add(this);
        this.sid = sid;
        // 在线人数+1
        int count = onlineCount.incrementAndGet();
        sendMessage("连接成功");
        log.info("有新的窗口开始监听：{}, 当前在线人数为：{}", sid, count);
    }

    /**
     * 收到客服端消息后调用的方法
     *
     * @param message 客服端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("收到来自窗口：{}, 消息内容：{}", sid, message);
        // 群发消息
        for (WebSocketServer webSocketServer : webSocketServers) {
            webSocketServer.sendMessage(message);
        }
    }

    /**
     * 发生错误时调用的方法
     */
    @OnError
    public void onError(Session session, @NotNull Throwable throwable) {
        log.error("发生错误");
        throwable.printStackTrace();
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        // 从集合中移除
        webSocketServers.remove(this);
        // 在线人数-1
        int count = onlineCount.decrementAndGet();
        log.info("释放的sid为：{}", sid);
        log.info("有一连接关闭！当前在线人数为：{}", count);
    }

    /**
     * 实现服务器主动推送消息
     *
     * @param message 消息内容
     */
    public void sendMessage(String message) {
        try {
            this.session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            log.error("websocket IO Exception");
            e.printStackTrace();
        }
    }

    /**
     * 发送消息到指定窗口 null则群发
     */
    public static void sendInfo(String message, @PathParam("sid") String sid) {
        log.info("推送消息到窗口:{}, 推送内容:{}", sid, message);
        if (sid == null) {
            for (WebSocketServer webSocketServer : webSocketServers) {
                webSocketServer.sendMessage(message);
            }
            return;
        }
        for (WebSocketServer webSocketServer : webSocketServers) {
            if (webSocketServer.sid.equals(sid)) {
                webSocketServer.sendMessage(message);
            }
        }
    }

    public static CopyOnWriteArrayList<WebSocketServer> getWebSocketServers() {
        return webSocketServers;
    }
}

4.编写测试controller

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

import java.util.HashMap;
import java.util.Map;

/**
 * 测试Controller
 *
 * @author WangWeiJie
 * @date 2021/6/9 16:36
 */
@Controller()
@RequestMapping("websocket-system")
public class SystemController {

    /**
     * 页面请求
     */
    @GetMapping("/index/{userId}")
    public ModelAndView socket(@PathVariable String userId) {
        ModelAndView mav = new ModelAndView("/socket1");
        mav.addObject("userId", userId);
        return mav;
    }

    @ResponseBody
    @RequestMapping("/push/{sid}")
    public Map<String, Object> pushToWeb(@PathVariable String sid, String message) {
        HashMap<String, Object> result = new HashMap<>();
        WebSocketServer.sendInfo(message, sid);
        result.put("code", sid);
        result.put("msg", message);
        return result;
    }
}

5.测试页面 index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WebSocket - demo</title>
</head>
<body>
<div id="main" style="width: 1200px;height:500px;"></div>
Welcome<br/><input id="text" type="text"/>
<button onclick="send()">发送消息</button>
<hr/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<hr/>
<div id="message"></div>
</body>
<script type="text/javascript">
    var websocket = null;
    //判断当前浏览器是否支持WebSocket
    if ('WebSocket' in window) {
        websocket = new WebSocket("ws://127.0.0.1:8083/websocket/100")
    } else {
        alert('当前浏览器 Not support websocket')
    }

    //连接发生错误回调方法
    websocket.onerror = function () {
        setMessageInnerHTML("WebSocket连接发生错误")
    }

    //连接成功建立回调方法
    websocket.onopen = function () {
        setMessageInnerHTML("WebSocket连接成功")
    }
    var U01data, Uidata, Usdata
    //接收消息回调方法
    websocket.onmessage = function (event) {
        console.log(event)
        setMessageInnerHTML('接收消息：' + event.data)
        setechart()
    }

    //连接关闭回调方法
    websocket.onclose = function () {
        setMessageInnerHTML("WebSocket连接关闭")
    }

    //监听窗口关闭事件
    window.onbeforeunload = function () {
        closeWebSocket()
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>'
    }

    //关闭WebSocket连接
    function closeWebSocket() {
        websocket.close()
    }

    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send('{"msg":"' + message + '"}')
        setMessageInnerHTML(message + "&#13;")
    }
</script>

</html>