實時訊息推送整理-有解無憂

分不清輪詢、長輪詢？不知道什么時候該用websocket還是SSE，看這篇就夠了，

所謂的“實時推送”，從表面意思上來看是，客戶端訂閱的內容在發生改變時，服務器能夠實時地通知客戶端，進而客戶端進行相應地反應，客戶端不需要主觀地發送請求去獲取自己關心的內容，而是由服務器端進行“推送”，

注意上面的推送二字打了引號，這就意味著在現有的幾種實作方式中，并不是服務器端主動地推送，而是通過一定的手段營造了一種實時的假象，就目前現有的幾種技術而言，主要有以下幾類：

客戶端輪詢：傳統意義上的輪詢(Short Polling)
服務器端輪詢：長輪詢(Long Polling)
全雙工通信：Websocket
單向服務器推送：Server-Sent Events(SSE)

文中會以一個簡易聊天室的例子來分別通過上述的四種方式實作，代碼地址mini-chatroom(存在些許bug，主要是為了做演示用)

overview

輪詢（Short Polling）

輪詢的實作原理：客戶端向服務器端發送一個請求，服務器回傳資料，然后客戶端根據服務器端回傳的資料進行處理；然后客戶端繼續向服務器端發送請求，繼續重復以上的步驟，如果不想給服務器端太大的壓力，一般情況下會設定一個請求的時間間隔，

shortPolling

使用輪詢明顯的優點是基礎不需要額外的開發成本，請求資料，決議資料，作出回應，僅此而已，然后不斷重復，缺點也顯而易見：

不斷的發送和關閉請求，對服務器的壓力會比較大，因為本身開啟Http連接就是一件比較耗資源的事情
輪詢的時間間隔不好控制，如果要求的實時性比較高，顯然使用短輪詢會有明顯的短板，如果設定interval的間隔過長，會導致訊息延遲，而如果太短，會對服務器產生壓力

代碼實作

var ShortPollingNotification = {
  datasInterval: null,
  subscribe: function() {
    this.datasInterval = setInterval(function() {
      Request.getDatas().then(function(res) {
        window.ChatroomDOM.renderData(res);
      });
    }, TIMEOUT);
    return this.unsubscribe;
  },
  unsubscribe: function() {
    this.datasInterval && clearInterval(this.datasInterval);
  }
}

shortPolling

下面是對應的請求，注意左下角的請求數量一直在變化

shortNetwork

在上圖中，每隔1s就會發送一個請求，看起來效果還不錯，但是如果將timeout的值設定成5s，效果將大打折扣，如圖：

shortPolling5s

長輪詢(Long Polling)

長輪詢的基本原理：客戶端發送一個請求，服務器會hold住這個請求，直到監聽的內容有改變，才會回傳資料，斷開連接，客戶端繼續發送請求，重復以上步驟，或者在一定的時間內，請求還得不到回傳，就會因為超時自動斷開連接，

longPolling

長輪詢是基于輪詢上的改進版本，主要是減少了客戶端發起Http連接的開銷，改成了在服務器端主動地去判斷所關心的內容是否變化，所以其實輪詢的本質并沒有多大變化，變化的點在于：

對于內容變化的輪詢由客戶端改成了服務器端（客戶端會在連接中斷之后，會再次發送請求，對比短輪詢來說，大大減少了發起連接的次數）
客戶端只會在資料改變時去作相應的改變，對比短輪詢來說，并不是全盤接收

代碼實作

// 客戶端
var LongPollingNotification = {
    // ....
    subscribe: function() {
      var that = this;

      // 設定超時時間
      Request.getV2Datas(this.getKey(),{ timeout: 10000 }).then(function(res) {
        var data = https://www.cnblogs.com/rynxiao/archive/2020/10/16/res.data;
        window.ChatroomDOM.renderData(res);
        // 成功獲取資料后會再次發送請求
        that.subscribe();
      }).catch(function (error) {
        // timeout 之后也會再次發送請求
        that.subscribe();
      });
      return this.unsubscribe;
    }

    // ....
}

筆者采用的是express，默認不支持hold住請求，因此用了一個express-longpoll的庫來實作，

