Zebra-Crontab使用手册

项目概述

Zebra-Crontab 是一款基于PHP的定时任务管理库，旨在提供一种更加灵活和集中化的解决方案来替代传统的crontab方式，尤其适用于定时任务众多且需要跨服务器管理的场景。它允许开发者将任务配置存储在数据库或其他存储介质中，并通过PHP脚本统一控制任务的执行。

1. 项目目录结构及介绍

Zebra-Crontab 的基本目录结构如下：

Zebra-Crontab/
|-- src/
|   |-- Jenner/
|       |-- Zebra/
|           |-- Crontab/                   # 核心类库，包含了Crontab和Mission等关键类
|-- tests/                               # 测试脚本，用于验证组件的功能
|-- .gitignore                           # 忽略文件列表
|-- LICENSE                              # 开源许可证文件
|-- README.md                            # 主要的项目介绍和使用指南
|-- composer.json                        # Composer依赖定义文件
|-- phpunit.xml                          #PHPUnit测试配置文件

• src/ 目录包含了所有的核心PHP类文件。
• tests/ 包含单元测试和示例脚本，帮助理解如何使用Zebra-Crontab。
• .gitignore 文件指定了在Git版本控制中忽略的文件类型。
• LICENSE 记录了软件的许可协议，本项目遵循Apache-2.0许可证。
• README.md 是项目的主要文档，提供了安装、配置和运行的基本步骤。
• composer.json 是Composer的配置文件，用于自动化加载依赖和管理项目的依赖关系。
• phpunit.xml 配置了单元测试的环境参数。

2. 项目的启动文件介绍

Zebra-Crontab并没有预设单一的启动文件，但它鼓励两种使用模式：

作为普通脚本运行

你可以创建一个PHP脚本（例如 cron_runner.php），在这个脚本中实例化Crontab对象，并传递定时任务配置。然后，将这个脚本加入系统的crontab中，让它按预定周期执行。

示例：

require_once 'vendor/autoload.php'; // 自动加载Composer依赖
$crontabConfig = [
    // ... 定时任务配置数组
];
$crontabServer = new Jenner\Zebra\Crontab\Crontab($crontabConfig);
$crontabServer->start(time());

作为守护进程

对于更高级的应用，可以通过构建守护进程来持续监听和执行任务，这种方式下，你需要编写一个独立的PHP守护进程脚本（如 daemon.php），使用Daemon类来维持任务的周期性检查和执行。

示例守护进程启动代码：

$daemon = new Jenner\Zebra\Crontab\Daemon($yourTasksArray); // 你的任务数组
$daemon->start();

3. 项目的配置文件介绍

Zebra-Crontab的核心在于动态任务配置，而不是静态配置文件。这意味着你通过PHP代码直接定义任务。然而，你可以设计自己的配置加载逻辑，比如从数据库或者YAML/JSON文件加载任务配置。

简单配置示例：

$tasks = [
    new Jenner\Zebra\Crontab\Mission(
        '任务名称',
        'php -v', // 执行的命令
        '* * * * *', // 定时表达式
        '/path/to/logfile.log', // 输出重定向
        'www-data', // 用户名
        'www-group' // 用户组
    ),
    // 更多任务...
];

// 如果使用Crontab类，直接启动
$crontabServer = new Jenner\Zebra\Crontab\Crontab(null, $tasks);
$crontabServer->start(time());

// 若使用Daemon模式，则如下启动
// $daemon = new Jenner\Zebra\Crontab\Daemon($tasks);
// $daemon->start();

在实际应用中，这些配置通常会根据实际情况动态生成，比如通过数据库查询结果构建 $tasks 数组。这样就实现了配置的灵活性和集中管理。