Hyperf XXL-Job Incubator 使用教程

Hyperf XXL-Job Incubator 使用教程

xxl-job-incubator 项目地址: https://gitcode.com/gh_mirrors/xx/xxl-job-incubator

1. 项目目录结构及介绍

Hyperf 的 XXL-Job Incubator 是XXL-JOB的PHP版本任务执行器，专为Hyperf框架设计。以下是该项目的目录结构概览及其主要组成部分的简要说明：

.
├── composer.json        # 项目依赖定义文件
├── gitattributes        # Git属性配置文件
├── gitignore            # Git忽略文件列表
├── php-cs-fixer         # PHP Coding Standards Fixer配置文件
├── phpstan              # PHPStan配置文件，用于静态分析
├── phpunit.xml          # PHPUnit测试配置文件
├── README.md            # 项目快速入门和概述文档
├── LICENSE              # 许可证文件
└── config               # 配置文件夹，包含了项目的核心配置
    └── autoload         # 自动加载配置，可能包括XXL-Job的相关配置文件如xxl_job.php

config/autoload/xxl_job.php是XXL-Job的特定配置文件，用于设置是否启用XXL-Job、服务端地址等关键信息。

2. 项目的启动文件介绍

在基于Hyperf框架的应用中，通常没有一个单一的“启动文件”作为传统意义上的入口点，而是通过命令行工具或配置来启动Swoole服务器。对于XXL-Job的集成，其核心在于通过Hyperf的事件监听或者命令行指令激活相关的作业处理器。具体到启动整个Hyperf应用（进而运行XXL-Job的任务），你需要通过以下命令启动Swoole服务器：

php bin/hyperf.php start

或者，在开发环境下使用reload自动重载特性：

php bin/hyperf.php serve --dev

XXL-Job的任务执行逻辑则嵌入在Hyperf的工作进程中，通过XXL-Job的调度触发。

3. 项目的配置文件介绍

主配置文件：config/autoload/xxl_job.php

此配置文件是XXL-Job在Hyperf中的核心配置。以下是一些关键配置项的示例：

return [
    // 是否启用XXL-Job
    'enable' => env('XXL_JOB_ENABLE', true),
    // XXL-JOB 服务端地址
    'admin_address' => 'http://your-xxl-job-admin-address',
    // 其他配置如执行器名称、AppID等...
];

• enable: 控制是否开启XXL-Job功能。
• admin_address: 指向XXL-Job的管理控制台地址，确保任务调度可以正常通信。

此外，你可以在此配置文件中添加更多XXL-Job需要的详细配置，比如执行器的命名、报告心跳的间隔、以及任何自定义的XXL-Job相关设置。

请注意，实际部署和使用时，应根据自己的环境和需求调整这些配置值。在深入使用XXL-Job时，还可能涉及到更多的配置定制，例如分片策略、执行器的扩展配置等，这些都是基于对XXL-Job核心逻辑的理解和实际应用场景来设定的。

xxl-job-incubator 项目地址: https://gitcode.com/gh_mirrors/xx/xxl-job-incubator