spring boot集成Websocket

websocket實現后台像前端主動推送消息的模式，可以減去前端的請求獲取數據的模式。而后台主動推送消息一般都是要求消息回饋比較及時，同時減少前端ajax輪詢請求，減少資源開銷。

spring boot已經集成了websocket，tomcat亦是如此。所以WebSocketConfig配置類就不需要了，不需要開啟什么支持，本來就支持。

一、導入依賴

    <!--websocket-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
            <version>1.5.9.RELEASE</version>
        </dependency>

 

二、websocket多線程，線上真實環境已經測試過。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.HashMap;
import java.util.Map;


/**
 * @Auther: lanhaifeng
 * @Date: 2018/11/6 0006 17:59
 * @Description: websocket服務端
 * @ServerEndpoint 注解是一個類層次的注解，它的功能主要是將目前的類定義成一個websocket服務器端,
 * 注解的值將被用於監聽用戶連接的終端訪問URL地址,客戶端可以通過這個URL來連接到WebSocket服務器端
 * @ServerEndpoint 可以把當前類變成websocket服務類
 */
@ServerEndpoint("/websocket/{sid}")
@Component
public class WebSocketServer {

    private static Logger logger = LoggerFactory.getLogger(WebSocketServer.class);

    //存儲連接用戶的session
    private static CopyOnWriteArraySet<String, Session> connections = new CopyOnWriteArraySet<>();


    /**
     * 打開連接
     * @param session
     * @param sid
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("sid") String sid) {
        connections.put(sid, session);
    }

    /**
     * 接收消息
     * @param text
     */
    @OnMessage
    public void onMessage(String text) {
        logger.info("收到來新的信息:"+text);
    }

    /**
     * 異常處理
     * @param throwable
     */
    @OnError
    public void onError(Throwable throwable) {
        throwable.printStackTrace();
    }

    /**
     * 關閉連接
     * @param sid
     */
    @OnClose
    public void onClosing(@PathParam("sid") String sid) throws IOException {
        connections.remove(sid);
    }


    /**
     * 根據IP發送消息
     * @param sid
     * @param text
     */
    public static void sendInfo(String text,@PathParam("sid") String sid) {
        try {
            Session session = connections.get(sid);
            if (session != null && session.isOpen()) {
                session.getAsyncRemote().sendText(text);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 遍歷群發消息
     * @param text
     */
    public static void send(String text) {
        for (Map.Entry<String, Session> entry : connections.entrySet()) {
            sendInfo(text,entry.getKey());
        }
    }


}

在業務中的調用就不介紹了，直接  WebSocketServer.sendInfo(text,sid)

特別注意sendInfo(String message,@PathParam("sid") String sid)兩個參數在實際應用中的先后順序，否則將發送失敗。因為找不到該sid的連接。

同時無論是反向代理還是socket本身，60S沒有消息會自動斷開連接，於是乎

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;

/**
 * @Auther: lanhaifeng
 * @Date: 2019/5/16 0016 14:29
 * @Description:webSocket定時發送消息類
 * @statement: 以<60s的頻率發送給websocket連接的對象，以防止反向代理的60s超時限制
 */
@Configuration      //1.主要用於標記配置類，兼備Component的效果。
@EnableScheduling   // 2.開啟定時任務
public class SaticScheduleTask {


    //3.添加定時任務,55秒是考慮5秒的延遲,從而保證60s的心跳
    //@Scheduled(cron = "0/55 * * * * ?")
    //或直接指定時間間隔，例如：55秒
    @Scheduled(fixedRate=55*1000)
    private void configureTasks() throws Exception{
        WebSocketServer.send("呼叫動拐,呼叫動拐!");
    }
}