Awesome Open Source
Awesome Open Source

Swoole Bundle

Maintainability Test Coverage Open Source Love MIT Licence

Symfony integration with Swoole to speed up your applications.


Build Matrix

CI Job Branch master Branch develop
Circle CircleCI CircleCI
CodeCov codecov codecov
Travis Build Status Build Status

Table of Contents

Quick start guide

  1. Make sure you have installed proper Swoole PHP Extension and pass other requirements.

  2. (optional) Create a new symfony project

    composer create-project symfony/skeleton project
    
    cd ./project
    
  3. Install bundle in your Symfony application

    composer require k911/swoole-bundle
    
  4. Edit config/bundles.php

    return [
        // ...other bundles
        K911\Swoole\Bridge\Symfony\Bundle\SwooleBundle::class => ['all' => true],
    ];
    
  5. Run Swoole HTTP Server

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

  7. You can now configure bundle according to your needs

Features

  • Built-in API Server

    Swoole Bundle API Server allows managing Swoole HTTP Server in real-time.

    • Reload worker processes
    • Shutdown server
    • Access metrics and settings
  • Improved static files serving

    Swoole HTTP Server provides a default static files handler, but it lacks supporting many Content-Types. To overcome this issue, there is a configurable Advanced Static Files Server. Static files serving remains enabled by default in the development environment. Static files directory defaults to %kernel.project_dir%/public. To configure your custom mime types check configuration reference (key swoole.http_server.static.mime_types).

  • Symfony Messenger integration

    Available since version: 0.6

    Swoole Server Task Transport has been integrated into this bundle to allow easy execution of asynchronous actions. Documentation of this feature is available here.

  • Hot Module Reload (HMR) for development ALPHA

    Since Swoole HTTP Server runs in Event Loop and does not flush memory between requests, to keep DX equal with normal servers, this bundle uses code replacement technique, using inotify PHP Extension to allow continuous development. It is enabled by default (when the extension is found) and requires no additional configuration. You can turn it off in bundle configuration.

    Remarks: This feature currently works only on a Linux host machine. It probably won't work with Docker, and it is possible that it works only with configuration: swoole.http_server.running_mode: process (default).

Requirements

Current version

  • PHP version >= 7.4
  • Swoole PHP Extension >= 4.5.10
  • Symfony >= 4.4.0

Future versions

  • PHP version >= 8.0
  • Swoole PHP Extension >= 4.6
  • Symfony >= 5.0

Additional requirements to enable specific features:

  • Inotify PHP Extension ^2.0.0 to use Hot Module Reload (HMR)
    • When using PHP 8, inotify version ^3.0.0 is required

Swoole

Bundle requires Swoole PHP Extension version 4.5.10 or higher. Active bug fixes are provided only for the latest version.

Version check

To check your installed version you can run the following command:

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

# 4.4.7

Installation

Official GitHub repository swoole/swoole-src contains comprehensive installation guide. The recommended approach is to install it from source.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
php (16,611
hacktoberfest (4,260
async (492
http-server (197
symfony-bundle (166
swoole (114