SpringBoot+WebSocket开发部署实现消息的推送

最新推荐文章于 2025-01-07 17:04:26 发布

HezalCVP

最新推荐文章于 2025-01-07 17:04:26 发布

阅读量374

点赞数

分类专栏： WebSocket 文章标签： java 小程序 websocket

本文链接：https://blog.youkuaiyun.com/Eric_pineapple/article/details/106059824

版权

WebSocket 专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何使用Spring Boot和WebSocket实现实时消息推送，具体展示了一个订单状态更新通知前端用户的完整示例，包括引入依赖、配置类编写、服务端与控制器的实现，以及前端页面和Nginx配置。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

需求

订单状态更改推送给前端，显示给用户

服务端

引入依赖（Springboot1.5.9）

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

编写配置类以及服务端

@Configuration
public class WebSocketConfig {

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

@Component
@ServerEndpoint("/ws/{sid}")
@Slf4j
public class WebSocketWXConfig {
    /**
     * 静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
     */
    private static int onlineCount = 0;
    /**
     * concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
     */
    private static CopyOnWriteArraySet<WebSocketWXConfig> webSocketSet = new CopyOnWriteArraySet<>();
    /**
     * 与某个客户端的连接会话，需要通过它来给客户端发送数据
     */
    private Session session;
    /**
     * 接收sid
     */
    private String sid="";
    /**
     * 连接建立成功调用的方法
     **/
    @OnOpen
    public void onOpen(Session session,@PathParam("sid") String sid) {
        this.session = session;
        //加入set中
        webSocketSet.add(this);
        //在线数加1
        addOnlineCount();
        log.info("有新窗口开始监听:"+sid+",当前在线人数为" + getOnlineCount());
        this.sid=sid;
        try {
            sendMessage("连接成功");
        } catch (IOException e) {
            log.error("websocket IO异常");
        }
    }
    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        //从set中删除
        webSocketSet.remove(this);
        //在线数减1
        subOnlineCount();
        log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
    }
    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     **/
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("收到来自窗口"+sid+"的信息:"+message);
        //群发消息
        for (WebSocketWXConfig item : webSocketSet) {
            try {
                item.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    /**
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误");
        error.printStackTrace();
    }
    /**
     * 实现服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }
    /**
     * 群发自定义消息
     * */
    public static void sendInfo(String message,@PathParam("sid") String sid) throws IOException {
        log.info("推送消息到窗口"+sid+"，推送内容:"+message);
        for (WebSocketWXConfig item : webSocketSet) {
            try {
                //这里可以设定只推送给这个sid的，为null则全部推送
                if(sid==null) {
                    item.sendMessage(message);
                }else if(item.sid.equals(sid)){
                    item.sendMessage(message);
                }
            } catch (IOException e) {
                continue;
            }
        }
    }
    public static synchronized int getOnlineCount() {
        return onlineCount;
    }
    public static synchronized void addOnlineCount() {
        WebSocketWXConfig.onlineCount++;
    }
    public static synchronized void subOnlineCount() {
        WebSocketWXConfig.onlineCount--;
    }
}

编写Controller 推送服务
@Controller
@RequestMapping("/wx")
@Slf4j
public class WxWebSocketController {

@Resource
WebSocketWXConfig webSocketWXConfig;

@GetMapping("/push/{cid}")
public String pushToWeb(@PathVariable(“cid”) String cid,@RequestBody PageData pd){
webSocketWXConfig.sendInfo(pd.toString(),cid);
}
页面编写

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>WebsocketTestIndex</title>
</head>
<body>

<h1>Websocket Test</h1>
<script>
    var socket;
    if(typeof(WebSocket) == "undefined") {
        console.log("Your browser not support WebSocket !");
    }else{
        console.log("Your browser support WebSocket");
        // 实例化WebSocket对象
        // 指定要连接的服务器地址与端口
        // 建立连接
        socket = new WebSocket("ws://localhost:8990/ws/webSocket/20");
        // 打开事件
        socket.onopen = function() {
            console.log("You has connect to WebSocketServer");
        };
        // 获得消息事件
        socket.onmessage = function(msg) {
            // 打印接收到的消息
            console.log(msg.data);
        };
        // 关闭事件
        socket.onclose = function() {
            console.log("Socket has closed");
        };
        // 发生了错误事件
        socket.onerror = function() {
            alert("Socket happen an error !");
        }
    }
</script>
</body>
</html>

以上是本地测试线上与微信小程序需配置nginx

server
{
listen 80;
listen 443 ssl;
server_name ligoudan.com;

ssl on;
ssl_certificate   证书.pen;
ssl_certificate_key   证书.key;

ssl_session_timeout 5m;
ssl_session_cache shared:SSL:50m;
ssl_protocols SSLv3 SSLv2 TLSv1 TLSv1.1 TLSv1.2; #按照这个协议配置
ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!NULL:!aNULL:!MD5:!ADH:!RC4;
ssl_prefer_server_ciphers on;

location /ws  {   
 proxy_pass http://127.0.0.1:8990/;        #通过配置端口指向部署websocker的项目
 proxy_http_version 1.1;
 proxy_set_header Upgrade $http_upgrade;
 proxy_set_header Connection "upgrade";
proxy_read_timeout 600s; #默认60s
 }

}
6. 测试
本地
打开socket.html页面看console显示连接成功
请求localhost:8990/wx/push/{cid}推送消息
线上
wss://ligoudan.com:8080/ws/{sid}