淺談PHP結合JavaScript SSE(Server Sent Events)實現伺服器實時推送功能

来源:https://www.cnblogs.com/phpphp/archive/2023/10/05/17743706.html
-Advertisement-
Play Games

簡介 SSE 的全稱是 Server Sent Events，即伺服器推送事件。它是一種基於 HTTP 的伺服器到客戶端的單向（半雙工）通信機制，使伺服器能夠主動將實時數據推送給客戶端，而不需要客戶端多次發起請求。 官方文檔：https://developer.mozilla.org/en-US/d ...


簡介

SSE 的全稱是 Server Sent Events，即伺服器推送事件。它是一種基於 HTTP 的伺服器到客戶端的單向（半雙工）通信機制，使伺服器能夠主動將實時數據推送給客戶端，而不需要客戶端多次發起請求。
官方文檔：https://developer.mozilla.org/en-US/docs/Web/API/EventSource

解決了什麼問題

常規的HTTP請求響應流程無法做到伺服器主動推送數據到客戶端，SSE可以解決此問題。

適用場景

實時更新訂閱數據、實時通知、實時日誌監控、實時數據統計、簡單的文本數據傳輸。

示例代碼

服務端

// 這行代碼用於關閉輸出緩衝。關閉後，腳本的輸出將立即發送到瀏覽器，而不是等待緩衝區填滿或腳本執行完畢。
ini_set('output_buffering', 'off');
// 這行代碼禁用了 zlib 壓縮。通常情況下，啟用 zlib 壓縮可以減小發送到瀏覽器的數據量，但對於伺服器發送事件來說，實時性更重要，因此需要禁用壓縮。
ini_set('zlib.output_compression', false);
// 這行代碼使用迴圈來清空所有當前激活的輸出緩衝區。ob_end_flush() 函數會刷新並關閉最內層的輸出緩衝區，@ 符號用於抑制可能出現的錯誤或警告。
while (@ob_end_flush()) {}
// 這行代碼設置 HTTP 響應的 Content-Type 為 text/event-stream，這是伺服器發送事件（SSE）的 MIME 類型。
header('Content-Type: text/event-stream');
// 這行代碼設置 HTTP 響應的 Cache-Control 為 no-cache，告訴瀏覽器不要緩存此響應。
header('Cache-Control: no-cache');
// 這行代碼設置 HTTP 響應的 Connection 為 keep-alive，保持長連接，以便伺服器可以持續發送事件到客戶端。
header('Connection: keep-alive');
// 這行代碼設置 HTTP 響應的自定義頭部 X-Accel-Buffering 為 no，用於禁用某些代理或 Web 伺服器（如 Nginx）的緩衝。這有助於確保伺服器發送事件在傳輸過程中不會受到緩衝影響
header('X-Accel-Buffering: no');


/**
 * @function 封裝sse格式的數據
 * @param  $data string
 * @return string
 */
function sse($data) {
    //data:\n\n不能少，sse固定格式
    return "data:{$data}\n\n";
}

// 開啟輸出緩衝
ob_start();
while (true) {
    $json = json_encode(['data' => ['time' => date('Y-m-d H:i:s')]], JSON_UNESCAPED_UNICODE);
    echo sse($json);
    //刷新緩衝區
    ob_flush();
    //將輸出緩衝區的內容立即發送到客戶端
    flush();
    sleep(1);
}

客戶端

<!doctype html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Document</title>
</head>
<body>

</body>

<script>
    if(!! window.EventSource) {
        var sse = new EventSource('http://127.0.0.1/test/sse.php');
        //通信事件
        sse.onmessage = function (event) {
            var response  = JSON.parse(event.data);
            console.log(response.data.time);
        };

        // 打開事件
        sse.onopen = function (event) { console.log('連接成功'); };

        //關閉事件
        sse.onclose = function(event) {console.log('連接關閉');};

        //錯誤事件
        sse.onerror = function (event) {console.error('連接失敗');};
    } else {
        alert('您的瀏覽器不支持SSE');
    }
</script>
</html>

服務端對客戶端單向通信是實時了，可服務端數據發生變化時，怎麼及時同步到SSE模塊呢？依客戶端顯示通知數量為需求做個簡單示例

方案1：純粹輪詢模式

做法：不停對資料庫做查詢。
優點：實現簡單。
缺點：很不優雅的方案，性能消耗大。
場景：數據量不大且趕工時，可作為臨時方案。
示例：

ob_start();
$user_id = 1; //假設用戶id為1，實際可傳參獲取。
while (true) {
    $notice_count = DB::table('notice')->where('user_id', $user_id)->count();
    echo sse(json_encode(['notice_num' => notice_count]));
    ob_flush();
    flush();
    sleep(1);
}

