spring boot整合websocket

最新推荐文章于 2023-08-22 10:51:09 发布

你的微笑，乱了夏天

最新推荐文章于 2023-08-22 10:51:09 发布

阅读量99

点赞数 1

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

本文链接：https://blog.csdn.net/weixin_42037525/article/details/111693147

版权

Java 同时被 2 个专栏收录

10 篇文章 0 订阅

订阅专栏

spring boot

8 篇文章 0 订阅

订阅专栏

需求：后台对订单操作之后，客户端(客户)需要收到实时消息提示

对于这个需求我选择的是方案是：websocket（长连接）

第一步:添加依赖

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

第二步：创建WebSocket配置类，WebSocketStompConfig.java

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

/**
 * WebSocket配置
 */

@Configuration
public class WebSocketStompConfig {
    //这个bean的注册,用于扫描带有@ServerEndpoint的注解成为websocket  ,如果你使用外置的tomcat就不需要该配置文件
    @Bean
    public ServerEndpointExporter serverEndpointExporter()
    {
        return new ServerEndpointExporter();
    }
}

第三步：创建WebSocket 服务端 API，WebSocket.java

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;

import com.alibaba.fastjson.JSON;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.util.concurrent.CopyOnWriteArraySet;

/**
 * @Author：cll
 * @Description：
 * @Date： created in 15:56 2020/12/24
 */

@Component
@ServerEndpoint(value = "/connectWebSocket/{authToken}")
public class WebSocket {

    private static Logger logger = LoggerFactory.getLogger(WebSocket.class);
    private static CopyOnWriteArraySet<WebSocket> clients = new CopyOnWriteArraySet<WebSocket>();
    /**
     * 在线人数
     */
    public static int onlineNumber = 0;
    /**
     * 会话
     */
    private Session session;
    /**
     * 用户token
     */
    private String authToken;
    /**
     * 建立连接
     *
     */
    @OnOpen
    public void onOpen(@PathParam("authToken") String authToken,Session session)
    {
        onlineNumber++;
        //把自己的信息加入到map当中去
        this.session = session;
        this.authToken = authToken;
        WebSocket webSocket = this;
        logger.info("连接人数："+onlineNumber);
        clients.add(webSocket);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        logger.info("服务端发生了错误"+error.getMessage());
    }
    /**
     * 连接关闭
     */
    @OnClose
    public void onClose() {
        onlineNumber--;
        logger.info("连接人数："+onlineNumber);
        clients.remove(this);
    }

    public void sendMessageTo(Object object, String authToken){
        for (WebSocket webSocket:clients){
            if (webSocket.authToken.equals(authToken)) {
                webSocket.session.getAsyncRemote().sendText(JSON.toJSONString(object));
            }
        }
    }

    /**
     * 收到客户端的消息
     *
     * @param message 消息
     * @param session 会话
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        logger.info("来自客户端消息：" + message+"客户端的id是："+session.getId());
    }
}

第四步：创建一个index.html文件，并将文件放到resources下面的static目录下

<!DOCTYPE HTML>
<html>
<head>
    <title>Test My WebSocket</title>
</head>


<body>
TestWebSocket
<input  id="text" type="text" />
<button onclick="send()">SEND MESSAGE</button>
<button onclick="closeWebSocket()">CLOSE</button>
<div id="message"></div>
</body>

<script type="text/javascript">
    var websocket = null;


    //判断当前浏览器是否支持WebSocket
    if('WebSocket' in window){
        //连接WebSocket节点
        websocket = new WebSocket("ws://localhost:8433/connectWebSocket/eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiIxODUyMDcxODUyNiJ9.2O9ipt0SEUdbHFfh5YKuTzRS0c79dKKSnPQuZZCGbnSDU6_AmQG24bptEP3TWl6MQr1rRn00GidFFukgRCNMsA");
    }
    else{
        alert('Not support websocket')
    }


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


    //连接成功建立的回调方法
    websocket.onopen = function(event){
        setMessageInnerHTML("open");
    }


    //接收到消息的回调方法
    websocket.onmessage = function(event){
        setMessageInnerHTML(event.data);
    }


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


    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function(){
        websocket.close();
    }


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


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


    //发送消息
    function send(){
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

第五步：客户端向服务端发送消息，验证服务是否能收到消息

第六步：在需要的使用websocket的地方调用sendMessageTo(Object object, String authToken)方法

第七步：测试服务端是否能向客户端发送消息

你的微笑，乱了夏天

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
spring boot整合websocket

需求：后台对订单操作之后，客户端(客户)需要收到实时消息提示对于这个需求我选择的是方案是：websocket（长连接）第一步:添加依赖<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId></dependency>第二步：创建Web
复制链接

扫一扫

专栏目录