swoole、Redis實時數據推送

<?php
/**
 * ***************************************
 *            單進程保護                 *
 * ***************************************
 */
$phpSelf             = realpath($_SERVER['PHP_SELF']);
$lockFile            = $phpSelf.'.lock';
$lockFileHandle     = fopen($lockFile, "w");
if ($lockFileHandle == false) {
    exit("Can not create lock file $lockFile\n");
}
if (!flock($lockFileHandle, LOCK_EX + LOCK_NB)) {
    exit(date("Y-m-d H:i:s")."Process already exist.\n");
}
 
/**
 * ***************************************
 *     進入程序，定義相關配置            *
 * ***************************************
 */
set_time_limit(0);
//socket會話的超時時間,根據業務場景設置，這裏設置爲永不超時
//如果設置了時間，則從socket建立=>傳輸=>關閉整個過程必須在定義的時間內完成，否則自動close該socket並拋出warning
ini_set('default_socket_timeout', -1);
$conf = array(
    'listen'  => array('host' => '0.0.0.0','port' => '8008'),
    'setting' => array(
        //程序允許的最大連接數，用以設置server最大允許維持多少個TCP連接，超過該數量後，新連接將被拒絕，默認爲ulimit -n的值，如果設置大於ulimit -n則強制重置爲ulimit- n，如果確實需要設置超過ulimit -n的值，請修改系統值 vim /etc/security/limits.conf 修改nofile的值
        "max_conn"            => 1024,
        //啓用CPU親和設置(在全異步非阻塞是可啓用),在多核的服務器中，啓用此特性會將swoole的reactor線程/worker進程綁定到固定的一個核上。可以避免進程/線程的運行時在多個核之間互相切換，提高CPU Cache的命中率,如何確定綁定在了哪個核上，請參考文檔, 查看命令: taskset -p 進程id
        'open_cpu_affinity'    => 0,
        //配置task進程數量,配置此參數後將會啓用task功能。所以Server務必要註冊onTask、onFinish2個事件回調函數。如果沒有註冊，服務器程序將無法啓動.Task進程是同步阻塞的，配置方式與Worker同步模式一致。
        'task_worker_num'    => 20,
        //設置task進程的最大任務數。一個task進程在處理完超過此數值的任務後將自動退出。這個參數是爲了防止PHP進程內存溢出。如果不希望進程自動退出可以設置爲0, 默認是0
        'task_max_request'    => 1024,
        //設置task的數據臨時目錄，在swoole_server中，如果投遞的數據超過8192字節，將啓用臨時文件來保存數據。這裏的task_tmpdir就是用來設置臨時文件保存的位置。
        'task_tmpdir'        => '/tmp/',
        //worker進程數量，根據業務代碼的模式作調整，全異步非阻塞可設置爲CPU核數的1-4倍;同步阻塞，請參考文檔調整
        'worker_num'        => 8,
        //指定swoole錯誤日誌文件
        'log_file'             => '/tmp/log/log.txt',
        //SSL公鑰和私鑰的位置，啓用wss必須在編譯swoole時加入--enable-openssl選項
        'ssl_cert_file'        => '/usr/local/nginx/conf/server.cer',
        'ssl_key_file'        => '/usr/local/nginx/conf/server.key',
    ),
);
 
/**
 * ***************************************
 *       初始化Redis連接                 *
 * ***************************************
 */
$redis = null;
$redis = new Redis();
$redis->connect(REDIS_HOST, REDIS_PORT);
$redis->auth(REDIS_PWD);
$GLOBALS['redis']=$redis;
 
/**
 * ***************************************
 *        腳本重啓時，清除歷史的數據     *
 * ***************************************
 */
$sArr = $redis->sMembers(REDIS_S_KEY);
if (!empty($sArr)) {
    foreach ((array)$sArr as $key => $sc) {
        $fdArr = $redis->sMembers(REDIS_S_FD.$sc);
        foreach ((array)$fdArr as $k => $fd) {
            $res1 = $redis->del(REDIS_FD_S.$fd);
        }
        $res2 = $redis->del(REDIS_S_FD.$sc);
    }
    $redis->del(REDIS_S_KEY);
}
$redis->del(REDIS_ZS_KEY);
 
