SpringBoot集成WebSocket实现消息实时推送（提供Gitee源码）

前言：在最近的工作当中，客户反应需要实时接收消息提醒，这个功能虽然不大，但不过也用到了一些新的技术，于是我这边写一个关于我如何实现这个功能、编写、测试到部署服务器，归纳到这篇博客中进行总结。

目录

一、什么是WebSocket

二、后端实现

1、引入pom.xml依赖

2、注册WebSocket核心配置类

3、编写WebSocket服务器核心代码

三、前端实现

四、本地测试

五、打包前后端

六、部署到服务器测试

七、Gitee源码

---

一、什么是WebSocket

WebSocket是一种建立在TCP连接上的全双工通信协议，让客户端和服务端之间可以做到实时通信，允许服务端和客户端互相推送数据，服务端和客户端只要建立一次握手，两者之间便可以创建持久连接实现数据的双向传输。

二、后端实现

1、引入pom.xml依赖

        
        
            org.springframework.boot
            spring-boot-starter-websocket
        

        
        
            org.apache.commons
            commons-lang3
        

        
        
            org.projectlombok
            lombok
            1.18.26
        

2、注册WebSocket核心配置类

package com.example.websocket.config;

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();
    }
}

3、编写WebSocket服务器核心代码

package com.ithuang.websocket.config;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
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;


@ServerEndpoint("/websocket/{userId}")
@Component
@Slf4j
public class WebSocketServer {

    /**静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。*/
    private static int onlineCount = 0;
    /**concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。*/
    private static ConcurrentHashMap 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);
            //加入set中
        }else{
            webSocketMap.put(userId,this);
            //加入set中
            addOnlineCount();
            //在线数加1
        }

        log.info("用户连接:"+userId+",当前在线人数为:" + getOnlineCount());

        try {
            sendMessage("连接成功");
        } catch (IOException e) {
            log.error("用户:"+userId+",网络异常!!!!!!");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {

        if(webSocketMap.containsKey(userId)){
            webSocketMap.remove(userId);
            //从set中删除
            subOnlineCount();
        }
        log.info("用户退出:"+userId+",当前在线人数为:" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息*/
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("用户消息:"+userId+",报文:"+message);
        //可以群发消息
        //消息保存到数据库、redis
//        if(StringUtils.isNotBlank(message)){
//            try {
//                //解析发送的报文
//                JSONObject jsonObject = JSON.parseObject(message);
//
//            }catch (Exception e){
//                e.printStackTrace();
//            }
//        }
    }

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

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


    /**
     * 实现服务器主动推送
     */
    public void sendAllMessage(String message) throws IOException {
        ConcurrentHashMap.KeySetView userIds = webSocketMap.keySet();
        for (String userId : userIds) {
            WebSocketServer webSocketServer = webSocketMap.get(userId);
            webSocketServer.session.getBasicRemote().sendText(message);
        }
    }

    /**
     * 发送自定义消息
     * */
    public static void sendInfo(String message,@PathParam("userId") String userId) throws IOException {
        log.info("发送消息到:"+userId+"，报文:"+message);
        if(StringUtils.isNotBlank(userId)&&webSocketMap.containsKey(userId)){
            webSocketMap.get(userId).sendMessage(message);
        }else{
            log.error("用户"+userId+",不在线！");
        }
    }

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

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

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

4、撰写定时任务

注：主启动类需要加上@EnableScheduling，否则不生效。

package com.ithuang.websocket.task;

import com.ithuang.websocket.config.WebSocketServer;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import java.io.IOException;
import java.util.Date;

@Component
public class Send {

    @Resource
    private WebSocketServer webSocketServer;

    @Scheduled(fixedDelay = 2000)
    public void sendMsg() throws IOException {
        webSocketServer.sendAllMessage("hello"+new Date());
    }
}

三、前端实现

需要先自行安装好element-ui组件库，这边不做演示，直接贴出代码

四、本地测试

点击连接

当点击断开或者关闭浏览器，后台输出如下

五、打包前后端

具体的打包方式这边不再做阐述，在后端打包可能会出现如下异常：

解决如下：

在单元测试类上面加上此注解：

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)

六、部署到服务器测试

具体的部署流程这边不再贴出，把默认的127.0.0.1替换成自己的服务器IP，点击连接即可，后端就会每2秒推送一次消息了，看代码结果。

部署的前端端口默认是80，后端端口是9090，记得放行端口。

后台日志如下： 

七、Gitee源码

前端代码：vue-websocket: vue实现websocket连接的前端代码

后端代码：springboot-websocket: springboot后端实现websocket连接源码