下面是一個原生不用庫的實作（這里只是介紹原理），整體的思路是：如果服務器端支持hold住請求的話，那么在一定的時間內會自輪詢，然后期間通過比較key值，判斷是否回傳新資料

客戶端第一次會帶一個空的key值，這次會立即回傳，獲取新內容，服務器端將計算出的contentKey回傳給客戶端
然后客戶端發送第二次請求，帶上第一次回傳的contentKey作為key值，然后進行下一輪的比較
如果兩次的key值相同，就會hold請求，進行內部輪詢，如果期間有新內容或者客戶端timeout，就會斷開連接
重復以上步驟

// 服務器端

router.get('/v2/datas', function(req, res) {
  const key = _.get(req.query, 'key', '');
  let contentKey = chatRoom.getContentKey();

  while (key === contentKey) {
    sleep.sleep(5);
    contentKey = chatRoom.getContentKey();
  }

  const connectors = chatRoom.getConnectors();
  const messages = chatRoom.getMessages();
  res.json({
    code: 200,
    data: { connectors: connectors, messages: messages, key: contentKey },
  });
});

以下是用 express-longpoll 的實作片段

// mini-chatroom/public/javascripts/server/longPolling.js

function pushDataToClient(key, longpoll) {
  var contentKey = chatRoom.getContentKey();

  if (key !== contentKey) {
    var connectors = chatRoom.getConnectors();
    var messages = chatRoom.getMessages();

    longpoll.publish(
      '/v2/datas',
      {
        code: 200,
        data: {connectors: connectors, messages: messages, key: contentKey},
      }
    );
  }
}

longpoll.create("/v2/datas", function(req, res, next) {
  key = _.get(req.query, 'key', '');
  pushDataToClient(key, longpoll);
  next();
});

intervalId = setInterval(function() {
  pushDataToClient(key, longpoll);
}, LONG_POLLING_TIMEOUT);

為了方便演示，我將客戶端發起請求的timeout改成了4s，注意觀察下面的截圖：

longPollingNetwork

可以看到，斷開連接的兩種方式，要么是超時，要么是請求有資料回傳，

基于iframe的長輪詢模式

這種模式的具體的原理為：

在頁面中嵌入一個iframe，地址指向輪詢的服務器地址，然后在父頁面中放置一個執行函式，比如execute(data)
當服務器有內容改變時，會向iframe發送一個腳本<script>parent.execute(JSON.stringify(data))</script>
通過發送的腳本，主動執行父頁面中的方法，達到推送的效果

具體可以參看這里

Websocket

The WebSocket Protocol enables two-way communication between a client running untrusted code in a controlled environment to a remote host that has opted-in to communications from that code.

The protocol consists of an opening handshake followed by basic message framing, layered over TCP.

The goal of this technology is to provide a mechanism for browser-based applications that need two-way communication with servers that does not rely on opening multiple HTTP connections (e.g., using XMLHttpRequest or iframe and long polling).

The WebSocket Protocol attempts to address the goals of existing bidirectional HTTP technologies in the context of the existing HTTP infrastructure; as such, it is designed to work over HTTP ports 80 and 443 as well as to support HTTP proxies and intermediaries, even if this implies some complexity specific to the current environment.

特征

websocket是雙向通信的，設計的目的主要是為了減少傳統輪詢時http連接數量的開銷
建立在TCP協議之上，握手階段采用 HTTP 協議，因此握手時不容易屏蔽，能通過各種 HTTP 代理服務器
與HTTP兼容性良好，同樣可以使用80和443埠
沒有同源限制，客戶端可以與任意服務器通信
可以發送文本，也可以發送二進制資料，
協議識別符號是ws（如果加密，則為wss），服務器網址就是 URL

websocket

關于Websocket API方面的知識，這里不再作講解，可以自己查閱Websocket API MDN

兼容性

websocket兼容性良好，基本支持所有現代瀏覽器

websocket1

代碼實作

筆者這里采用的是socket.io，是基于websocket的封裝，提供了客戶端以及服務器端的支持

// 客戶端
var WebsocketNotification = {
  // ...
  subscribe: function(args) {
    var connector = args[1];
    this.socket = io();

    this.socket.emit('register', connector);

    this.socket.on('register done', function() {
      window.ChatroomDOM.renderAfterRegister();
    });

    this.socket.on('data', function(res) {
      window.ChatroomDOM.renderData(res);
    });

    this.socket.on('disconnect', function() {
      window.ChatroomDOM.renderAfterLogout();
    });
  }
  // ...
}

