# taskPHP
**Repository Path**: long_ren/taskPHP
## Basic Information
- **Project Name**: taskPHP
- **Description**: taskPHP基于原生态php开发的定时计划任务框架,利用多进程实现任务的分配和运行,利用原生态php内存共享实现进程间通信,支持linux和windows。
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 85
- **Created**: 2017-04-07
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## taskPHP
taskPHP基于php开发的定时计划任务框架,利用多进程实现任务的分配和运行,利用内存共享实现进程间通信,支持多线程模式需要安装pthreads扩展(可选),支持linux和windows。有较好的伸缩性、扩展性、健壮稳定性而被多家公司使用,同时也希望开源爱好者一起贡献。
## 项目地址
github地址: https://github.com/qq8044023/taskPHP
oschina地址: http://git.oschina.net/cqcqphper/taskPHP
这两个地址都会同步更新。
## 在线交流QQ群
如感兴趣请加QQ群 一起探讨、完善。越多人支持,就越有动力去更新,喜欢记得右上角star哈。
taskPHP ①群:375841535(空)
## 框架概况
框架目录结构:
``` php
taskPHP 根目录
|-- core 框架系统目录
| |-- lib 框架核心文件目录
| | |-- .... 众多的框架核心类库文件
| |-- guide.php 框架引导文件
| |-- distribute_listen.php 任务派发进程入口
| |-- worker_listen.php 任务执行进程入口
|-- docs 开发文档存放目录
|-- logs 日志目录
|-- tasks 用户任务目录
| |-- demo demo任务
| | |-- Lib demo任务的扩展目录
| | |-- demoTask.php demo任务类文件
| | |-- config.php demo任务配置文件
| | ... 更多任务
| |-- config.php 全局配置文件
|-- main.php 框架入口文件
|-- windows_single.cmd windows快速启动文件
```
框架说明
1. linux下子进程执行任务,修改脚本无需重启后台服务立即生效,windows下修改任务脚本后需重启后台脚本 但往系统添加执行不受影响。
2. 框架支持多线程模式,需要安装pthreads扩展(可选)。
3. 使用内存共享实现进程通信,堵塞式消息队列,整个框架的运行无需第三方扩展。
4. 任务派发及具体任务执行不在同个进程[distribute_listen.php]和[worker_listen.php],windows和linux下启用入口文件[main.php],windows下可运行[windows_single.cmd]快速启动。
5. 执行时间语法跟crontab类似,且支持秒设置。
6. 添加任务简单,只需继承Task基类,实现任务入口run方法。
## 环境要求
1. php版本>= 5.5
2. 开启shmop
## 注意事项
1. 由于任务存在派发时间,所以任务运行的时间可能会有1-2秒的误差。
2. windows下执行任务在循环里,编写任务有问题或调用exit将导致后台脚本停止,linux下无此问题。
## 文档列表
-->[MYSQL数据库类使用教程](./docs/mysql.md)
-->[windows下安装php多线程扩展pthreads教程](./docs/thread_windows.md)
-->[工具类Utils使用说明](./docs/utils.md)
-->[http请求客户端类Client使用说明](./docs/http_client.md)
## 使用说明
### 时间配置格式说明:
``` php
* * * * * * * //格式 :秒 分 时 天 月 年 周
10 * * * * * * //表示每一分钟的第10秒运行
/10 * * * * * * //表示每10秒运行
```
### 系统命令说明:
``` php
mian.php [start] 启动 可不带参数
mian.php close 结束
main.php reload 重新加载任务
main.php delete demo 删除任务
main.php select 查看任务列表
main.php exec demo 运行任务 主要用于任务开发中调试单个任务
```
### 全局配置文件规范
``` php
'nobody',
//指定任务进程最大内存
'memory_limit' =>'256M',
//单个进程执行的任务数 0无限 大于0为指定数
'worker_limit' =>0,
//worker进程运行模式
//0.自动模式 默认
//1.多进程模式
//2.单进程模式
//3.多线程模式
'worker_mode' =>0,
//任务列表
'task_list'=>array(
//demo任务
'demo'=>array(
//class名称,(设置true或者不设置此参数)代表tasks目录里面的任务会自动找到该任务的class名称,非tasks目录里面的任务则填写完整的class名称core\lib\xxxx
'class_name'=>true,
//crontad格式 :秒 分 时 天 月 年 周
'timer' =>'/1 * * * * * *',
),
),
);
```
### composer安装taskphp框架:
``` php
composer require taskphp/taskphp
```
## Windows 命令操作
### 调试启动程序
```
D:\phpStudy\wwwroot\ostaskphp>php main.php
------------------------- taskPHP ------------------------------
taskPHP version:1.0 PHP version:5.6.1
------------------------- taskPHP PROCESS ----------------------
listen processes status
distribute N [OK]
worker N [OK]
----------------------------------------------------------------
```
### 结束程序
``` php
D:\phpStudy\wwwroot\ostaskphp>php main.php close
runing:no
close ok
```
### 重新加载任务
``` php
D:\phpStudy\wwwroot\ostaskphp>php ./main.php reload
taskPHP:demo task load complete
taskPHP is running..............
task reload ok
```
### 删除任务
``` php
D:\phpStudy\wwwroot\ostaskphp>php ./main.php delete demo
taskPHP:demo task load complete
taskPHP is running..............
task reload ok
```
### 查看任务列表
``` php
D:\phpStudy\wwwroot\ostaskphp>php ./main.php select
task_name:demo
run_time:1 * * * * * *
next_time:2017-04-06 10:08:01
```
## Liunx 命令操作
### 调试启动程序
``` php
[root@FX-DEBUG taskphps]# php ./main.php start
------------------------- taskPHP ------------------------------
taskPHP version:1.0 PHP version:5.6.9
------------------------- taskPHP PROCESS ----------------------
listen processes status
distribute N [OK]
worker N [OK]
----------------------------------------------------------------
taskPHP:demo task load complete
taskPHP is running..............
```
### 后台启动程序
``` php
[root@FX-DEBUG taskphps]# php ./main.php start &
------------------------- taskPHP ------------------------------
taskPHP version:1.0 PHP version:5.6.9
------------------------- taskPHP PROCESS ----------------------
listen processes status
distribute N [OK]
worker N [OK]
----------------------------------------------------------------
taskPHP:demo task load complete
taskPHP is running..............
```
### 结束程序
``` php
[root@FX-DEBUG taskphps]# php ./main.php close
runing:no
close ok
```
### 重新加载任务
``` php
[root@FX-DEBUG taskphps]# php ./main.php reload
taskPHP:demo task load complete
taskPHP is running..............
task reload ok
```
### 删除任务
``` php
[root@FX-DEBUG taskphps]# php ./main.php delete demo
taskPHP:demo task load complete
taskPHP is running..............
task reload ok
```
### 查看任务列表
``` php
[root@FX-DEBUG taskphps]# php ./main.php select
task_name:demo
run_time:1 * * * * * *
next_time:2017-04-06 10:08:01
```