WebSocket淺談(前端+後端)

阿新 • • 發佈：2022-04-13

做的專案中需要將後端提供的資料展示在前端頁面，一開始我是用JS的setInterval()方法，設定一個時間，每過時間發起一次ajax請求。雖然也能湊活著實現，但總感覺資料不是實時重新整理的，而且還佔用資源，所以學習WebSocke，並總結了一下，以下是本人總結的前後端WebSocke相關程式碼：

一、後端：

1.pom.xml新增WebSocke依賴

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

2.WebSocke配置類

@Configuration
public class WebSocketConfig {

    /**
     * 這個bean的註冊,用於掃描帶有@ServerEndpoint的註解成為websocket  ,如果你使用外接的tomcat就            
        不需要該配置檔案
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }

}

3.WebSocke服務類

@ServerEndpoint(value = "/webSocket")//主要是將目前的類定義成一個websocket伺服器端, 註解的值將被用於監聽使用者連線的終端訪問URL地址,客戶端可以通過這個URL來連線到WebSocket伺服器端
@Component
@EnableScheduling// cron定時任務
@Data
public class WebSocket {

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

    /**
     * 靜態變數，用來記錄當前線上連線數。應該把它設計成執行緒安全的。
     */
    private static int onlineCount = 0;

    /**
     * concurrent包的執行緒安全Set，用來存放每個客戶端對應的MyWebSocket物件。
     */
    private static CopyOnWriteArraySet<WebSocket> webSocketSet = new CopyOnWriteArraySet<>();

    /**
     * 與某個客戶端的連線會話，需要通過它來給客戶端傳送資料
     */
    private Session session;

    public static CopyOnWriteArraySet<WebSocket> getWebSocketSet() {
        return webSocketSet;
    }

    public static void setWebSocketSet(CopyOnWriteArraySet<WebSocket> webSocketSet) {
        WebSocket.webSocketSet = webSocketSet;
    }

    /**
     * 從資料庫查詢相關資料資訊,可以根據實際業務場景進行修改
     */
    @Resource
    private IndexService indexService;
    private static IndexService indexServiceMapper;

    @PostConstruct
    public void init() {
        WebSocket.indexServiceMapper = this.indexService;
    }

    /**
     * 連線建立成功呼叫的方法
     *
     * @param session 會話
     */
    @OnOpen
    public void onOpen(Session session) throws Exception {
        this.session = session;
        webSocketSet.add(this);
        //查詢當前線上人數
        int nowOnline = indexServiceMapper.nowOnline();
        this.sendMessage(JSON.toJSONString(nowOnline));
    }

    /**
     * 收到客戶端訊息後呼叫的方法
     *
     * @param message 客戶端傳送過來的訊息
     */
    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        logger.info("引數資訊：{}", message);
        //群發訊息
        for (WebSocket item : webSocketSet) {
            try {
                item.sendMessage(JSON.toJSONString(message));
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 連線關閉呼叫的方法
     */
    @OnClose
    public void onClose() {
        webSocketSet.remove(this);
        if (session != null) {
            try {
                session.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    /**
     * 發生錯誤時呼叫
     *
     * @param session 會話
     * @param error   錯誤資訊
     */
    @OnError
    public void onError(Session session, Throwable error) {
        logger.error("連線異常！");
        error.printStackTrace();
    }

    /**
     * 傳送資訊
     *
     * @param message 訊息
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }

    /**
     * 自定義訊息推送、可群發、單發
     *
     * @param message 訊息
     */
    public static void sendInfo(String message) throws IOException {
        logger.info("資訊:{}", message);
        for (WebSocket item : webSocketSet) {
            item.sendMessage(message);
        }
    }
}

4.定時任務（為了給前端實時推送資料，我這裡寫了個定時任務，定時任務我用的是cron表示式,不懂的同學可以上這個網址學習：cron表示式）

@Slf4j
@Component
public class IndexScheduled {

    @Autowired
    private IndexMapper indexMapper;

    /**
     * 每3秒執行一次
     */
    //@Scheduled(cron = "0/3 * * * * ? ")
    public void nowOnline() {
        System.err.println("*********   首頁定時任務執行   **************");

        CopyOnWriteArraySet<WebSocket> webSocketSet = WebSocket.getWebSocketSet();
        int nowOnline = indexMapper.nowOnline();
        webSocketSet.forEach(c -> {
            try {
                c.sendMessage(JSON.toJSONString(nowOnline));
            } catch (IOException e) {
                e.printStackTrace();
            }
        });

        System.err.println("/n 首頁定時任務完成.......");
    }

}

二、前端：

前端的程式碼非常的簡單，直接上程式碼。

<body class="gray-bg">

<div class="online">
   <span class="online">測試線上人數：<span id="online"></span>&nbsp人</span>
</div>


<script th:inline="javascript">
    
    let websocket = null;
    let host = document.location.host;
    //判斷當前瀏覽器是否支援WebSocket
    if ('WebSocket' in window) {
        //連線WebSocket節點
        websocket = new WebSocket("ws://" + host + "/webSocket");
    } else {
        alert('瀏覽器不支援webSocket');
    }
    
    //連線發生錯誤的回撥方法
    websocket.onerror = function () {
        setMessageInnerHTML("error");
    };
    
    //連線成功建立的回撥方法
    websocket.onopen = function (event) {
        setMessageInnerHTML("open");
    };
    
    //接收到訊息的回撥方法
    websocket.onmessage = function (event) {
        let data = event.data;
        console.log("後端傳遞的資料:" + data);
        //將後端傳遞的資料渲染至頁面
        $("#online").html(data);
    };
    
    //連線關閉的回撥方法
    websocket.onclose = function () {
        setMessageInnerHTML("close");
    };
    
    //監聽視窗關閉事件，當視窗關閉時，主動去關閉websocket連線，防止連線還沒斷開就關閉視窗，server端會拋異常。
    window.onbeforeunload = function () {
        websocket.close();
    };
    
    //將訊息顯示在網頁上
    function setMessageInnerHTML(innerHTML) {
    
    };
    
    //關閉連線
    function closeWebSocket() {
        websocket.close();
    };
    
    //傳送訊息
    function send() {
        let message = document.getElementById('text').value;
        websocket.send(message);
    };
    
</script>

</body>