Swoole从入门到入土(22)——多进程[Process]

Swoole中的Process模块比原生php提供的pcntl模块，提供了更易用的多进程编程接口。 简单总结，Process模块有如下特点：

· 可以方便的实现进程间通讯
· 支持重定向标准输入和输出，在子进程内 echo 不会打印屏幕，而是写入管道，读键盘输入可以重定向为管道读取数据
· 提供了 exec 接口，创建的进程可以执行其他程序，与原 PHP 父进程之间可以方便的通信
· 在协程环境中无法使用 Process 模块，可以使用 runtime hook+proc_open 实现，参考协程进程管理

让我们先看一下例子：创建 3 个子进程，主进程用 wait 回收进程，主进程异常退出时，子进程会继续执行，完成所有任务后退出

use SwooleProcess;

for ($n = 1; $n <= 3; $n++) {
    $process = new Process(function () use ($n) {
        echo 'Child #' . getmypid() . " start and sleep {$n}s" . PHP_EOL;
        sleep($n);
        echo 'Child #' . getmypid() . ' exit' . PHP_EOL;
    });
    $process->start();
}
for ($n = 3; $n--;) {
    $status = Process::wait(true);
    echo "Recycled #{$status['pid']}, code={$status['code']}, signal={$status['signal']}" . PHP_EOL;
}
echo 'Parent #' . getmypid() . ' exit' . PHP_EOL;

关于上面使用的Process成员属性或函数看不懂？不用着急，现在我们就一一进行讨论。

属性

1) pid：子进程的pid

SwooleProcess->pid: int

2) pipe：unixSocket 的文件描述符。

SwooleProcess->pipe;

方法

1) __contruct()：构造方法

SwooleProcess::__construct(callable $function, bool $redirect_stdin_stdout = false, int $pipe_type = SOCK_DGRAM, bool $enable_coroutine = false);

$function：子进程创建成功后要执行的函数【底层会自动将函数保存到对象的 callback 属性上。如果希望更改执行的函数，可赋值新的函数到对象的 callback 属性】

$redirect_stdin_stdout：重定向子进程的标准输入和输出。【启用此选项后，在子进程内输出内容将不是打印屏幕，而是写入到主进程管道。读取键盘输入将变为从管道中读取数据。默认为阻塞读取。】 

$pipe_type：unixSocket 类型【启用 $redirect_stdin_stdout 后，此选项将忽略用户参数，强制为 1。如果子进程内没有进程间通信，可以设置为 0】，可选值如下：

$enable_coroutine：在 callback function 中启用协程，开启后可以直接在子进程的函数中使用协程 API。

2) set()：设置参数

SwooleProcess->set(array $settings)

可以使用 enable_coroutine 来控制是否启用协程，和构造函数的第四个参数作用一致。

SwooleProcess->set(['enable_coroutine' => true]);

3) start()：执行 fork 系统调用，启动子进程。在 Linux 系统下创建一个进程需要数百微秒时间。

SwooleProcess->start(): int|false

返回值：成功返回子进程的 PID。失败返回 false。可使用 swoole_errno 和 swoole_strerror 得到错误码和错误信息。

注意：

子进程会继承父进程的内存和文件句柄

子进程在启动时会清除从父进程继承的 EventLoop、Signal、Timer

4) exportSocket()：将 unixSocket 导出为 CoroutineSocket 对象，然后利用 Coroutinesocket 对象的方法进程间通讯。

SwooleProcess->exportSocket(): SwooleCoroutineSocket|false

返回值：成功返回 CoroutineSocket 对象。进程未创建 unixSocket，操作失败，返回 false

注意：

多次调用此方法，返回的对象是同一个；

exportSocket() 导出的 socket 是一个新的 fd，当关闭导出的 socket 时不会影响进程原有的管道。

由于是 CoroutineSocket 对象，必须在协程容器中使用，所以 SwooleProcess 构造函数 $enable_coroutine 参数必须为 true。

同样的父进程想用 CoroutineSocket 对象，需要手动 Co un() 以创建协程容器。

示例：

use SwooleProcess;

