编写 PHP 守护进程程序

守护进程(daemon),又称为常驻后台进程。该进程持续在后台运行,处理系统业务。它没有控制终端,不与前台交互。要么手动杀死该进程,要么系统关闭的时候被关闭。通常在小项目当中 PHP 没有此类需求。都是通过编写定时脚本来执行。

今天,我们以完成异步发送短信来编写 PHP 守护进程程序。会讲到编写守护进程程序中会遇到的一些问题。以及这些问题的解决方案。

一、PHP CLI 模式

PHP CLI 即 命令行模式。这是编写常驻后台程序必须掌握的知识点。关于 PHP CLI 相关的技术细节。可以查看博主之前写的一篇文章《PHP 命令行模式》

我们主要用了 PHP CLI 模式的运行 PHP 脚本的功能。

如:

$ php test.php

二、实例代码

为了避免空洞的理论。我们直接上代码,然后对代码进行抽丝剥茧般分析。再一步一步优化代码,达到我们要求的守护进程级别。

首先,我们要理解异步发送短信的需求涉及的流程。

(1)用户登录/注册等需求短信验证码的位置。点击获取验证码。

(2)服务器收到用户的发送短信请求。将手机号码以及待发送的短信内容放入 Redis 队列。

(3)后台进程持续监听 Redis 队列当中是否有待处理的短信发送。有则发送。无则持续监听。

通过这三步,我们清晰知道。这个异步短信发送的需求会涉及到三个技术点:

(1)队列:存储待发送短信的数据。

(2)把用户短信发送请求写入队列。

(3)从 Redis 队列取出数据进行短信发送。

假设我们的 Redis 队列名称为:sms_list

则写入队列的程序如下:

PushQueue.php 脚本代码如下:

<?php
$redis = new \Redis();
$redis->connect('127.0.0.1', 6379);
$redis->select(1);

$sms = [
    'mobile'  => '14800001234',
    'content' => '您的验证码为:888888。请及时使用,10 分钟后失效。【IT访谈】'
];

$ok = $redis->lPush('sms_list', json_encode($sms, JSON_UNESCAPED_UNICODE));
if ($ok) {
    echo "写入短信队列 sms_list 成功\n";
}

SmsConsume.php 后台消费进程代码如下:

<?php
$redis = new \Redis();
$redis->connect('127.0.0.1', 6379);
$redis->select(1);

$queueKey = 'sms_list';     // 短信队列。
$queueIng = 'sms_list_ing'; // 短处中的队列。

while (true) {
    $content = $redis->bRPopLPush($queueKey, $queueIng, 60);
    if (!empty($content)) {
        $arrCxt = json_decode($content, true);
        /**
         * 调用短信发送接口。
         * 由于是演示代码,此处直接打印输出即可。
         * 真实场景请调用短信发送的接口。
         */
        echo "mobile:{$arrCxt['mobile']}\n";
        echo "content:{$arrCxt['content']}\n\n";
    } else {
        // 暂停 0.1 秒。
        usleep(100000);
    }
}

启动生产端/消费端

(1)启动消费端

$ php SmsConsume.php

启动完成之后,命令终端会一直等待数据写入 Redis 队列。接下来,我们运行生产端往 Redis 队列写入数据。

(2)启动生产端

我们另起一个命令终端执行如下命令:

$ php PushQueue.php

运行成功会输出如下内容:

写入短信队列 sms_list 成功

说明,我们已经成功向 Redis sms_list 队列写入了短信发送的数据。

同时,在我们的消费端命令终端输出了如下内容:

mobile:14800001234
content:您的验证码为:888888。请及时使用,10 分钟后失效。【IT访谈】

问题与缺点:

(1)Redis 读取数据错误

在运行消费端 SmsConsume.php 程序的时候,如果我们的生产端超过 60 秒没有向队列写入数据。消费端在空闲 60 秒之后,会提示类似错误:

...... Uncaught RedisException: read error on connection ......

错误分析:

之所以出现这个错误。是因为在我们的 PHP 配置里面默认限制了一个 socket 连接在 60 秒内没有任何操作就会断开。断开的 socket 连接再去读取数据肯定会报错。此错误依然会出现在 MySQL、Kafka、Memcache 等 socket 连接的系统。

解决方案:

知道了问题所在,剩下的就是更改 PHP 这个默认的配置。

default_socket_timeout = 60

