從0到1優雅的實現PHP多程式管理

TIGERB發表於2019-02-16
PHP
                       _        
                      | |       
_ __   __ _ _ __ _   _| |_ ___  
| `_  / _` | `__| | | | __/ _  
| | | | (_| | |  | |_| | || (_) |
|_| |_|\__,_|_|   \__,_|\__\___/ .TIGERB.cn
            
An object-oriented multi process manager for PHP

Version: 0.1.0

業務場景

在我們實際的業務場景中(PHP技術棧)，我們可能需要定時或者近乎實時的執行一些業務邏輯，簡單的我們可以使用unix系統自帶的crontab實現定時任務，但是對於一些實時性要求比較高的業務就不適用了，所以我們就需要一個常駐記憶體的任務管理工具，為了保證實時性，一方面我們讓它一直執行任務(適當的睡眠，保證cpu不被100%佔用)，另一方面我們實現多程式保證併發的執行任務。

目的

綜上所述，我的目標就是：實現基於php-cli模式實現的master-worker多程式管理工具。其次，“我有這樣一個目標，我是怎樣一步步去分析、規劃和實現的”，這是本文的宗旨。

備註：下文中，父程式統稱為master,子程式統稱為worker。

分析

我們把這一個大目標拆成多個小目標去逐個實現，如下：

  • 多程式

    • 目的：一個master fork多個worker
    • 現象：所有worker的ppid父程式ID為當前master的pid

  • master控制worker

    • 目的：master通知worker，worker接收來自master的訊息

  • master接收訊號

    • 目的：master接收並自定義處理來自終端的訊號

多程式

PHP fork程式的方法 pcntl_fork, 這個大家應該有所瞭解，如果不知道的簡單google/bing一下應該很容易找到這個函式。接著FTM, 我們看看pcntl_fork這個函式的使用方式大致如下：

$pid = pcntl_fork(); // pcntl_fork 的返回值是一個int值
                     // 如果$pid=-1 fork程式失敗
                     // 如果$pid=0 當前的上下文環境為worker
                     // 如果$pid>0 當前的上下文環境為master，這個pid就是fork的worker的pid

接著看程式碼：

$pid = pcntl_fork();    
switch ($pid) {
  case -1:
    // fatal error 致命錯誤 所有程式crash掉
    break;

  case 0:
    // worker context
    exit; // 這裡exit掉，避免worker繼續執行下面的程式碼而造成一些問題
    break;

  default:
    // master context
    pcntl_wait($status); // pcntl_wait會阻塞，例如直到一個子程式exit
    // 或者 pcntl_waitpid($pid, $status, WNOHANG); // WNOHANG:即使沒有子程式exit，也會立即返回
    break;
}

我們看到master有呼叫pcntl_wait或者pcntl_waitpid函式，為什麼呢？首先我們在這裡得提到兩個概念，如下：

  • 孤兒程式：父程式掛了，子程式被pid=1的init程式接管(wait/waitpid)，直到子程式自身生命週期結束被系統回收資源和父程式採取相關的回收操作
  • 殭屍程式：子程式exit退出,父程式沒有通過wait/waitpid獲取子程式狀態，子程式佔用的程式號等描述資源符還存在，產生危害：例如程式號是有限的，無法釋放程式號導致未來可能無程式號可用

所以，pcntl_wait或者pcntl_waitpid的目的就是防止worker成為殭屍程式(zombie process)。

除此之外我們還需要把我們的master掛起和worker掛起，我使用的的是while迴圈，然後usleep(200000)防止CPU被100%佔用。

最後我們通過下圖(1-1)來簡單的總結和描述這個多程式實現的過程：

multi-process.png

master控制worker

上面實現了多程式和多程式的常駐記憶體，那master如何去管理worker呢？答案：多程式通訊。話不多說google/bing一下，以下我列舉幾種方式：

  • 命名管道: 感興趣
  • 佇列: 個人感覺和業務中使用redis做訊息佇列思路應該一致
  • 共享記憶體: 違背“不要通過共享記憶體來通訊，要通過通訊來實現共享”原則
  • 訊號: 承載資訊量少
  • 套接字: 不熟悉

所以我選擇了“命名管道”的方式。我設計的通訊流程大致如下：

  • step 1: 建立worker管道
  • step 2: master寫訊息到worker管道
  • step 3: worker讀訊息從worker管道

接著還是逐個擊破，當然話不多說還是google/bing一下。posix_mkfifo建立命名管道、fopen開啟檔案(管道以檔案形式存在)、fread讀取管道、fclose關閉管道就呼嘯而出，哈哈，這樣我們就能很容易的實現我們上面的思路的了。接著說說我在這裡遇到的問題：fopen阻塞了，導致業務程式碼無法迴圈執行，一想不對啊，平常fopen普通檔案不存在阻塞行為,這時候二話不說FTM搜fopen,crtl+f頁面搜“block”，重點來了：

fopen() will block if the file to be opened is a fifo. This is true whether it`s opened in “r” or “w” mode. (See man 7 fifo: this is the correct, default behaviour; although Linux supports non-blocking fopen() of a fifo, PHP doesn`t).

翻譯下，大概意思就是“當使用fopen的r或者w模式開啟一個fifo的檔案，就會一直阻塞;儘管linux支援非阻塞的開啟fifo，但是php不支援。”，得不到解決方案，不支援，感覺要放棄，一想這種場景應該不會不支援吧，再去看看posix_mkfifo,結果喜出望外：

<?php
  $fh=fopen($fifo, "r+"); // ensures at least one writer (us) so will be non-blocking
  stream_set_blocking($fh, false); // prevent fread / fwrite blocking
?>

The "r+" allows fopen to return immediately regardless of external  writer channel.

結論使用“r+”,同時我們又知道了使用stream_set_blocking防止緊接著的fread阻塞。接著我們用下圖(1-2)來簡單的總結和描述這個master-worker通訊的方式。

pipe.png

master接收訊號

最後我們需要解決的問題就是master怎麼接受來自client的訊號，google/bing結論：

master接收訊號 -> pcntl_signal註冊對應訊號的handler方法 -> pcntl_signal_dispatch() 派發訊號到handler

如下圖(1-3)所示，

signal.png

其他

接著我們只要實現不同訊號下master&worker的策略，例如worker的重啟等。這裡需要注意的就是，當master接受到重啟的訊號後，worker不要立即exit，而是等到worker的業務邏輯執行完成了之後exit。具體的方式就是：

master接收reload訊號 -> master把reload訊號寫worker管道 -> worker讀取到reload訊號 -> worker新增重啟標誌位 -> worker執行完業務邏輯後且檢測到重啟的標誌位後exit

建模

上面梳理完我們的實現方式後，接著我們就開始碼程式碼了。碼程式碼之前進行簡單的建模，如下：

程式管理類Manager

- attributes
  + master: master物件
  + workers: worker程式物件池
  + waitSignalProcessPool: 等待訊號的worker池
  + startNum: 啟動程式數量
  + userPasswd: linux使用者密碼
  + pipeDir: 管道存放路徑
  + signalSupport: 支援的訊號
  + hangupLoopMicrotime: 掛起間隔睡眠時間
- method
  + welcome: 歡迎於
  + configure: 初始化配置
  + fork: forkworker方法
  + execFork: 執行forkworker方法
  + defineSigHandler: 定義訊號handler
  + registerSigHandler: 註冊訊號handler
  + hangup: 掛起主程式

程式抽象類Process

- attributes
  + type: 程式型別 master/worker
  + pid: 程式ID
  + pipeName: 管道名稱 
  + pipeMode: 管道模式
  + pipeDir: 管道存放路徑
  + pipeNamePrefix: 管道名稱字首
  + pipePath: 管道生成路徑
  + readPipeType: 讀取管道資料的位元組數
  + workerExitFlag: 程式退出標誌位
  + signal: 當前接受到的訊號
  + hangupLoopMicrotime: 掛起間隔睡眠時間
- method
  + hangup: 掛起程式(抽象方法)
  + pipeMake: 建立管道
  + pipeWrite: 寫管道
  + pipeRead: 讀管道
  + clearPipe: 清理管道檔案
  + stop: 程式exit

master實體類MasterProcess

- attributes
  + 
- method
  + hangup: 掛起程式

worker實體類MasterProcess

- attributes
  + 
- method
  + dispatchSig: 定義worker訊號處理方式

最後我們需要做的就是優雅的填充我們的程式碼了。

最後

專案地址 https://github.com/TIGERB/naruto

個人知識還有很多不足，如果有寫的不對的地方，希望大家及時指正。

THX~

naruto-zsh.png

掃面下方二維碼關注我的技術公眾號，及時為大家推送我的原創技術分享

圖片描述

相關文章