Skip to content

Hanxing4598/EasyTask

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
src
src
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 

Repository files navigation

EasyTask -- 原生常驻内存定时任务

运行环境：linux+PHP7.0以上，强烈推荐PHP7.1以上，PHP7.1拥有异步信号管理，不再依赖ticks特性，性能更好。

【一】 安装PHP扩展

  • pcntl(一般默认自带，提供多进程管理能力)
  • posix(一般默认自带，提供进程信息能力)
  • sysvmsg(需要自行安装，提供Linux IPC消息队列能力)
  • 推荐使用宝塔集成环境一键安装php扩展

【二】 Composer安装

  composer require easy-task/easy-task

  "require": {
    "easy-task/easy-task": "*"
  }

【三】 代码案例

3.1 创建一个闭包函数每隔10秒执行一次

//初始化Task对象
$task = new Task();
try
{
    //设置常驻内存
    $task->setDaemon(true);

    //设置闭包函数任务
    $task->addFunction(function () {
        $url = 'https://www.gaojiufeng.cn/?id=243';
        @file_get_contents($url);
    }, 'request', 10, 2);

    //启动任务
    $task->start();
}
catch (\Exception $exception)
{
    //错误输出
    var_dump($exception->getMessage());
}

输出结果:

┌─────┬──────────────────┬─────────────────────┬───────┬────────┬──────┐
│ PID │    TASK_NAME     │       STARTED       │ TIMER │ STATUS │ PPID │
├─────┼──────────────────┼─────────────────────┼───────┼────────┼──────┤
│ 134 │ EasyTask_request │ 2019-07-03 10:13:19 │  10s  │ active │ 133  │
│ 135 │ EasyTask_request │ 2019-07-03 10:13:19 │  10s  │ active │ 133  │
└─────┴──────────────────┴─────────────────────┴───────┴────────┴──────┘

代码解释: addFunction函数第一个参数传递闭包函数，编写自己需要的逻辑，第二个参数是任务的别名，在输出结果中会体现，第三个参数是每隔多少秒执行1次，第四个参数是启动几个进程来执行

3.2 每隔20秒执行一次类的方法(同时支持静态方法)

class Sms
{
    public function send()
    {
        echo 'Success' . PHP_EOL;
    }
}

//初始化Task对象
$task = new Task();
try
{
    //设置常驻内存
    $task->setDaemon(true);

    //设置执行类的方法
    $task->addClass(Sms::class, 'send', 'sendsms', 20, 1);

    //启动任务
    $task->start();
}
catch (\Exception $exception)
{
    //错误输出
    var_dump($exception->getMessage());
}

3.3 同时添加多个定时任务(支持闭包和类混合添加)

//初始化Task对象
$task = new Task();
try
{
    //设置常驻内存
    $task->setDaemon(true);

    //添加执行普通类
    $task->addClass(Sms::class, 'send', 'sendsms1', 20, 1);

    //添加执行静态类
    $task->addClass(Sms::class, 'recv', 'sendsms2', 20, 1);

    //添加执行闭包函数
    $task->addFunction(function () {
        echo 'Success3' . PHP_EOL;
    }, 'fucn', 20, 1);

    //启动任务
    $task->start();
}
catch (\Exception $exception)
{
    //错误输出
    var_dump($exception->getMessage());
}

3.4 使用连贯操作

//初始化Task对象
$task = new Task();
try
{
    $task->setDaemon(true)
        ->setChdir(true)
        ->setInOut(true)
        ->setPrefix('ThinkTask')
        ->addClass(Sms::class, 'send', 'sendsms1', 20, 1)
        ->addClass(Sms::class, 'recv', 'sendsms2', 20, 1)
        ->addFunction(function () {
            echo 'Success3' . PHP_EOL;
        }, 'fucn', 20, 1)
        ->start();
}
catch (\Exception $exception)
{
    //错误输出
    var_dump($exception->getMessage());
}

3.5 查看任务运行状态

//初始化
$task = new Task();

//查看运行状态
$task->status();

3.6 停止运行任务

//初始化
$task = new Task();

//普通停止任务
$task->stop();

//强制停止任务   
//$task->stop(true);

3.7 手工Kill停止任务

  3.7.1 停止所有任务 kill  ppid (ppid每次在输出结果中会输出,ppid是守护进程id,kill掉会终止相关的任务)
  3.7.2 停止单个任务 kill  pid  (pid每次在输出结果中会输出)
  3.7.3 忘记了输出结果怎么查询全部的任务pid, ps aux | grep 守护进程名 ,默认的守护进程名是EasyTask,然后去kill守护进程的进程即可

