Hyperf 命令中捕获信号

[huangdijia]

近日看到 Laravel 有一个关于命令中处理信号人 PR（[9.x] Introducing Signal Traps），思考了一下，确实也有这样的需求，就想了一下 Hyperf 的实现思路。

<?php
namespace App\Command\Traits;

use Hyperf\Utils\Coroutine;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
use Swoole\Coroutine as Co;
use TypeError;

trait InteractsWithSignals
{
    protected array $trapCallbacks = [];

    protected array $trapCoroutines = [];

    protected bool $trapStopped = false;

    /**
     * @param int|int[] $signo
     * @throws TypeError
     * @throws NotFoundExceptionInterface
     * @throws ContainerExceptionInterface
     */
    protected function trap(array|int $signo, callable $callback): void
    {
        if (is_array($signo)) {
            array_map(fn ($s) => $this->trap((int) $s, $callback), $signo);
            return;
        }

        if (! isset($this->trapCoroutines[$signo])) {
            if (! $this->trapCallbacks) {
                defer(fn () => $this->trapStopped = true);
            }

            Coroutine::create(function () use ($signo) {
                while (true) {
                    if (Co::waitSignal($signo, 1)) {
                        foreach ((array) $this->trapCallbacks[$signo] as $callback) {
                            $callback($signo);
                        }

                        posix_kill(posix_getpid(), $signo);
                    }

                    if ($this->trapStopped) {
                        break;
                    }

                    // $this->info(sprintf('waiting signal %s in %s', $signo, $cid), 'vvv');
                }
            });
        }

        $this->trapCallbacks[$signo][] = $callback;
    }
}

用法：

<?php
namespace App\Command;

use App\Command\Traits\InteractsWithSignals;
use Hyperf\Command\Annotation\Command;
use Hyperf\Command\Command as HyperfCommand;
use Hyperf\Utils\Coroutine;
use Psr\Container\ContainerInterface;

#[Command]
class FooCommand extends HyperfCommand
{
    use InteractsWithSignals;

    public function __construct(protected ContainerInterface $container)
    {
        parent::__construct('foo');
    }

    public function configure()
    {
        parent::configure();
        $this->setDescription('Hyperf Demo Command');
    }

    public function handle()
    {
        $this->trap([SIGINT, SIGTERM], function ($signo) {
            $this->warn(sprintf('Received signal %d, exiting...', $signo));
        });

        sleep(10);

        $this->info('Bye!');
    }
}

执行效果：

• Ctrl + C

$ hyperf foo
^CReceived signal 2, exiting...

• killall php

$ hyperf foo
Received signal 15, exiting...
[1]    51936 terminated  php bin/hyperf.php foo

[huangdijia]

封装成扩展包（ https://github.com/friendsofhyperf/command-signals ），欢迎 star