vyants / yii2-daemon
该扩展提供了简单守护进程创建和控制的功能
0.1
2016-03-17 15:31 UTC
Requires
- ext-pcntl: *
- ext-posix: *
- yiisoft/yii2: *
This package is not auto-updated.
Last update: 2024-09-14 13:48:56 UTC
README
该扩展提供了简单守护进程创建和控制的功能
安装
安装此扩展的首选方式是通过 composer。
运行以下命令之一
php composer.phar require --prefer-dist vyants/yii2-daemon "*"
或者在您的 composer.json
文件的 require 部分添加
"vyants/yii2-daemon": "*"
...
设置 WatcherDaemon
WatcherDaemon 是主守护进程,并提供默认功能。该守护进程检查其他守护进程并运行,如果需要。请按照以下步骤操作
- 在您的控制台控制器路径下创建名为 WatcherDaemonController.php 的文件,并包含以下内容
<?php
namespace console\controllers;
class WatcherDaemonController extends \vyants\daemon\controllers\WatcherDaemonController
{
/**
* @return array
*/
protected function defineJobs()
{
sleep($this->sleep);
//TODO: modify list, or get it from config, it does not matter
$daemons = [
['className' => 'OneDaemonController', 'enabled' => true],
['className' => 'AnotherDaemonController', 'enabled' => false]
];
return $daemons;
}
}
- 没有人检查 Watcher。Watcher 应该持续运行。将其添加到您的 crontab 中
* * * * * /path/to/yii/project/yii watcher-daemon --demonize=1
Watcher 不能同时启动两次,只能有一个实例在某一时刻工作。
用法
创建新的守护进程
- 在您的控制台控制器路径下创建名为 {NAME}DaemonController.php 的文件,并包含以下内容
<?php
namespace console\controllers;
use \vyants\daemon\DaemonController;
class {NAME}DaemonController extends DaemonController
{
/**
* @return array
*/
protected function defineJobs()
{
/*
TODO: return task list, extracted from DB, queue managers and so on.
Extract tasks in small portions, to reduce memory usage.
*/
}
/**
* @return jobtype
*/
protected function doJob($job)
{
/*
TODO: implement you logic
Don't forget to mark task as completed in your task source
*/
}
}
- 实现逻辑。
- 将新守护进程添加到 Watcher 中的守护进程列表。
与 RabbitMQ 一起使用(此示例需要 "videlalvaro/php-amqplib" 包)
<?php
namespace console\controllers\daemons;
use console\components\controllers\BaseDaemonController;
use PhpAmqpLib\Channel\AMQPChannel;
use PhpAmqpLib\Connection\AMQPStreamConnection;
use PhpAmqpLib\Message\AMQPMessage;
/**
* Class SomeRabbitQueueController
*/
class SomeRabbitQueueController extends BaseDaemonController
{
/**
* @var $connection AMQPStreamConnection
*/
protected $connection;
/**
* @var $connection AMQPChannel
*/
protected $channel;
/**
* @return array|bool
*/
protected function defineJobs()
{
$channel = $this->getQueue();
while (count($channel->callbacks)) {
try {
$channel->wait(null, true, 5);
} catch (\PhpAmqpLib\Exception\AMQPTimeoutException $timeout) {
} catch (\PhpAmqpLib\Exception\AMQPRuntimeException $runtime) {
\Yii::error($runtime->getMessage());
$this->channel = null;
$this->connection = null;
}
}
return false;
}
/**
* @param AMQPMessage $job
* @return bool
* @throws NotSupportedException
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function doJob($job)
{
$result = false;
//do somethink here and set $result
if ($result) {
$this->ask($job);
} else {
$this->nask($job);
}
return $result;
}
/**
* @return AMQPChannel
* @throws InvalidParamException
*/
protected function getQueue()
{
if ($this->channel == null) {
if ($this->connection == null) {
if (isset(\Yii::$app->params['rabbit'])) {
$rabbit = \Yii::$app->params['rabbit'];
} else {
throw new InvalidParamException('Bad config RabbitMQ');
}
$this->connection = new AMQPStreamConnection($rabbit['host'], $rabbit['port'], $rabbit['user'], $rabbit['password']);
}
$this->channel = $this->connection->channel();
$this->channel->exchange_declare($this->exchange, $this->type, false, true, false);
$args = [];
if ($this->dlx) {
$args['x-dead-letter-exchange'] = ['S', $this->exchange];
$args['x-dead-letter-routing-key'] = ['S',$this->dlx];
}
if ($this->max_length) {
$args['x-max-length'] = ['I', $this->max_length];
}
if ($this->max_bytes) {
$args['x-max-length-bytes'] = ['I', $this->max_bytes];
}
if ($this->max_priority) {
$args['x-max-priority'] = ['I', $this->max_priority];
}
list($queue_name, ,) = $this->channel->queue_declare($this->queue_name, false, true, false, false, false, $args);
foreach ($this->binding_keys as $binding_key) {
$this->channel->queue_bind($queue_name, $this->exchange, $binding_key);
}
$this->channel->basic_consume($queue_name, '', false, false, false, false, [$this, 'doJob']);
}
return $this->channel;
}
/**
* @param $job
*/
protected function ask($job)
{
$job->delivery_info['channel']->basic_ack($job->delivery_info['delivery_tag']);
}
/**
* @param $job
*/
protected function nask($job)
{
$job->delivery_info['channel']->basic_nack($job->delivery_info['delivery_tag']);
}
}
守护进程设置(属性)
在您的守护进程中,您可以覆盖父属性
$demonize
- 如果为 0,则守护进程不以守护进程的形式运行,而仅作为简单的控制台应用程序。这适用于调试。$memoryLimit
- 如果守护进程达到此限制,则守护进程停止工作。这可以防止内存泄漏。在 WatcherDaemon 运行后再次运行此守护进程。$sleep
- 检查新任务之间的延迟,如果任务列表已满,则守护进程不会休眠。$pidDir
- 守护进程 pid 所在的目录$logDir
- 守护进程日志所在的目录$isMultiInstance
- 此选项允许守护进程为每个任务创建自我副本。也就是说,守护进程可以同时执行多个任务。这在需要一些时间和服务器资源来执行多个此类任务时非常有用。$maxChildProcesses
- 只有当$isMultiInstance=true
时。守护进程实例的最大数量。如果达到最大数量,则系统将等待至少一个子进程终止。
如果您想更改日志偏好,可以覆盖 initLogger 函数。例如
/**
* Adjusting logger. You can override it.
*/
protected function initLogger()
{
$targets = \Yii::$app->getLog()->targets;
foreach ($targets as $name => $target) {
$target->enabled = false;
}
$config = [
'levels' => ['error', 'warning', 'trace', 'info'],
'logFile' => \Yii::getAlias($this->logDir) . DIRECTORY_SEPARATOR . $this->shortClassName() . '.log',
'logVars'=>[], // Don't log all variables
'exportInterval'=>1, // Write each message to disk
'except' => [
'yii\db\*', // Don't include messages from db
],
];
$targets['daemon'] = new \yii\log\FileTarget($config);
\Yii::$app->getLog()->targets = $targets;
\Yii::$app->getLog()->init();
// Flush each message
\Yii::$app->getLog()->flushInterval = 1;
}
在 PHP < 5.5.0 上安装 Proctitle
为了能够安装 yii2-daemon,您需要在服务器上安装 proctitle 扩展。对于 Debian 7,您可以使用以下命令
# pecl install channel://pecl.php.net/proctitle-0.1.2
# echo "extension=proctitle.so" > /etc/php5/mods-available/proctitle.ini
# php5enmod proctitle