Download the PHP package hyperf-apex/apex without Composer

Hyperf Apex

企业级 Hyperf 3.2 + Swoole 6.2 通用组件库（Monorepo 架构）。

本仓库采用组件化设计，既支持按需引入单一功能包（避免非必要依赖膨胀），也支持通过元包 hyperf-apex/apex 一键全量引入。

模块清单与包规划（packages/）

核心设计特性

• 纯通用权限体系：提供统一顶层契约 PermissionInterface，消除对特定业务角色/枚举的硬编码；支持统一的 #[RequirePermission]（支持 string、BackedEnum、PermissionInterface 或其数组，支持 guard 自定义权限命名空间与 mode 组合）与 #[RequireRole] 注解；
• 插件化 Fail-Fast 启动检查：StartupChecker 提供纯规则驱动配置（required、required_envs）与 CheckerInterface 自定义探测器插件机制，彻底剔除针对具体第三方驱动的写死逻辑；
• 强类型 DTO 架构：基类统一收拢为 Hyperf\Apex\DTO\AbstractDTO，配合 #[FromQuery]、#[FromBody] 实现自动化参数水合、约束校验与 OpenAPI 3.1 规格自动推导；
• 现代化工程标准：全库严格遵循 PHP 8.4 + Swoole 6.2，PHPStan Level 6 静态分析全量 0 error，100% PSR 规范排版。

接入方式

方式 1：按需引入（推荐，轻量无污染）

根据项目的实际业务形态，只安装所需的组件包：

方式 2：全量引入（全家桶）

配置文件发布（vendor:publish）

每个包均提供独立的配置发布 ID：

日志通道

组件按用途分流日志，会优先使用下面这些通道名（Hyperf 的 logger.channels 配置）：

这些通道名不在 Hyperf 骨架的默认配置里，所以有两件事要知道：

• 没配置不会报错。组件统一经 Hyperf\Apex\Logging\LoggerChannels::resolve() 取通道， 通道不存在就退回 default（日志混在一起，功能完整）。直接调 LoggerFactory::get($name, $channel) 取通道会在通道缺失时抛异常且发生在构造函数里，所以组件源码里不要这么写。
• 想分流就自己定义同名通道，例如把访问日志单独落一个文件：

WebSocket 网关（hyperf-apex/websocket）

完整说明（运行前置、声明入口与事件、鉴权、推送、协议与内置事件、全部配置项）见 packages/websocket/README.md。

要点：网关默认强制单 Worker（协程服务器下 Sender 只在本 Worker 内投递，多 Worker 会静默丢推送， 确实只收不发时用 websocket.allow_multi_worker=true 显式接受）；推送不承诺可靠投递； 任何业务错误都只回错误信封、不断开连接。

开发与质检规范

• 运行环境：PHP 8.4 + Swoole 6.2，统一使用 swoole62 与 composer62 命令；
• 单元测试：composer62 test（PHPUnit 11）；
• 静态分析：composer62 analyse（PHPStan Level 6，全包 0 error）；
• 代码格式化：composer62 cs-fix（PHP-CS-Fixer）；
• 参与开发：见 CONTRIBUTING.md（环境、门禁、分支模型、发布流程）；
• 变更记录：见 CHANGELOG.md。

关于本仓库的发布方式

本仓库是 Monorepo，对外的 7 个包由两条路径发布：

发布流程：更新 CHANGELOG.md → 在 master 上打 git tag -a vX.Y.Z -m "chore(release): vX.Y.Z" → git push origin vX.Y.Z。