/**
 * ***************************************
 *           綁定回調事件                *
 * ***************************************
 */
$ws = null;
//wss服務
$ws = new swoole_websocket_server($conf['listen']['host'], $conf['listen']['port'], SWOOLE_PROCESS, SWOOLE_SOCK_TCP | SWOOLE_SSL);
$ws->set($conf['setting']);
 
/**
 * Server啓動在主進程的主線程回調此函數
 * 在此事件之前Swoole Server已進行了如下操作
 * 已創建了manager進程
 * 已創建了worker子進程
 * 已監聽所有TCP/UDP端口
 * 已監聽了定時器
 * 在onStart中創建的全局資源對象不能在worker進程中被使用，因爲發生onStart調用時，worker進程已經創建好了。新創建的對象在主進程內，worker進程無法訪問到此內存區域。因此全局對象創建的代碼需要放置在swoole_server_start之前
 */
$ws->on('start', function ($ws) {
    swoole_set_process_name(PROCESS_NAME.'_master');
});
 
/**
 * 與onStart回調在不同進程中並行執行的回調函數(不存在先後順序)
 * @param: $ws swoole_websocket_server object
 * @param: $wid 創建該進程時swoole分配的id(不是進程id)
 * 注意點:
 * 1. 此事件在worker進程/task進程啓動時發生。onWorkerStart/onStart是併發執行的，沒有先後順序,這裏創建的對象可以在進程生命週期內使用
 * 2. swoole1.6.11之後task_worker中也會觸發onWorkerStart,故而在下面的處理中，加入了判斷業務類型$jobType是task還是work，如果是task則命名爲****_Tasker_$id,如果是worker則命名爲****_Worker_$id
 * 3. 發生PHP致命錯誤或者代碼中主動調用exit時，Worker/Task進程會退出，管理進程會重新創建新的進程
 * 5. 如果想使用swoole_server_reload實現代碼重載入，必須在workerStart中require你的業務文件，而不是在文件頭部。在onWorkerStart調用之前已包含的文件，不會重新載入代碼。
 * 6. 可以將公用的，不易變的php文件放置到onWorkerStart之前(例如上面的redis配置)。這樣雖然不能重載入代碼，但所有worker是共享的，不需要額外的內存來保存這些數據。
 * 7. onWorkerStart之後的代碼每個worker都需要在內存中保存一份
 */
$ws->on('workerstart', function ($ws, $wid) {
    $jobType = $ws->taskworker ? 'Tasker' : 'Worker';
    swoole_set_process_name(PROCESS_NAME.'_'.$jobType.'_'.$wid);
    $GLOBALS['ws'] = $ws; //保存server對象到全局中以待使用
    if ($jobType == 'Worker') { //在某個worker進程上綁定redis訂閱進程
        if ($wid === 0) {
            $dataRedis = null;
            $dataRedis = new Redis();
            $dataRedis->connect(REDIS_HOST_DATA, REDIS_PORT_DATA);
            $dataRedis->auth(REDIS_PWD_DATA);
            //使用psubscribe訂閱指定模式的頻道，這裏*表示所有頻道
            //請注意,redis訂閱不提供區分庫(db)的功能，所以多個庫都同時在發佈同一個名字的頻道時，都將被訂閱到
            $dataRedis->psubscribe(array("*"), "sendTask");
        }
    }
});
 
/**
 * 管理進程啓用時，調用該回調函數
 * 注意manager進程中不能添加定時器
 * manager進程中可以調用sendMessage接口向其他工作進程發送消息
 */
$ws->on('managerstart', function ($ws) {
    swoole_set_process_name(PROCESS_NAME.'_manage');
});
 
