yzh52521 / http-crontab
接口化秒级定时任务管理
v1.33
2023-09-01 09:33 UTC
Requires
- php: >=7.2.5
- ext-json: *
- nikic/fast-route: ^1.3
- symfony/process: ^4.4|^5.4|^6.0
- workerman/crontab: ^1.0
- workerman/workerman: ^4.0
- yzh52521/think-lock: ^1.0
Requires (Dev)
- guzzlehttp/guzzle: ^7.0
- topthink/framework: ^6.0|^8.0
README
概述
基于 Workerman + ThinkPHP6.x/8.x 的接口化秒级定时任务管理,兼容 Windows 和 Linux 系统。
定时器格式说明:
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位,则最小时间粒度是分钟]
任务分类
-
url 任务可以指定一个url地址来请求,没有什么可解释的。
-
Class 任务必须指定带有 命名空间的类名,并且实现一个 public 属性的方法:execute 方法返回值为 bool/string类型,支持自定义方法 事例:target='app\common\model\User@check' @后面是方法
-
Command 任务请先按照 thinkphp 官方文档定义好执行命令,在新增任务,输入定义的 命令 即可 例如:version
-
Shell 任务 在新增任务,输入定义的 shell命令 即可 例如:ps -ef | grep php
简单使用
启动服务
定时器接口说明
PING
基本信息
Path: /crontab/ping
Method: GET
接口描述:
{
"code": 200,
"data": "pong",
"msg": "信息调用成功!"
}
请求参数
返回数据
修改
基本信息
Path: /crontab/modify
Method: POST
接口描述:
{ "code": 200, "data": true, "msg": "信息调用成功!" }
请求参数
Headers
Body
列表
基本信息
Path: /crontab/index
Method: GET
接口描述:
{
"code": 200,
"data": {
"total": 4,
"data": [
{
"id": 1,
"title": "输出 tp 版本",
"type": 1,
"rule": "*/3 * * * * *",
"target": "version",
"parameter": "",
"running_times": 3,
"last_running_time": 1625636646,
"remark": "每3秒执行",
"sort": 0,
"status": 1,
"singleton": 1,
"create_time": 1625636609,
"update_time": 1625636609
},
{
"id": 2,
"title": "class任务 每月1号清理所有日志",
"type": 2,
"rule": "0 0 1 * *",
"target": "app\\common\\crontab\\ClearLogCrontab",
"parameter": "",
"running_times": 71,
"last_running_time": 1651121710,
"remark": "",
"sort": 0,
"status": 1,
"create_time": 1651114277,
"update_time": 1651114277,
"singleton": 1
},
],
},
"msg": "信息调用成功!"
}
请求参数
Query
删除
基本信息
Path: /crontab/delete
Method: POST
接口描述:
{ "code": 200, "data": true, "msg": "信息调用成功!" }
请求参数
Headers
Body
定时器池
基本信息
Path: /crontab/pool
Method: GET
接口描述:
"code": 200,
"data": [
{
"id": 1,
"type": 1,
"target": "version",
"rule": "*/3 * * * * *",
"parameter": "",
"remark": "每3秒执行",
"singleton":1,
"create_time": "2021-07-07 13:43:29"
}
],
"msg": "信息调用成功!"
}
请求参数
日志
基本信息
Path: /crontab/flow
Method: GET
接口描述:
{
"code": 200,
"msg": "ok",
"data": {
"total": 97,
"data": [
{
"id": 257,
"crontab_id": 1,
"target": "version",
"parameter": "",
"exception": "v6.0.12LTS",
"return_code": 0,
"running_time": "0.834571",
"create_time": 1651123800,
"update_time": 1651123800
},
{
"id": 251,
"crontab_id": 1,
"target": "version",
"parameter": "",
"exception": "v6.0.12LTS",
"return_code": 0,
"running_time": "0.540384",
"create_time": 1651121700,
"update_time": 1651121700
},
{
"id": 246,
"crontab_id": 1,
"target": "version",
"parameter": "",
"exception": "v6.0.12LTS",
"return_code": 0,
"running_time": "0.316019",
"create_time": 1651121640,
"update_time": 1651121640
},
{
"id": 244,
"crontab_id": 1,
"target": "version",
"parameter": "",
"exception": "v6.0.12LTS",
"return_code": 0,
"running_time": "0.493848",
"create_time": 1651121580,
"update_time": 1651121580
}
]
}
}
请求参数
Query
添加
基本信息
Path: /crontab/add
Method: POST
接口描述:
{
"code": 200,
"data": true,
"msg": "信息调用成功!"
}
请求参数
Headers
Body
重启
基本信息
Path: /crontab/reload
Method: POST
接口描述:
{ "code": 200, "msg": "信息调用成功", "data": { } }
请求参数
Headers
Body
返回数据
{ "code": 200, "msg": "信息调用成功", "data": { } }