README

概述

基于 webman + TP-ORM 的动态秒级定时任务管理，兼容 Windows 和 Linux 系统。

原项目

基于原作者项目更改的部分适合自己使用的模块插件

原项目地址：https://github.com/yzh52521/webman-task

喜欢原版的请移步原作者

【原旧版本->改动】

修改创建数据库时候的部分字段未设置默认值的bug
更改必须使用execute方法，可以使用自定义方法【自定义方法请写到：target 后面，例如：app\common\crontab\ClearLogCrontab\test】
修复禁用、暂停、在下一分钟才生效的bug
新增任务日志设置项
插件默认关闭状态，如需启动，请在配置文件中修改enable=true

安装

重要提示：

windows用户启动webman 使用 windows.php
使用前请先确认是否composer已安装以下3个插件：

workerman/crontab
webman/think-orm
guzzlehttp/guzzle

composer require xianrenqh/webman-crontab-task

定时器格式说明:

0   1   2   3   4   5
|   |   |   |   |   |
|   |   |   |   |   +------ day of week (0 - 6) (Sunday=0)
|   |   |   |   +------ month (1 - 12)
|   |   |   +-------- day of month (1 - 31)
|   |   +---------- hour (0 - 23)
|   +------------ min (0 - 59)
+-------------- sec (0-59)[可省略，如果没有0位,则最小时间粒度是分钟]

简单使用

   $param = [
     'method' => 'crontabIndex',//计划任务列表
     'args'   => ['limit' => 10, 'page' => 1]//参数
    ];
   $result= xianrenqh\Task\Client::instance()->request($param);
   return json($result);

任务分类

url 任务可以指定一个url地址来请求，没有什么可解释的。
eval 任务可以直接写入 php 代码，但代码请不要带，具体查阅 eval 函数
Class 任务必须指定带有命名空间的类名，并且实现一个 public 属性的方法：方法返回值为 bool / string 类型
Command 任务请先按照 webman 官方文档定义好执行命令，在新增任务，输入定义的命令即可例如：php webman version 或者 version
Shell 任务在新增任务，输入定义的 shell命令即可例如：ps -ef | grep php

计划任务列表

方法名

method： crontabIndex

请求参数

args

返回数据

{
  "code": 200,
  "msg": "ok",
  "data": {
    "total": 4,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "data": [
      {
        "id": 6,
        "title": "class任务 每月1号清理所有日志",
        "type": 2,
        "rule": "0 0 1 * *",
        "target": "app\\api\\controller\\testController\\test",
        "parameter": "",
        "running_times": 71,
        "last_running_time": 1651121710,
        "remark": "",
        "sort": 0,
        "status": 1,
        "create_time": 1651114277,
        "update_time": 1651114277,
        "singleton": 1
      },
      {
        "id": 5,
        "title": "eavl任务 输出 hello world",
        "type": 4,
        "rule": "* * * * *",
        "target": "echo 'hello world';",
        "parameter": "",
        "running_times": 25,
        "last_running_time": 1651121701,
        "remark": "",
        "sort": 0,
        "status": 1,
        "create_time": 1651113561,
        "update_time": 1651113561,
        "singleton": 0
      },
      {
        "id": 3,
        "title": "url任务 打开 workerman 网站",
        "type": 3,
        "rule": "*/20 * * * * *",
        "target": "https://www.workerman.net/",
        "parameter": "",
        "running_times": 39,
        "last_running_time": 1651121700,
        "remark": "请求workerman网站",
        "sort": 0,
        "status": 1,
        "create_time": 1651112925,
        "update_time": 1651112925,
        "singleton": 0
      },
      {
        "id": 1,
        "title": "command任务 输出 webman 版本",
        "type": 1,
        "rule": "*/20 * * * * *",
        "target": "version",
        "parameter": null,
        "running_times": 112,
        "last_running_time": 1651121700,
        "remark": "20秒",
        "sort": 0,
        "status": 1,
        "create_time": 1651047480,
        "update_time": 1651047480,
        "singleton": 1
      }
    ]
  }
}

计划任务日志列表

method： crontabLog

请求参数

args

返回数据

{
  "code": 200,
  "msg": "ok",
  "data": {
    "total": 97,
    "per_page": 15,
    "current_page": 1,
    "last_page": 7,
    "data": [
      {
        "id": 257,
        "crontab_id": 1,
        "target": "version",
        "parameter": "",
        "exception": "Webman-framework v1.3.11",
        "return_code": 0,
        "running_time": "0.834571",
        "create_time": 1651123800,
        "update_time": 1651123800
      },
      {
        "id": 251,
        "crontab_id": 1,
        "target": "php webman version",
        "parameter": "",
        "exception": "Webman-framework v1.3.11",
        "return_code": 0,
        "running_time": "0.540384",
        "create_time": 1651121700,
        "update_time": 1651121700
      },
      {
        "id": 246,
        "crontab_id": 1,
        "target": "php webman version",
        "parameter": "{}",
        "exception": "Webman-framework v1.3.11",
        "return_code": 0,
        "running_time": "0.316019",
        "create_time": 1651121640,
        "update_time": 1651121640
      },
      {
        "id": 244,
        "crontab_id": 1,
        "target": "php webman version",
        "parameter": "{}",
        "exception": "Webman-framework v1.3.11",
        "return_code": 0,
        "running_time": "0.493848",
        "create_time": 1651121580,
        "update_time": 1651121580
      }
    ]
  }
}

添加任务

method： crontabCreate

请求参数

args

返回数据

{
  "code": 200,
  "msg": "ok",
  "data": {
  }
}

重启任务

method： crontabReload

请求参数

args

返回数据

{
  "code": 200,
  "msg": "ok",
  "data": {
  }
}

修改任务

method： crontabUpdate

请求参数

args

//使用类【type=2】的添加案例
 $request = [
        'method' => 'crontabCreate',
        'args'   => [
            'title'  => '检测设备心跳',
            'type'   => 2,
            'rule'   => '*/3 * * * * *',
            'target' => 'app\api\crontab\HeartCrontab\checkheart',
            'status' => 1,
            'remark' => '每3秒执行',
        ]
    ];
    $result  = \xianrenqh\Task\Client::instance()->request($request);

    return json($result);

返回数据

{
  "code": 200,
  "msg": "ok",
  "data": {
  }
}

删除任务

method： crontabDelete

请求参数

args

返回数据

{
  "code": 200,
  "msg": "ok",
  "data": {
  
  }
}

xianrenqh / webman-crontab-task

Maintainers

Details

README

概述

原项目

安装

重要提示：

定时器格式说明:

简单使用

任务分类

计划任务列表

方法名

请求参数

返回数据

计划任务日志列表

请求参数

返回数据

添加任务

请求参数

返回数据

重启任务

请求参数

返回数据

修改任务

请求参数

返回数据

删除任务

请求参数

返回数据