虽然,我们可以直接在 php.ini 文件中修改此值。但是,我们不建议这样做。因为,这个配置不仅会影响 PHP CLI 模式,同时也会影响 PHP CGI 模式(Web 访问)。所以,我们只推荐在代码当中修改。

我们修改 SmsConsume.php 脚本代码之后如下:

<?php

// 防止 Socket 连接空闲超时退出报错。
ini_set('default_socket_timeout', -1);

$redis = new \Redis();
$redis->connect('127.0.0.1', 6379);
$redis->select(1);

$queueKey = 'sms_list';     // 短信队列。
$queueIng = 'sms_list_ing'; // 短处中的队列。

while (true) {
    $content = $redis->bRPopLPush($queueKey, $queueIng, 60);
    if (!empty($content)) {
        $arrCxt = json_decode($content, true);
        /**
         * 调用短信发送接口。
         * 由于是演示代码,此处直接打印输出即可。
         * 真实场景请调用短信发送的接口。
         */
        echo "mobile:{$arrCxt['mobile']}\n";
        echo "content:{$arrCxt['content']}\n\n";
    } else {
        // 暂停 0.1 秒。
        usleep(100000);
    }
}

通过这样修改之后,我们再去运行这个脚本。就会发现不再出现这个错误了。

(2)代码报错进程退出

因为会发生类似 Redis 读取数据错误或其他 PHP 错误。此时,PHP 消费端进程就会终止执行。如果我们把这个消费端程序设置为后端运行的守护进程。这显然是不满足常驻后台运行的目的。

所以,我们需要捕获这些错误。然后写日志或打印到命令行终端。

解决方案:

PHP 提供了 try catch 来解决异常。但是,有时候,PHP 并只是抛出异常,也有可能抛出 Notice、warning 等错误。此时,我们最好的做法是把这些错误转成异常来处理。

在很多成熟的框架都已经将错误转成异常来处理了。所以,我们唯一要做的就是使用 try catch 来捕获异常就行了。

SmsConsume.php 脚本修改之后的代码如下:

<?php

// 防止 Socket 连接空闲超时退出报错。
ini_set('default_socket_timeout', -1);

$redis = new \Redis();
$redis->connect('127.0.0.1', 6379);
$redis->select(1);

$queueKey = 'sms_list';     // 短信队列。
$queueIng = 'sms_list_ing'; // 短处中的队列。

while (true) {
    try {
        $content = $redis->bRPopLPush($queueKey, $queueIng, 60);
        if (!empty($content)) {
            $arrCxt = json_decode($content, true);
            /**
             * 调用短信发送接口。
             * 由于是演示代码,此处直接打印输出即可。
             * 真实场景请调用短信发送的接口。
             */
            echo "mobile:{$arrCxt['mobile']}\n";
            echo "content:{$arrCxt['content']}\n\n";
        } else {
            // 暂停 0.1 秒。
            usleep(100000);
        }
    } catch (\Exception $e) {
        echo "出错了!\n";
        echo "ErrorMsg:" . $e->getMessage() . "\n\n";
    } catch (\Throwable $e) {
        echo "出错了!\n";
        echo "ErrorMsg:" . $e->getMessage() . "\n\n";
    }
}

三、设置消费端为后台运行

我们现在程序已经写好了。现在就需要将程序设置为后台运行。设置为后台运行的方案有很多种。

(1)Linux nohup 命令

关于该命令如何使用,大家可以通过 Google 搜索得到相当全的资料。这里就不用去 Google 搬运了。

(2)Supervisor 管理

这是本博主寒冰推荐的方式。Supervisor 是一款非常优秀的进程管理工具。关于如何使用,可以查看我之前写的一篇文章:CentOS7 安装和使用 Supervisor 工具 。非常详尽怎样使用 Supervisor 这款工具。

四、总结

本篇文章只是一个精简版的守护进程程序。核心的点都已经涉及到。技术的细节方面还需要结合实际的业务进行考量。如果,你在使用本篇文章提到的相关功能时有任何问题,可以留言或者加群(168159147)咨询。谢谢!

博主 2011 年创建了一个《PHP 初学者官方群》,目前群成员 500 人左右。群号:168159147。为了防止广告,设置为付费入群。欢迎大家加入讨论技术!

标签: 无

精彩评论
  1. 我也写了一篇,https://www.fanhaobai.com/2018/08/process-php-basic-knowledge.html#守护进程

    1. 你的文章理论更多一些。我这篇可以落地到实践。各有千秋。可以作为理论版本补充阅读。

发表评论: