社区首页 >专栏 >PHP平滑关闭/重启的实现代码

PHP平滑关闭/重启的实现代码

很酷的站长

发布于 2022-12-02 09:09:43

1K00

代码可运行

文章被收录于专栏：站长的编程笔记站长的编程笔记

运行总次数：0

代码可运行

本文为小伙伴们带来了关于PHP平滑关闭/重启的实现代码，

前言

写过 CLI 常驻进程的老司机肯定遇到过这么一个问题：在需要更新程序的时候，我要怎样才能安全关闭老进程？你可能会想到 NGINX、php-fpm 之类的平滑重启是给进程发送 USR2 信号，然后它就会将当前请求处理完再退出。

但进程是怎样接收信号、处理信号，估计就不是很多人能说清楚了。

原理

要实现平滑关闭/重启不难，这里先讲解两个知识点：

阻塞信号

当我们的程序正在处理一个任务的时候，你肯定不希望它中途被终止，比如说你在执行一个数据库事务，肯定不希望事务还没被提交进程就被终止了。

<!--?php
echo "开始执行事务" . PHP_EOL;
// 模拟一些耗时的操作
$finish_time = time() + 5;
while (time() < $finish_time) {
}
echo "事务执行完毕" . PHP_EOL;</pre-->

上面这段代码，如果你在第二个 echo 之前用 kill 命令去杀死这个进程，那么第二个 echo 就不会被执行了。那能不能做到在事务过程中暂时先忽略 kill 信号呢？

能。我们可以使用 pcntl_sigprocmask() 来阻塞信号，让事务完成之后再响应 kill 信号。

<!--?php
 
// 阻塞信号
$sig_set = array(SIGINT, SIGTERM); // 要阻塞的信号集合
pcntl_sigprocmask(SIG_BLOCK, $sig_set); // SIG_BLOCK: 把信号加入到当前阻塞信号中
 
echo date("[Y-m-d H:i:s]") . " 开始执行事务" . PHP_EOL;
 
$finish_time = time() + 5;
while (time() < $finish_time) {
}
 
echo date("[Y-m-d H:i:s]") . "事务执行完毕" . PHP_EOL;
 
pcntl_sigprocmask(SIG_UNBLOCK, $sig_set); // SIG_UNBLOCK: 从当前阻塞信号中移出信号</pre-->

同样的，在第二个 echo 之前按下 Ctrl + C 或者用 kill 命令去杀这个进程，你会发现第二个 echo 正常执行了，并且两条输出的时间间隔是 5 秒。

我们的常驻进程通常是在一个 while(true) 循环中去执行重复的任务，如果这么写的话：

<!--?php
while (true) {
    pcntl_sigprocmask(SIG_BLOCK, $sig_set);
    // ...
    pcntl_sigprocmask(SIG_UNBLOCK, $sig_set);
}</pre-->

我们是可以保证一个事务不会被打断，但是我们的程序还不知道是不是已经接收到信号了，并且把阻塞信号移除之后进程立刻就退出了，没办法去做一些收尾工作（比如关闭文件）。

处理信号

为了解决上面提到的问题，我们需要在信号发生的时候去做收尾工作，然后再退出进程。

pcntl 扩展提供了一些信号相关的函数，我们可以使用 pcntl_signal() 和 pcntl_signal_dispatch() 来注册信号处理器和分发信号。

<!--?php
$sig_handler = function ($signo) {
    echo "收到信号 {$signo}" . PHP_EOL;
};
pcntl_signal(SIGINT, $sig_handler); // 给 SIGINT 信号注册一个处理器
 
// 模拟耗时操作
echo "开始执行事务" . PHP_EOL;
$finish_time = time() + 5;
while(true) {
    if (time() --> $finish_time) {
        echo "事务执行完毕" . PHP_EOL;
        break;
    }
}
pcntl_signal_dispatch(); // 分发信号

执行上面这段代码并在 5 秒内按下 Ctrl + C，你会看到 sig_handler 被执行了；而如果不按下 Ctrl + C，那么 sig_handler 就不会被执行。

到这里你应该已经理解了 pcntl_signal() 和 pcntl_signal_dispatch() 的用法了，把它放到到刚刚的代码试试

<!--?php
 
$sig_handler = function ($signo) {
    echo "收到信号 {$signo}" . PHP_EOL;
};
$sig_set = array(SIGINT, SIGTERM);
foreach ($sig_set as $sig) {
    pcntl_signal($sig, $sig_handler); // 注册多个信号
}
 
// [1]
 
while (true) {
    // [2-1]
    pcntl_sigprocmask(SIG_BLOCK, $sig_set);
    // [2-2]
 
    // ...
 
    // [2-3]
    pcntl_sigprocmask(SIG_UNBLOCK, $sig_set);
    // [2-4]
}
 
// [3]</pre-->

pcntl_signal_dispatch() 该放哪里呢？是 [1] [2] 还是 [3]？先动手试一下

然后你会发现，只有放在 [2] 才能让信号处理器执行。同时这个实验也告诉我们 pcntl_signal_dispatch() 要在信号发生后才会使处理器执行：放在 [1] 时，除非你手速足够快，不然在你按下 Ctrl + C 或者是 kill 之前就已经执行过了；而放在 [3] 它就永远没机会执行。

至于放在 [2] 的哪个位置，我建议是放在 [2-4]，因为这个时候已经处理完任务了。

拼起来

到这里你已经了解平滑关闭/重启的原理了，我们把上面的半成品代码（因为在收到信号后可能还会进入下一层循环）整理一下：

<!--?php
 
$running = true;
 
$sig_handler = function ($signo) use (&$running) {
    echo "收到信号 {$signo}" . PHP_EOL;
    // 做收尾工作
    $running = false;
};
$sig_set = array(SIGINT, SIGTERM, SIGUSR2 /* 熟悉的 USR2 信号不能漏 */);
foreach ($sig_set as $sig) {
    pcntl_signal($sig, $sig_handler); // 注册多个信号
}
 
 
while ($running) {
    pcntl_sigprocmask(SIG_BLOCK, $sig_set);
 
    // ... 业务逻辑
 
    pcntl_sigprocmask(SIG_UNBLOCK, $sig_set);
    pcntl_signal_dispatch();
}</pre-->