huang-yi/laravel-swoole-http

A high performance HTTP/websocket server based on Swoole. Speeds up your Laravel and Lumen applications.

Laravel-Swoole-Http

, _(*1)

A high performance HTTP server based on Swoole. And now, it also supports WebSocket server., _(*2)

Translations

• 中文文档

Requirements

• Laravel/Lumen 5.2+
• ext-swoole 1.9.5+
• ext-inotify (Optional)

Installation & Setup

1. This package can be installed via composer:

$ composer require huang-yi/laravel-swoole-http

1. Register service provider(Optional)

You need to register the service provider manually, if your Laravel version is less than 5.5 or you are using Lumen:, _(*3)

<?php
// Framework: Laravel
// File: config/app.php

[
    'providers' => [
        HuangYi\Swoole\SwooleServiceProvider::class,
    ],
];

<?php
// Framework: Lumen
// File: bootstrap/app.php

$app->register(HuangYi\Swoole\SwooleServiceProvider::class);

1. Configurations

Run this command to publish the configuration file:, _(*4)

$ php artisan vendor:publish --provider="HuangYi\Swoole\SwooleServiceProvider"

Click here for more information about the configurations., _(*5)

1. Start server

Run this command to start the server:, _(*6)

php artisan swoole:server

And then, you can visit your website via http://127.0.0.1:1215., _(*7)

Click here for more information about the commands., _(*8)

Configurations

driver

This option controls the default "driver" that will be used to create the server., _(*9)

Supported: "http", "websocket", _(*10)

host

The ip address of the server., _(*11)

port

The port of the server., _(*12)

options

The swoole server configurations. Get more information from the official documents., _(*13)

Notice: The value of task_worker_num must be greater than 0 if you use task., _(*14)

resets

This option controls the instances that need to be reset after each request. It helps developers avoid problems caused by singleton, such as auth., _(*15)

message_parser

The WebSocket message parser. You can replace this option with a custom parser., _(*16)

Notice: The custom parser must implement the HuangYi\Swoole\Contracts\ParserContract., _(*17)

redis

• connection: Specify a redis connection to store websocket rooms and clients.
• prefix: Set the prefix of redis key.

tables

Define swoole table structures:, _(*18)

<?php

[
    'tables' => [
        [
            'name' => 'users',
            'size' => 1024,
            'columns' => [
                ['id', 'int', 8],
                ['nickname', 'string', 255],
                ['score', 'float']
            ],
        ],
    ],
];

• name: Specifies a table name.
• size: Defines the maximum number of rows.
• columns: Defines the table's columns. Format: [column_name, column_type, column_length]. Column types: int, integer, string, varchar, char, float.

Click here for more information about the tables., _(*19)

watcher

The file watcher configurations., _(*20)

directories：Defines the list of directories being watched;, _(*21)

excluded_directories：Defines a list of directories not being watched;, _(*22)

suffixes：Defines the list of file suffixes being watched., _(*23)

Commands

This package provides an artisan command to manage the swoole server., _(*24)

php artisan swoole:server

This command has an "action" argument and the default value is "start"., _(*25)

Notice: The swoole server can only run in cli environment., _(*26)

Tables

The Swoole Table can help developers to share data across worker processes. You can define the table structures in the configuration file., _(*27)

<?php
use HuangYi\Swoole\Facades\Table;

// Insert a record.
Table::use('users')->set(1, ['id' => 1, 'nickname' => 'Bob', 'score' => 9.5]);

// Query a record.
$bob = Table::use('users')->get(1);
$nickname = Table::use('users')->get(1, 'nickname');

// Truncate a table.
Table::truncate('users');

Click here for more information about the Swoole Tables., _(*28)

Task

Define a task:, _(*29)

<?php

use HuangYi\Swoole\Contracts\TaskContract;
use Illuminate\Support\Facades\Mail;

class SendMailTask implements TaskContract
{
    /**
     * @var array $mail
     */
    protected $mail;

    /**
     * Mail task
     * 
     * @var array $mail
     * @return void
     */
    public function __construct(array $mail)
    {
        $this->mail = $mail;
    }

    /**
     * Task handler.
     *
     * @param \Swoole\Server $server
     * @param int $taskId
     * @param int $srcWorkerId
     * @return void
     */
    public function handle($server, $taskId, $srcWorkerId)
    {
        Mail::to($this->mail['to'])->send($this->mail['view'], $this->mail['data']);
    }
}

Send the task to the task worker processes:, _(*30)

<?php

$task = new SendMailTask([
    'to' => 'bob@mail.com',
    'view' => 'mail',
    'data' => [],
]);

app('swoole.server')->task($task);

Notice: To start the task worker processes, the value of task_worker_num must be set to greater than 0., _(*31)

Nginx

server {
    listen 80;
    server_name your.domain;
    root /path/to/laravel/public;
    index index.php;

    location = /index.php {
        # Ensure that there is no such file named "not_exists" in your "public" directory.
        try_files /not_exists @swoole;
    }

    location / {
        try_files $uri $uri/ @swoole;
    }

    location @swoole {
        set $suffix "";

        if ($uri = /index.php) {
            set $suffix "/";
        }

        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        proxy_pass http://127.0.0.1:1215$suffix;
    }
}

Notice: Add the ip of swoole server (the default is 127.0.0.1) to the middleware App\Http\Middleware\TrustProxies., _(*32)

Tips

• Never use these functions: sleep()、exit()、die().
• Be careful of the singletons.