$proc1 = new Process(function (Process $proc) {
    $socket = $proc->exportSocket();
    echo $socket->recv();
    $socket->send("hello master
");
    echo "proc1 stop
";
}, false, 1, true);

$proc1->start();

//父进程创建一个协程容器
Co
un(function() use ($proc1) {
    $socket = $proc1->exportSocket();
    $socket->send("hello pro1
");
    var_dump($socket->recv());
});
Process::wait(true);

 注意：默认类型是 SOCK_STREAM，需要处理粘包问题，参考 Coroutinesocket 的 setProtocol() 方法。使用 SOCK_DGRAM 类型进行 IPC 通讯，可以避免处理粘包问题。

示例：

use SwooleProcess;

//IPC通讯即使是 SOCK_DGRAM 类型的socket也不需要用 sendto / recvfrom 这组函数，send/recv即可。
$proc1 = new Process(function (Process $proc) {
    $socket = $proc->exportSocket();
    while (1) {
        var_dump($socket->send("hello master
"));
    }
    echo "proc1 stop
";
}, false, 2, 1);//构造函数pipe type传为2 即SOCK_DGRAM

$proc1->start();

Co
un(function() use ($proc1) {
    $socket = $proc1->exportSocket();
    Co::sleep(5);
    var_dump(strlen($socket->recv()));//一次recv只会收到一个"hello master
"字符串 不会出现多个"hello master
"字符串
});

Process::wait(true);

5) name()：修改进程名称。此函数是 swoole_set_process_name 的别名。

SwooleProcess->name(string $name): bool

注意：在执行 exec 后，进程名称会被新的程序重新设置；name 方法应当在 start 之后的子进程回调函数中使用。

6) exec()：执行一个外部程序，此函数是 exec 系统调用的封装。

SwooleProcess->exec(string $execfile, array $args);

$execfile：指定可执行文件的绝对路径，如 "/usr/bin/python"。必须使用绝对路径，否则会报文件不存在错误。

$args：exec 的参数列表【如 array('test.py', 123)，相当于 python test.py 123】

注意：由于 exec 系统调用会使用指定的程序覆盖当前程序，子进程需要读写标准输出与父进程进行通信；如果未指定 redirect_stdin_stdout = true，执行 exec 后子进程与父进程无法通信。

示例1：

$process = new SwooleProcess('callback_function', true);

$pid = $process->start();

function callback_function(SwooleProcess $worker)
{
    $worker->exec('/usr/local/bin/php', array(__DIR__.'/swoole_server.php'));
}

SwooleProcess::wait();

示例2：父进程与子进程exec通信

// exec - 与exec进程进行管道通信
use SwooleProcess;

$process = new Process(function (Process $worker) {
    $worker->exec('/bin/echo', ['hello']);
}, true, 1, true); // 需要启用标准输入输出重定向

$process->start();

Co
un(function() use($process) {
    $socket = $process->exportSocket();
    echo "from exec: " . $socket->recv() . "
";
});

示例3：执行shell

$worker->exec('/bin/sh', array('-c', "cp -rf /data/test/* /tmp/test/"));

7) close()：用于关闭创建的好的 unixSocket。

SwooleProcess->close(int $which): bool

$which：由于 unixSocket 是全双工的，指定关闭哪一端【默认为 0 表示同时关闭读和写，1：关闭写，2 关闭读】

注意：有一些特殊的情况 Process 对象无法释放，如果持续创建进程会导致连接泄漏。调用此函数就可以直接关闭 unixSocket，释放资源。

8) exit()：退出子进程。

SwooleProcess->exit(int $status = 0);

$status：退出进程的状态码【如果为 0 表示正常结束，会继续执行清理工作】

注意事项：

清理工作包括：PHP 的 shutdown_function、对象析构（__destruct）、其他扩展的 RSHUTDOWN 函数

如果 $status 不为 0，表示异常退出，会立即终止进程，不再执行相关进程终止的清理工作。

在父进程中，执行 Process::wait 可以得到子进程退出的事件和状态码。

9) kill()：向指定 pid 进程发送信号。

SwooleProcess::kill(int $pid, int $signo = SIGTERM): bool

$pid：进程pid

$signo：发送的信号【$signo=0，可以检测进程是否存在，不会发送信号】

10) signal()：设置异步信号监听。

SwooleProcess::signal(int $signo, callable $callback): bool

$signo：信号

$callback：回调函数【$callback 如果为 null，表示移除信号监听】

注意：

此方法基于 signalfd 和 EventLoop 是异步 IO，不能用于阻塞的程序中，会导致注册的监听回调函数得不到调度；

同步阻塞的程序可以使用 pcntl 扩展提供的 pcntl_signal；

如果已设置了此信号的回调函数，重新设置时会覆盖历史设置。

在 SwooleServer 中不能设置某些信号监听，如 SIGTERM 和 SIGALAM。

如果进程的 EventLoop 中只有信号监听的事件，没有其他事件 (例如 Timer 定时器等)，进程会直接退出。

