socket消息推送，注解开发

古城微笑少年丶 2022-04-23 10:56 231阅读 0赞

注意点一：项目必须在tomcat8及其以上运行

注意点二：在本地运行需要添加下面这个类

@Configuration
    public class WebSocketConfig {
    
        /**
         * 用于扫描和注册所有携带ServerEndPoint注解的实例。
         * <p>
         * PS:若部署到外部容器 则无需提供此类。
         */
        @Bean
        public ServerEndpointExporter serverEndpointExporter() {
    
            return new ServerEndpointExporter();
        }
    }

好了，现在说流程：

参考地址：[https://www.jianshu.com/p/55cfc9fcb69e][https_www.jianshu.com_p_55cfc9fcb69e]

第一步，引入jar包

<dependency>  
    <groupId>javax.websocket</groupId>  
    <artifactId>javax.websocket-api</artifactId>  
    <version>1.0</version>  
    </dependency>

我使用的是springboot，直接创建项目骨架的时候勾选

第二步，加入长连接配置类

package im.qingtui.demo.controller;
    
    import java.io.IOException;
    import java.util.concurrent.ConcurrentHashMap;
    import java.util.concurrent.CopyOnWriteArraySet;
    import javax.websocket.OnClose;
    import javax.websocket.OnError;
    import javax.websocket.OnMessage;
    import javax.websocket.OnOpen;
    import javax.websocket.Session;
    import javax.websocket.server.ServerEndpoint;
    import org.springframework.stereotype.Component;
    
    /**
     * @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
     * 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
     * @author
     */
    @Component
    @ServerEndpoint(value="/websocket")
    public class WebSocketTest {
    
    
        //用来存放每个客户端对应的WebSocketTest对象，适用于同时与多个客户端通信
        public static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();
        //若要实现服务端与指定客户端通信的话，可以使用Map来存放，其中Key可以为用户标识
        public static ConcurrentHashMap<Session,Object> webSocketMap = new ConcurrentHashMap<Session,Object>();
    
        //与某个客户端的连接会话，通过它实现定向推送(只推送给某个用户)
        private Session session;
    
    
    
        /**
         * 连接建立成功调用的方法
         *
         * @param session 可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
         */
        @OnOpen
        public void onOpen(Session session){
            this.session = session;
            System.out.println("加入长连接成功");
            webSocketSet.add(this);     //加入set中
            webSocketMap.put(session,this); //加入map中
        }
    
        /**
         * 连接关闭调用的方法
         */
        @OnClose
        public void onClose(Session closeSession) {
            webSocketSet.remove(this); //从set中删除
            webSocketMap.remove(closeSession); //从map中删除
        }
    
        /**
         * 收到客户端消息后调用的方法
         *
         * @param message 客户端发送过来的消息
         * @param mySession 可选的参数
         * @throws Exception
         */
        @OnMessage
        public void onMessage(String message,Session mySession) throws Exception {
    
            //--------------群发消息(多用于聊天室场景)
            for (WebSocketTest item : webSocketSet) {
                try {
                    item.sendAllMessage(message);
                } catch (IOException e) {
                    e.printStackTrace();
                    continue;
                }
            }
    
            //推送给单个客户端
            for (Session session : webSocketMap.keySet()) {
                if (session.equals(mySession)) {
                    WebSocketTest item = (WebSocketTest) webSocketMap.get(mySession);
                    try {
                        String msg="嗨，这是返回的信息";
                        item.sendMessage(mySession,msg);
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
    
    
            }
    
    
        }
    
    
        /**
         * 发生错误时调用
         *
         * @param session
         * @param error
         */
        @OnError
        public void onError(Session session, Throwable error) {
            System.out.println("发生错误");
            // error.printStackTrace();
        }
    
    
        //给所有客户端发送信息
        public void sendAllMessage(String message) throws IOException {
            this.session.getBasicRemote().sendText(message);
        }
    
        //定向发送信息
        public void sendMessage(Session mySession,String message) throws IOException {
            synchronized(this) {try {
                if(mySession.isOpen()){//该session如果已被删除，则不执行发送请求，防止报错
                    //this.session.getBasicRemote().sendText(message);
                    mySession.getBasicRemote().sendText(message);
                }
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
    
            }
    
    
        }
    
    
    
    
    
    }
    此类用到了@component、@ServerEndpoint（value=‘’）表示建立连接的访问地址，@OnOpen建立连接时执行的方法；@OnClose连接关闭时执行的方法；@OnMessage收到客户端发送的消息时所执行的方法；@OnError发生错误时执行的方法

第三步，写前端页面

$(function() {
    
        //创建WebSocket
        connectWebSocket();
    })
    
    //强制关闭浏览器 调用websocket.close（）,进行正常关闭
    window.onunload = function() {
    
        //关闭连接 
        closeWebSocket();
    }
    
    //建立WebSocket连接
    function connectWebSocket(){
    
        console.log("开始...");
    
        //建立webSocket连接
        websocket = new WebSocket("ws://127.0.0.1:8080/socket/websocket");
    
        //打开webSokcet连接时，回调该函数
        websocket.onopen = function () {
            console.log("onpen");
        }
    
        //关闭webSocket连接时，回调该函数
        websocket.onclose = function () {
            //关闭连接 
            console.log("onclose");
        }
    
        //接收信息
        websocket.onmessage = function (msg) {
            console.log(msg.data);
        }
    }
    
    //发送消息
    function send(){
        var postValue={};
        postValue.id=userID;
        postValue.message=$("#text").val();
        websocket.send(JSON.stringify(postValue));
    }
    //关闭连接
    function closeWebSocket(){
        if(websocket != null) {
            websocket.close();
        }
    }

[https_www.jianshu.com_p_55cfc9fcb69e]: https://www.jianshu.com/p/55cfc9fcb69e