方案2：基於事件觸發，用消息隊列做訂閱發佈模式

做法：對要實時獲取的數據，先賦一個初始值的實際值，傳遞給客戶端，當數據發生變化時，觸發生產消息的通知，SSE模塊不停的消費消息。
優點：避免了輪詢模式瘋狂查詢。
缺點：仍舊需要消耗一些資源，實現稍微繁瑣。
場景：方法優雅，適用於訂閱端根據消息做更複雜的業務邏輯操作時使用。
示例：

暫時用redis隊列簡單實現：技術選型可根據實際情況做高可用或更複雜的設計。

//例如要實現一個通知數量實時變更的功能：
//發佈端：
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);
//假設用戶id為1
$user_id = 1;
//執行完其它的針對notice表寫操作的業務邏輯代碼...，然後向隊列丟一個任務
$redis->lPush('add_one_notice_task:'. $user_id, 1);
//------------------------------------------------------------------------------------------------------------------
//訂閱端
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);

//先查詢資料庫通知數量
$user_id = 1; //假設用戶id為1，實際可傳參獲取。
$notice_count = DB::table('notice')->where('user_id', $user_id)->count();
$redis->set('user_notice_num:'. $user_id, $notice_count);

while (true) {
    //若檢測到有自增一個通知數量的任務，則消費時觸發一個增加數量的動作。
    $add_one_notice_task = $redis->rPop('add_one_notice_task:'. $user_id);
    if($add_one_notice_task) {
        $redis->incr('user_notice_num:'. $user_id);
    }

    echo sse(json_encode(['notice_num' => $redis->get('user_notice_num:' . $user_id) ?? 0]));
    ob_flush();
    flush();
    sleep(1);
}

方案3：基於事件觸發的輪詢

做法：觸髮端直接一步到位，修改好數據後緩存，監聽端不停的監聽緩存的值。
優點：實現起來比訂閱發佈簡單，又避免輪詢頻繁查庫，通過緩存解耦，避免了方案1的性能問題，又能保證緩存一致性。
缺點：終究還是輪詢，仍舊需要消耗一些資源。
場景：相對簡單的，不需要在監聽端做業務處理，只做純粹返回數據的場景。
示例：

//觸髮端
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);
 //假設用戶id為1，實際可傳參獲取。
$user_id = 1;
//執行完其它的針對notice表寫操作的業務邏輯代碼...
$notice_count = DB::table('notice')->where('user_id', $user_id)->count();
$redis->set('user_notice_num:'. $user_id, $notice_count);
//------------------------------------------------------------------------------------------------------------------
//監聽端
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);
$user_id = 1; //假設用戶id為1，實際可傳參獲取。
while (true) {
    echo sse(json_encode(['notice_num' => $redis->get('user_notice_num:' . $user_id) ?? 0]));
    ob_flush();
    flush();
    sleep(1);
}

在實戰項目中的封裝

/**
 * @function 與客戶端server send event通信方式
 * @param    $callback    callable 回調，若返回數組代表要輸出json，返回null代表本次迴圈不進行輸出
 * @param    $millisecond int      數據分發間隔，單位：毫秒
 * @return   string
 * @other    void
 */
function sse($callback, $millisecond = 1000) {
    set_time_limit(0);
    ini_set('output_buffering', 'off');
    ini_set('zlib.output_compression', false);
    while (@ob_end_flush()) {}
    header('Content-Type: text/event-stream; Charset=UTF-8');
    header('Cache-Control: no-cache');
    header('Connection: keep-alive');
    header('X-Accel-Buffering: no');
    header("Access-Control-Allow-Origin: *");
    header("Access-Control-Allow-Credentials: true");
    header('Access-Control-Allow-Methods: *');
    header('Access-Control-Allow-Headers: *');

    ob_start();
    while (true) {
        $callback_res = $callback();
        if($callback_res !== null) {
            $data = json_encode($callback_res, JSON_UNESCAPED_UNICODE);
            echo "data:{$data}\n\n";
        }
        ob_flush();
        flush();
        usleep($millisecond * 1000);
    }
}

//調用
sse(function() {
	if('業務邏輯數據存在') {
		return ['k' => 'v'];
	}
	return null;
}, 1000);

SSE優點

  1. 實現簡單易用。
  2. 有斷線重連的能力，即使網路中斷，SSE仍舊會嘗試每隔幾秒自動重試的機制。
  3. 避免了客戶端使用短輪詢造成請求量過大的問題，避免在項目中因需要一個實時的通信小模塊就需要另外搭建WebSocket的問題，得不償失。