/**
 * swoole websocket服務特有的回調函數，此函數在websocket服務器中必須定義實現，否則websocket服務將無法啓動
 * 當服務器收到來自客戶端的數據幀時會回調此函數
 * @param: $ws爲swoole_websocket_server對象，其結構在調試時可var_dump查看
 * @param: $frame爲swoole_websocket_frame對象，包含了客戶端發來的數據幀信息,包含以下四個屬性：
 * @param: $frame->fd: 客戶端的socket id，每個id對應一個客戶端，推送消息的時候需要指定
 * @param: $frame->data: 數據內容，可以是文本內容或者是二進制數據(圖片等)，可以通過opcode的值來判斷。$data 如果是文本類型，編碼格式必然是UTF-8，這是WebSocket協議規定的
 * @param: $frame->opcode: WebSocket的OpCode類型，可以參考WebSocket協議標準文檔, WEBSOCKET_OPCODE_TEXT = 0x1 ，文本數據; WEBSOCKET_OPCODE_BINARY = 0x2 ，二進制數據
 * @param: $frame->finish: 表示數據幀是否完整，一個WebSocket請求可能會分成多個數據幀進行發送
 * 注意點: 客戶端發送的ping幀不會觸發onMessage，底層會自動回覆pong包
 */
$ws->on('message', function ($ws, $frame) {
    echo "Server has receive message\n";
    //接收到客戶端請求，並建立連接之後，進行相應業務的處理
    handleClientData($ws, $frame);
});
 
/**
 * 在task_worker進程內被調用。worker進程可以使用swoole_server_task函數向task_worker進程投遞新的任務(此處使用的是taskwait)
 * 當前的Task進程在調用onTask回調函數時會將進程狀態切換爲忙碌，這時將不再接收新的Task，當onTask函數返回時會將進程狀態切換爲空閒然後繼續接收新的Task。
 * @param: $ws swoole_websocket_server object
 * @param: $tid task process id
 * @param: $wid from id 表示來自哪個Worker進程。$task_id和$wid組合起來纔是全局唯一的，不同的worker進程投遞的任務ID可能會有相同
 * @param: $data 需要執行的任務內容
 * 注意點: onTask函數執行時遇到致命錯誤退出，或者被外部進程強制kill，當前的任務會被丟棄，但不會影響其他正在排隊的Task
 */
$ws->on('task', function ($ws, $tid, $wid, $data) {
    switch ($data['cmd']) {
        case 'pushToClient': $ret = pushToClientTask($ws, $data['key'], $data['val']); break;
    }
    //1.7.2以上的版本，在onTask函數中 return字符串，表示將此內容返回給worker進程。worker進程中會觸發onFinish函數，表示投遞的task已完成。return的變量可以是任意非null的PHP變量
    return $returnContent;
    //1.7.2以前的版本，需要調用swoole_server->finish()函數將結果返回給worker進程
    // $ws->finish($data);
});
 
/**
 * 當worker進程投遞的任務在task_worker中完成時，task進程會通過$ws->finish()方法將任務處理的結果發送給worker進程。
 * @param: $ws swoole_websocket_server object
 * @param: $tid task_id
 * @param: $data 任務處理後的結果內容
 * 注意點: task進程的onTask事件中沒有調用finish方法或者return結果，worker進程不會觸發onFinish
 *        執行onFinish邏輯的worker進程與下發task任務的worker進程是同一個進程
 */
$ws->on('finish', function($ws, $tid, $data) {
 
});
 
/**
 * TCP客戶端連接關閉後，在worker進程中回調此函數
 * 在函數中可以做一些類似於刪除業務中與每個客戶端交互時存放的數據的操作
 * @param: $ws swoole_websocket_server object
 * @param: $fd 已關閉的fd interger
 * @param: $rid(可選)，來自哪個reactor線程
 * 注意點:
 * 1. onClose回調函數如果發生了致命錯誤，會導致連接泄漏。通過netstat命令會看到大量CLOSE_WAIT狀態的TCP連接
 * 2. 查看命令netstat -anopc | grep 端口號,可以查看到TCP接收和發送隊列是否有堆積以及TCP連接的狀態
 * 3. 無論由客戶端發起close還是服務器端主動調用$serv->close()關閉連接，都會觸發此事件。因此只要連接關閉，就一定會回調此函數
 * 4. 1.7.7+版本以後onClose中依然可以調用connection_info方法獲取到連接信息，在onClose回調函數執行完畢後纔會調用close關閉TCP連接
 * 5. 這裏回調onClose時表示客戶端連接已經關閉，所以無需執行$server->close($fd)。代碼中執行$serv->close($fd)會拋出PHP錯誤告警。也就是在onclose中不能再$ws->close()了.
 * 6. swoole-1.9.7版本修改了$reactorId參數，當服務器主動關閉連接時，底層會設置此參數爲-1，可以通過判斷$reactorId < 0來分辨關閉是由服務器端還是客戶端發起的(debug時可以使用)
 */