示例1：

SwooleProcess::signal(SIGTERM, function($signo) {
     echo "shutdown.";
});

示例2：

//以下程序不会进入 EventLoop，SwooleEvent::wait() 将立即返回，并退出进程。
SwooleProcess::signal(SIGTERM, function($signo) {
     echo "shutdown.";
});
SwooleEvent::wait();

11) wait()：回收结束运行的子进程。

SwooleProcess::wait(bool $blocking = true): array|false

$blocking：指定是否阻塞等待【默认为阻塞】

返回值：操作成功会返回一个数组包含子进程的 PID、退出状态码、被哪种信号 KILL；失败返回 false

注：推荐使用协程版本的 SwooleCoroutineSystem::wait()

注意事项：

每个子进程结束后，父进程必须都要执行一次 wait() 进行回收，否则子进程会变成僵尸进程，会浪费操作系统的进程资源。

如果父进程有其他任务要做，没法阻塞 wait 在那里，父进程必须注册信号 SIGCHLD 对退出的进程执行 wait。

SIGCHILD 信号发生时可能同时有多个子进程退出；必须将 wait() 设置为非阻塞，循环执行 wait 直到返回 false。

示例：

<?php
use SwooleProcess;

for($i=1;$i<=3;$i++)
{
    $process=new Process(function() use ($i){
        SwooleTimer::tick(1000, function ()  {
            echo "child timer:",getmypid(),PHP_EOL;
        });
    },false,1,true);
    $process->start();
}

Process::signal(SIGCHLD, static function ($sig) {
    while ($ret = Process::wait(false)) {
        echo "PID={$ret['pid']}
";
    }
});

//这里很重要，要注意：Timer::tick必须存在（即后面的操作必须是异步操作，否能是同步操作）
SwooleTimer::tick(2000, function () {
    echo "parent timer
";
});

12) daemon()：使当前进程蜕变为一个守护进程。

SwooleProcess::daemon(bool $nochdir = true, bool $noclose = true): bool

$nochdir：是否切换当前目录到根目录【为 true 表示不要切换当前目录到根目录】

$noclose：是否要关闭标准输入输出文件描述符【为 true 表示不要关闭标准输入输出文件描述符】

注意：蜕变为守护进程时，该进程的 PID 将发生变化，可以使用 getmypid() 来获取当前的 PID

13) alarm()：高精度定时器，是操作系统 setitimer 系统调用的封装，可以设置微秒级别的定时器。定时器会触发信号，需要与 Process::signal 或 pcntl_signal 配合使用。

SwooleProcess::alarm(int $time, int $type = 0): bool

$time：定时器间隔时间【如果为负数表示清除定时器】，单位：微秒

$type：定时器类型

返回值：设置成功返回 true；失败返回 false，可以使用 swoole_errno 得到错误码。

示例：

SwooleProcess::signal(SIGALRM, function () {
    static $i = 0;
    echo "#{$i}	alarm
";
    $i++;
    if ($i > 20) {
        SwooleProcess::alarm(-1);
    }
});

//100ms
SwooleProcess::alarm(100 * 1000);

注意：alarm 不能和 Timer 同时使用。

14) setAffinity()：设置 CPU 亲和性，可以将进程绑定到特定的 CPU 核上。此函数的作用是让进程只在某几个 CPU 核上运行，让出某些 CPU 资源执行更重要的程序。

SwooleProcess::setAffinity(array $cpus): bool

$cpus：绑定 CPU 核 【如 array(0,2,3) 表示绑定 CPU0/CPU2/CPU3】

注意：

- $cpus 内的元素不能超过 CPU 核数；

- CPU-ID 不得超过（CPU 核数 - 1）；

- 使用 swoole_cpu_num() 可以得到当前服务器的 CPU 核数。

15) setPriority()：设置进程、进程组和用户进程的优先级。

SwooleProcess->setPriority(int $which, int $priority): bool

$witch：决定修改优先级的类型

$priority：优先级。值越小，优先级越高。可选值范围 [-20,20]

返回值：如果返回 false，可使用 swoole_errno 和 swoole_strerror 得到错误码和错误信息。

16) getPriority()：获取进程的优先级。

SwooleProcess->getPriority(int $which): int

进程类的介绍到这里就结束了，下一节我们将进入进程池话题：）

---------------------------  我是可爱的分割线  ----------------------------

最后博主借地宣传一下，漳州编程小组招新了，这是一个面向漳州青少年信息学/软件设计的学习小组，有意向的同学点击链接，联系我吧。