Command Signals

friendsofhyperf/command-signals 為 Hyperf 命令提供基於協程的 POSIX 訊號處理能力。

安裝

composer require friendsofhyperf/command-signals

該元件支援 Hyperf 3.2，並會被自動發現。它的 ConfigProvider 不會發布任何配置。下方 命令示例假設應用已經安裝 hyperf/command；該元件沒有將其宣告為依賴。

實現透過 Hyperf Engine 處理訊號，並呼叫 posix_getpid() 和 posix_kill()。請在支援 POSIX 訊號且可執行協程的 Swoole 或 Swow 環境中使用。PHP POSIX 擴充套件必須提供上述兩個 函式。Composer 建議安裝 ext-swoole >= 4.6.0 或 ext-swow >= 0.1.0，但沒有將 POSIX 擴充套件宣告為依賴。

使用

在命令中引入 InteractsWithSignals，然後呼叫 trap() 並傳入一個訊號編號或訊號編號陣列。 回撥會接收到訊號編號。

namespace App\Command;

use FriendsOfHyperf\CommandSignals\Traits\InteractsWithSignals;
use Hyperf\Command\Annotation\Command;
use Hyperf\Command\Command as HyperfCommand;
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 (int $signo): void {
            $this->warn(sprintf('Received signal %d, exiting...', $signo));
        });

        sleep(10);

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

首次呼叫 trap() 時，它會透過容器建立 SignalRegistry，並在當前協程結束時自動清空回撥。 同一個訊號可以註冊多個回撥；收到該訊號時，這些回撥會併發執行。

每個已註冊訊號只會被處理一次。回撥執行完成後，註冊器會停止等待，並再次向當前程序傳送同一 訊號，因此作業系統通常會執行該訊號的預設動作。

使用 untrap() 清空一個訊號、多個訊號或全部訊號的回撥。它不會取消已經啟動的等待協程； 如果之後收到該訊號，註冊器仍會在不執行回撥後再次向程序傳送該訊號。

$this->untrap(SIGINT);
$this->untrap([SIGINT, SIGTERM]);
$this->untrap();

API

Trait 向命令提供以下受保護方法：

• trap(array|int $signo, callable $callback): void
• untrap(null|array|int $signo = null): void

SignalRegistry 也是公開類。其建構函式為 __construct(int $timeout = 1, int $concurrentLimit = 0)；timeout 是每次等待嘗試的 超時秒數，concurrentLimit 用於限制併發執行的回撥數量，值為 0 表示不限制併發數。它 提供以下方法：

• register(int|array $signo, callable $signalHandler): void
• unregister(null|int|array $signo = null): void

unregister() 會清空所選訊號的回撥；傳入 null 會清空全部回撥。

執行

• 按下 Ctrl + C 傳送 SIGINT。

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

• 傳送 SIGTERM，例如使用 killall php。

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