pixelfederation/swoole-bundle

Swoole Symfony 扩展包

v0.13.2 2023-10-05 13:59 UTC

README

Maintainability Test Coverage Open Source Love MIT Licence

使用 Open Swoole 与 Symfony 集成以加快您的应用程序。

构建矩阵

目录

快速入门指南

  1. 确保您已安装适当的 Open Swoole PHP 扩展并满足其他 要求

  2. (可选) 创建一个新的 symfony 项目

    composer create-project symfony/skeleton project
    
    cd ./project
  3. 在您的 symfony 应用程序中安装扩展包

    composer require pixelfederation/swoole-bundle
  4. 编辑 config/bundles.php

    return [
        // ...other bundles
        K911\Swoole\Bridge\Symfony\Bundle\SwooleBundle::class => ['all' => true],
    ];
  5. 运行 Swoole HTTP 服务器

    bin/console swoole:server:run
  6. 进入 http://localhost:9501

  7. 您现在可以根据需要配置扩展包

特性

  • 内置 API 服务器

    Swoole 扩展包 API 服务器允许实时管理 Swoole HTTP 服务器。

    • 重新加载工作进程
    • 关闭服务器
    • 访问指标和设置
  • 改进的静态文件服务

    Swoole HTTP 服务器提供了一个默认的静态文件处理器,但它不支持许多 Content-Types。为了解决这个问题,有一个可配置的先进静态文件服务器。在开发环境中,默认启用静态文件服务。静态文件目录默认为 %kernel.project_dir%/public。要配置自定义 MIME 类型,请参阅 配置参考(键 swoole.http_server.static.mime_types)。

  • Symfony Messenger 集成

    自版本:0.6 以来可用

    Swoole 服务器任务传输已集成到此扩展包中,以便轻松执行异步操作。有关此功能的文档可在 此处 查找。

  • 开发环境中的热模块重载(HMR)ALPHA

    由于 Swoole HTTP 服务器在事件循环中运行且不请求间刷新内存,为了保持 DX 与普通服务器相同,此扩展包使用代码替换技术,使用 inotify PHP 扩展允许持续开发。默认启用(当找到扩展时)且无需额外配置。您可以在扩展包配置中将其关闭。

    备注:此功能目前仅在 Linux 主机上工作。它可能不与 Docker 一起工作,并且它可能仅在以下配置下工作:swoole.http_server.running_mode: process(默认)。

  • 访问日志,默认情况下禁用,日志可配置,与 apache mod log 的方式相同。有关此功能的文档可在 此处 查找。

要求

当前版本

  • PHP 版本 >= 8.0
  • Open Swoole PHP 扩展 >= 4.12.1
  • Symfony >= 5.4.0

未来版本

  • PHP 版本 >= 8.2
  • Swoole PHP 扩展 >= v22.0.0
  • Symfony >= 6.1

启用特定功能的附加要求

  • Inotify PHP 扩展 ^2.0.0 以使用热模块重载(HMR)
    • 当使用 PHP 8 时,需要 inotify 版本 ^3.0.0

Open Swoole

扩展包需要 Open Swoole PHP 扩展 版本 4.10.0 或更高版本。仅对最新版本提供活动错误修复。

版本检查

要检查您安装的版本,您可以运行以下命令

php -r "echo swoole_version() . \PHP_EOL;"

# 4.10.0

安装

官方GitHub仓库openswoole/swoole-src包含详细的安装指南。建议从源码安装。