跨域訪問方法介紹(8)--使用 WebSocket

時間 2021-08-12

標籤 javascript html html5 java web spring 跨域瀏覽器 tomcat 服務器欄目 JavaScript 简体版

原文原文鏈接

WebSocket 是 HTML5 開始提供的一種在單個 TCP 鏈接上進行全雙工通信的協議；使用 ws://（非加密）和 wss://（加密）做爲協議前綴。該協議不實行同源政策，只要服務器支持，就能夠經過它進行跨源通訊。本文主要介紹使用 WebSocket 來實現跨域請求，文中所使用到的軟件版本：Chrome 90.0.4430.2十二、Spring Boot 2.4.四、jdk1.8.0_181。javascript

一、WebSocket 簡介

WebSocket 使得客戶端和服務器之間的數據交換變得更加簡單，容許服務端主動向客戶端推送數據。在 WebSocket API 中，瀏覽器和服務器只須要完成一次握手，二者之間就直接能夠建立持久性的鏈接，並進行雙向數據傳輸。在 WebSocket API 中，瀏覽器和服務器只須要作一個握手的動做，而後，瀏覽器和服務器之間就造成了一條快速通道。二者之間就直接能夠數據互相傳送。html

目前，不少網站都使用 Ajax 輪詢來實現推送。輪詢是在特定的的時間間隔（如每1秒），由瀏覽器對服務器發出HTTP請求，而後由服務器返回最新的數據給客戶端的瀏覽器。這種傳統的模式帶來很明顯的缺點，即瀏覽器須要不斷的向服務器發出請求，然而HTTP請求可能包含較長的頭部，其中真正有效的數據可能只是很小的一部分，顯然這樣會浪費不少的帶寬等資源。html5

HTML5 定義的 WebSocket 協議，能更好的節省服務器資源和帶寬，而且可以更實時地進行通信。java

瀏覽器經過 WebSocket 對象向服務器發出創建 WebSocket 鏈接的請求，鏈接創建之後，客戶端和服務器端就能夠經過 TCP 鏈接直接交換數據。當獲取 WebSocket 鏈接後，就能夠經過 send() 方法來向服務器發送數據，並經過 onmessage 事件來接收服務器返回的數據。web

1.一、WebSocket 語法

let Socket = new WebSocket(url, [protocol]);

1.二、WebSocket 屬性

屬性	描述
WebSocket.readyState	只讀屬性 readyState 表示鏈接狀態，能夠是如下值： 0 - 表示鏈接還沒有創建。 1 - 表示鏈接已創建，能夠進行通訊。 2 - 表示鏈接正在進行關閉。 3 - 表示鏈接已經關閉或者鏈接不能打開。
WebSocket.bufferedAmount	只讀屬性 bufferedAmount 表示已被 send() 放入隊列中正在等待傳輸，可是尚未發出的 UTF-8 文本字節數。

1.三、WebSocket 事件

事件	事件處理程序	描述
open	WebSocket.onopen	鏈接創建時觸發
message	WebSocket.onmessage	客戶端接收服務端數據時觸發
error	WebSocket.onerror	通訊發生錯誤時觸發
close	WebSocket.onclose	鏈接關閉時觸發

1.四、WebSocket 實例

WebSocket 協議本質上是一個基於 TCP 的協議。爲了創建 WebSocket 鏈接，客戶端瀏覽器首先要向服務器發起一個 HTTP 請求，這個請求和一般的 HTTP 請求不一樣，包含了一些附加頭信息，其中附加頭信息"Upgrade: WebSocket"代表這是一個申請協議升級的 HTTP 請求，服務器端解析這些附加的頭信息而後產生應答信息返回給客戶端，客戶端和服務器端的 WebSocket 鏈接就創建起來了，雙方就能夠經過這個鏈接通道自由的傳遞信息，而且這個鏈接會持續存在直到客戶端或者服務器端的某一方主動的關閉鏈接。spring

二、WebSocket 實戰

2.一、服務端實現(SpringBoot 版)

2.1.一、引入依賴

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

2.1.二、注入 ServerEndpointExporter

package com.abc.demo.config;

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

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

2.1.三、WebSocket 實現類

package com.abc.demo.websocket;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

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

@ServerEndpoint(value = "/websocket")
@Component
public class WebSocketTest {
    private static Logger logger = LoggerFactory.getLogger(WebSocketTest.class);

    @OnOpen
    public void onOpen(Session session) {
        logger.info("有新鏈接加入：{}", session.getId());
        sendMessage(session);
    }

    @OnClose
    public void onClose(Session session) {
        logger.info("有一鏈接關閉：{}", session.getId());
    }

    @OnMessage
    public void onMessage(String message, Session session) {
        logger.info("服務端收到客戶端[{}]的消息:{}", session.getId(), message);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        logger.error("發生錯誤");
        error.printStackTrace();
    }

    private void sendMessage(Session session) {
        new Thread(() -> {
            try {
                for (int i = 0; i <= 10 && session.isOpen(); i++) {
                    session.getBasicRemote().sendText("服務端消息" + i);
                    Thread.sleep(1000 * 5);
                }
                if (session.isOpen()) {
                    session.getBasicRemote().sendText("服務端消息發送完畢。");
                }
                session.close();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }).start();
    }
}

2.二、客戶端實現

websocket.html跨域

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>websocket測試</title>

<script type="text/javascript">
    let websocket = null;
    function initSocket() {
        if (window.WebSocket) {
            websocket = new WebSocket("ws://localhost:8081/websocket");
        } else {
            alert('你的瀏覽器不支持WebSocket');
            return;
        }
        
        websocket.onerror = function() {
            console.log('發生錯誤');
        };
    
        websocket.onopen = function(event) {
            console.log("創建鏈接");
        }
    
        websocket.onmessage = function(event) {
            document.getElementById('message').innerHTML += event.data + '<br/>';
        }
    
        websocket.onclose = function() {
            console.log("鏈接關閉");
        }
        
        //窗口關閉事件，關閉websocket鏈接。
        window.onbeforeunload = function() {
            websocket.close();
        }
    }
    initSocket();
    
    function closeWebSocket() {
        websocket.close();
    }

    function send() {
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</head>
<body>
    <input id="text" type="text" />
    <button onclick="send()">Send</button>
    <button onclick="closeWebSocket()">Close</button>
    <div id="message"></div>
</body>

</html>