// 服務器端
var io = socketIo(httpServer);

io.on('connection', (socket) => {
  socket.on('register', function(connector) {
    chatRoom.onConnect(connector);

    io.emit('register done');

    var data = https://www.cnblogs.com/rynxiao/archive/2020/10/16/chatRoom.getDatas();
    io.emit('data', { data });
  });

  socket.on('chat', function(message) {
    chatRoom.receive(message);

    var data = https://www.cnblogs.com/rynxiao/archive/2020/10/16/chatRoom.getDatas();
    io.emit('data', { data });
  });
});

回應格式如下：

websocket-request-response

Server-Sent Events(SSE)

傳統意義上服務器端不會主動推送給客戶端訊息，一般都是客戶端主動去請求服務器端獲取最新的資料，SSE就是一種可以主動從服務端推送訊息的技術，

SSE的本質其實就是一個HTTP的長連接，只不過它給客戶端發送的不是一次性的資料包，而是一個stream流，格式為text/event-stream，所以客戶端不會關閉連接，會一直等著服務器發過來的新的資料流，視頻播放就是這樣的例子，

SSE 使用 HTTP 協議，現有的服務器軟體都支持，WebSocket 是一個獨立協議，

SSE 屬于輕量級，使用簡單；WebSocket 協議相對復雜，

SSE 默認支持斷線重連，WebSocket 需要自己實作，

SSE 一般只用來傳送文本，二進制資料需要編碼后傳送，WebSocket 默認支持傳送二進制資料，

SSE 支持自定義發送的訊息型別，

基本的使用方法，參看SSE API

sse

兼容性

目前除了IE以及低版本的瀏覽器不支持，基本支持絕大多數的現代瀏覽器，

sse2

代碼實作

// 客戶端
var SSENotification = {
  source: null,
  subscribe: function() {
    if ('EventSource' in window) {
      this.source = new EventSource('/sse');

      this.source.addEventListener('message', function(res) {
        const d = res.data;
        window.ChatroomDOM.renderData(JSON.parse(d));
      });
    }
    return this.unsubscribe;
  },
  unsubscribe: function () {
    this.source && this.source.close();
  }
}

// 服務器端
router.get('/sse', function(req, res) {
  const connectors = chatRoom.getConnectors();
  const messages = chatRoom.getMessages();
  const response = { code: 200, data: { connectors: connectors, messages: messages } };

  res.writeHead(200, {
    "Content-Type":"text/event-stream",
    "Cache-Control":"no-cache",
    "Connection":"keep-alive",
    "Access-Control-Allow-Origin": '*',
  });

  res.write("retry: 10000\n");
  res.write("data: " + JSON.stringify(response) + "\n\n");

  var unsubscribe = Event.subscribe(function() {
    const connectors = chatRoom.getConnectors();
    const messages = chatRoom.getMessages();
    const response = { code: 200, data: { connectors: connectors, messages: messages } };
    res.write("data: " + JSON.stringify(response) + "\n\n");
  });

  req.connection.addListener("close", function () {
    unsubscribe();
  }, false);
});

下面是控制臺的情況，注意觀察回應型別

sse-type

詳情中注意查看請求型別，以及EventStream訊息型別

sse3

總結

短輪詢、長輪詢實作成本相對比較簡單，適用于一些實時性要求不高的訊息推送，在實時性要求高的場景下，會存在延遲以及會給服務器帶來更大的壓力
websocket目前而言實作成本相對較低，適合于雙工通信，對于多人在線，要求實時性較高的專案比較實用
SSE只能是服務器端推送訊息，因此對于不需要雙向通信的專案比較適用

參考連接

The WebSocket Protocol
Websocket API MDN
Server-sent events MDN
WebSocket 教程
Server-Sent Events 教程
webSocket(二) 短輪詢、長輪詢、Websocket、sse

轉載請註明出處，本文鏈接：https://www.uj5u.com/qiye/174086.html

標籤：其他

上一篇：postman使用

下一篇：postman使用