SSE缺點

  1. 完全不相容IE瀏覽器。
  2. SSE是一種半雙工通信，因為數據只能在一個方向上流動，即從伺服器到客戶端。與之相比，全雙工通信（例如WebSocket）允許數據在兩個方向上同時流動，允許雙向的數據傳輸。
  3. 為了避免濫用和資源占用，一些瀏覽器可能會限制單個功能變數名稱下的SSE連接數，例如同時最多打開6個連接。而另一些瀏覽器可能會限制整個瀏覽器實例中的SSE連接總數，這個限制不是由JavaScript語言本身所設定的，而是由瀏覽器實現所定義的。

SSE對比WebSocket

協議區別

協議：SSE是基於HTTP協議，而WebSocket則是獨立的協議，它們都可以在瀏覽器和伺服器之間建立持久的連接。

數據格式

SSE通過HTTP協議傳輸的數據格式是文本（通常是JSON格式），因此它適合用於傳輸簡單的文本數據或者事件。而WebSocket可以傳輸文本和二進位數據，在處理音頻、視頻等大型數據時更有優勢。

通信方式

SSE基於半雙工模式，伺服器可以通過發送事件流（event stream）來主動推送數據給客戶端。客戶端通過監聽這些事件來接收數據。而WebSocket是全雙工通信協議，客戶端和伺服器可以隨時發送和接收數據。

相容性

IE10及以上支持 WebSocket。但IE都不相容SSE，並且不同瀏覽器對SSE相容性不一樣，可通過Polyfill解決，官網：https://developer.mozilla.org/en-US/docs/Glossary/Polyfill。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 說說為什麼要做資料庫拆分
    1. 為什麼要拆分資料庫？ 單體項目在構建之初，資料庫的負載和數據量都不大，所以不需要對資料庫做拆分，小型財務系統、文書系統、ERP系統、OA系統，用一個MySQL資料庫實例基本就夠用了。 就像《淘寶技術這十年》裡面說到的，電商業務的數據量增長飛快，所以最開始的PHP+MySQL的架構已經不能滿足實 ...
  • 【Flutter】如何優美地實現一個懸浮NavigationBar
    【Flutter】如何優美地實現一個懸浮NavigationBar 最近寫代碼的時候遇到了一個如下的需求： 整體來說，底部的條是一個浮動的懸浮窗，有如下的三個按鈕： 點擊左邊的要進入“主頁” 點擊中間的按鈕要進行頁面跳轉，能夠進入“創作頁” 點擊右邊的按鈕切換到“個人中心”頁 使用Overlay來實 ...
  • 前端最新支持四級及以下結構仿企查查、天眼查關聯投資機構 股權結構 tree樹形結構 控股結構
    經過 Adobe 工程師多年來的努力，並與 Chrome 等瀏覽器供應商密切合作，通過 WebAssembly + Emscripten、Web Components + Lit、Service Workers + Workbox 和新的 Web API 的支持，終於在近期推出了 Web 版 Pho ...
  • Docker Compose V2 安裝常用資料庫MySQL+Mongo
    主要增加對容器創建 MySQL、Mongo 時對 數據文件，日誌，配置，網路，時區，埠映射，密碼 的配置，更貼合生產環境的實際使用 ...
  • 軟體設計模式系列之二十五——訪問者模式
    軟體設計原則 GRASP 通用職責分配軟體模式 來自 Craig Larman 的軟體設計書《UML 和模式應用》，Larman 在書中提出軟體設計的關鍵任務是職責分配，並提煉總結出 9 種 (5 種核心 +4 種擴展) 軟體職責分配模式，這些模式是比 GoF 設計模式更抽象的元模式。 信息專家 ( ...
  • 軟體設計模式系列之二十四——模板方法模式
    本文記錄了穩定性摸排過程中的一些思考和沉澱。 前言 在之前寫了篇文章《上線十年，81萬行Java代碼的老系統如何重構》，在文章後有同學留言問“這麼複雜的改動，質量是如何應對的”，是一個特別好的問題，當時只是從現有的一些監控、測試、卡口手段上進行了回答。但在回答過程當中就在思考一個問題，交接過來的老代 ...
  • 9張圖深入剖析ConcurrentHashMap
    前言 在日常的開發中，我們經常使用key-value鍵值對的HashMap，其使用哈希表實現，用空間換取時間，提升查詢性能 但在多線程的併發場景中，HashMap並不是線程安全的 如果想使用線程安全的，可以使用ConcurrentHashMap、HashTable、Collections.synch ...
  • Flutter/Dart第10天：Dart高級特性Pattern模式的全部類型（共15種）
    Pattern模式是Dart 3.0發佈的3個高級特性之一，在第09天我們學習了模式的概覽和用法，對模式的強大之處有了基本的認識，今天我們來看看Dart中的全部模式類型，總共有15種，它們包括邏輯或、邏輯與、關係、值轉換、空檢測、空斷言、常量、變數、標識符、括弧、List列表、Map映射、Recor... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類