$ws->on('close', function ($ws, $fd) {
    $redis = new Redis();
    $redis->connect(REDIS_HOST, REDIS_PORT);
    $redis->auth(REDIS_PWD);
    $sArr = $redis->sMembers(REDIS_FD_S.$fd);
    if (!empty($sArr)) {
        foreach ((array)$sArr as $key => $sc) {
            $res = $redis->sRem(REDIS_S_FD.$sc, $fd);
            $num = $redis->sCard(REDIS_S_FD.$sc);
            if ($num == '0') {
                $redis->sRem(REDIS_S_KEY, $sc);
                $redis->hDel(REDIS_ZS_KEY, $sc);
            }
        }
    }
    $redis->del(REDIS_FD_S.$fd);
    $redis->close();
    echo "FD $fd has closed.\n";
});
 
/**
 * 開啓swoole_websocket_server服務
 */
$ws->start();
 
 
/**
 * 接受到消息以後進行響應異步任務的執行
 * @param: $ws swoole_websocket_sever object
 * @param: $frame swoole_websocket_frame obejct
 */
function handleClientData($ws, $frame) {
    $data = $frame->data;
    $redis = new Redis();
    $redis->connect(REDIS_HOST, REDIS_PORT);
    $redis->auth(REDIS_PWD);
    $isMembers = $redis->sIsmember(REDIS_S_FD.$sc, $frame->fd);
    if (!$isMembers) {
        $res = $redis->sAdd(REDIS_S_FD.$sc, $frame->fd);
    }
    $redis->sAdd(REDIS_FD_S.$frame->fd, $sc);
    $isMembers = $redis->sIsmember(REDIS_S_KEY, $sc);
    if (!$isMembers) {
        $redis->sAdd(REDIS_S_KEY, $sc);
    }
}
 
 
/**
 * redis訂閱後的回調函數
 * @param: $ins instance實例
 * @param: $pattern 匹配模式
 * @param: $channel 頻道名
 * @param: $data 數據
 * 注意點: subscribe和psubscribe兩種不同的訂閱方式的回調函數的參數個數不一樣，後者多了$pattern參數
 */
function sendTask($ins, $pattern, $channel, $data) {
    //滿足一些條件後，投遞到task進程中進行推送
    $taskData = array(
        'cmd' => 'pushToClient',
        'key' => $sc,
        'val' => $data,
    );
    //請注意，taskwait是同步阻塞的，所以改腳本並不是全異步非阻塞的
    $GLOBALS['ws']->taskwait($taskData);
}
 
/**
 * 推送消息到指定的客戶端
 * @param: $ws swoole_websocket_server object
 * @param: $sc 股票代碼
 * @param: $data 要推送的數據
 */
function pushToClientTask($ws, $sc, $data) {
    $redis = new Redis();
    $redis->connect(REDIS_HOST, REDIS_PORT);
    $redis->auth(REDIS_PWD);
    $fdList = $redis->sMembers(REDIS_S_FD.$sArr[4]);
    if (!empty($fdList)) {
        foreach ((array)$fdList as $fd) {
            $res = $GLOBALS['ws']->push($fd, $data);
            echo "FD: $fd push $res.\n";
            if (!$res) { //推送失敗，即客戶端已經斷開連接
                //從該fd訂閱的所有股票中刪除該fd
                $sArrOfFd = $redis->sMembers(REDIS_FD_S.$fd);
                if (!empty($sArrOfFd)) {
                    foreach ((array)$sArrOfFd as $key => $sc) {
                        $res = $redis->sRem(REDIS_S_FD.$sc, $fd);
                        $num = $redis->sCard(REDIS_S_FD.$sc);
                        if ($num == '0') {
                            $redis->sRem(REDIS_S_KEY, $sc);
                            $redis->hDel(REDIS_ZS_KEY, $sc);
                        }
                    }
                }
                $redis->del(REDIS_FD_S.$fd);
            }
        }
    }
    $redis->close();
}