3.8 函数说明

  3.8.1 setDaemon 是否常驻运行
  3.8.2 setChdir 是否卸载工作区
  3.8.3 setInOut 是否关闭输入输出
  3.8.4 setPrefix 设置任务进程前缀名称,守护进程的名称就是它
  3.8.5 setIpcKey 设置IPC通信Key,除非你懂得怎么设置,否则请不要设置

3.9 整合命令到一个php文件,创建console.php(一般由用户自行封装，这里做个demo)

//实例化Task
$task = new Task();

//提取命令行传参的命令
$argv = $_SERVER['argv'];
if (!empty($argv['1']))
{
    if ($argv['1'] == 'start')
    {
        //启动命令
        $task->setDaemon(true)->addFunction(function () {
            //重复执行的逻辑写在这里
        }, 'request', 15, 1)->start();
    }
    if ($argv['1'] == 'status')
    {
        //状态命令
        $task->status();
    }
    if ($argv['1'] == 'stop')
    {
        //停止命令
        $force = false;
        if (!empty($argv['2']) && $argv['2'] == '-f')
        {
            $force = true;
        }
        $task->stop($force);
    }
}

启动命令: php ./console.php start
状态命令: php ./console.php status
停止命令: php ./console.php stop
停止命令: php ./console.php stop -f (强制停止)

【四】 其他框架整合

4.1 微擎cms

根目录创建console.php, 启动命令: php ./console.php start

namespace EasyTask;

//加载Composer包
require './vendor/autoload.php';

//加载微擎核心包
require './framework/bootstrap.inc.php';

//加载微擎函数包
load()->func('communication');

//实例化Task
$task = new Task();

//提取命令行传参的命令
$argv = $_SERVER['argv'];
if (!empty($argv['1']))
{
    if ($argv['1'] == 'start')
    {
        //启动命令
        $task->setDaemon(true)->addFunction(function () {
            //重复执行的逻辑写在这里
        }, 'request', 15, 1)->start();
    }
    if ($argv['1'] == 'status')
    {
        //状态命令
        $task->status();
    }
    if ($argv['1'] == 'stop')
    {
        //停止命令
        $force = false;
        if (!empty($argv['2']) && $argv['2'] == '-f')
        {
            $force = true;
        }

        $task->stop($force);
    }
}

4.2 ThinkPHP3.2.3

根目录创建console.php, 启动命令: php ./console.php start

use EasyTask\Task;

// 检测PHP环境
if (version_compare(PHP_VERSION, '5.3.0', '<')) die('require PHP > 5.3.0 !');

// 开启调试模式 建议开发阶段开启 部署阶段注释或者设为false
define('APP_DEBUG', True);

// 定义应用目录
define('APP_PATH', './Application/');

//01. 抑制ThinkPHP默认执行+命令行解析-s
ob_start();

// 获取命令行参数并重置
$argv = getArgvs();

// 引入ThinkPHP
require './ThinkPHP/ThinkPHP.php';

// 引入Composer包
require './vendor/autoload.php';

ob_end_clean();

// 抑制ThinkPHP默认执行+命令行解析-e

/**
 * 获取命令行参数
 */
function getArgvs()
{
    $argv = $_SERVER['argv'];
    if (count($_SERVER['argv']) >= 2)
    {
        $_SERVER['argv'] = array($argv['0']);
        $_SERVER['argc'] = count($_SERVER['argv']);
    }
    return $argv;
}

//02. 提取命令行输入的命令-s
$func = '';
$force = false;
if (count($argv) < 2)
{
    exit('命令不存在！' . PHP_EOL);
}
$allowFunc = array('start', 'status', 'stop');
if (!in_array($argv['1'], $allowFunc))
{
    exit('命令不存在！' . PHP_EOL);
}
if (!empty($argv['2']) && $argv['2'] == '-f')
{
    $force = true;
}
$func = $argv['1'];
//提取命令行输入的命令-e

//03. 实例化Task
$task = new Task();
try
{
    if ($func == 'start')
    {
        //设置常驻
        $task->setDaemon(true);

        //添加订单超过20秒未支付发送短信-定时任务
        $class = '\\Home\\Logic\\OrderLogic';
        $task->addClass($class, 'send', 'send', 20, 1);

        //添加订单超过30秒未支付取消-定时任务
        $class = '\\Home\\Logic\\OrderLogic';
        $task->addClass($class, 'cancel', 'cancel', 30, 1);

        //启动定时任务
        $task->start();
    }
    if ($func == 'status')
    {
        $task->status();
    }
    if ($func == 'stop')
    {
        $task->stop($force);
    }
}
catch (Exception $exception)
{
    //输出错误信息
    var_dump($exception->getMessage());
}

About

原生常驻内存定时任务

Resources

Readme
Activity

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Languages

  • PHP 100.0%