Get 10x performance for Laravel on Swoole or Workerman

v1.0.0 2017-01-23 09:58 UTC



Laravel on Swoole Or Workerman

10x faster than php-fpm

##Depends On

laravel/framework5.1.* | 5.2.* | 5.3.*




To get started, add laravoole to you composer.json file and run composer update:

"garveen/laravoole": "~0.2"

or just run shell command:

 composer require garveen/laravoole

Once composer done its job, you need to register Laravel service provider, in your config/app.php:

'providers' => [

Notice: You should NOT use file session handler, because it is not stable at this environement. Use redis or other handler instead.


php artisan laravoole [start | stop | reload | reload_task | restart | quit]


To generate config/laravoole.php:

php artisan vendor:publish --provider="Laravoole\LaravooleServiceProvider"

Most of things can be configured with .env, and you should use LARAVOOLE_{UPPER_CASE} format, for example,

    'base_config' => [
        'host' => '',

is equals with



By now, there are only two events, laravoole.on_request and laravoole.swoole.websocket.on_close. You can handle events by editing EventServiceProvider:

public function boot()
    \Event::listen('laravoole.on_request', function ($request) {


This section configures laravoole itself.


SwooleHttp uses swoole to response http requests

SwooleFastCGI uses swoole to response fastcgi requests (just like php-fpm)

SwooleWebSocket uses swoole to response websocket requests AND http requests

WorkermanFastCGI uses workerman to response fastcgi requests (just like php-fpm)


Defines a file that will store the process ID of the main process.


When using Http mode, you can turn on this option to let laravoole send static resources to clients. Use this ONLY when developing.

###host and port

Default host is, and port is 9050


This section configures the backend, e.g. swoole or workerman.


As an example, if want to set worker_num to 8, you can set .env:


or set config/laravoole.php:

    'handler_config' => [
        'worker_num' => 8,

See Swoole's document:




As an example, if want to set worker_num to 8, you can set .env:


or set config/laravoole.php:

    'handler_config' => [
        'count' => 8,

See Workerman's document:



##Websocket Usage


See Mozilla's Document: Writing WebSocket server

The default subprotocol is jsonrpc, but has some different: params is an object, and two more properties:

status as HTTP status code

method is the same as request's method

You can define your own subprotocol, by implements Laravoole\WebsocketCodec\CodecInterface and add to config/laravoole.php.

###Client Example:

<!DOCTYPE html>
<meta charset="utf-8" />
<title>WebSocket Test</title>
p{word-wrap: break-word;}
tr:nth-child(odd){background-color: #ccc}
tr:nth-child(even){background-color: #eee}
<h2>WebSocket Test</h2>
<table><tbody id="output"></tbody></table>
    var wsUri = "ws://localhost:9050/websocket";
    var protocols = ['jsonrpc'];
    var output = document.getElementById("output");

    function send(message) {
        log('Sent', message);

    function log(type, str) {
        str = str.replace(/&/g, '&amp;').replace(/"/g, '&quot;').replace(/'/g, '&#39;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
        output.insertAdjacentHTML('beforeend', '<tr><td>' + type + '</td><td><p>' + htmlEscape(str) + '</p></td></tr>');

    websocket = new WebSocket(wsUri, protocols);
    websocket.onopen = function(evt) {
        log('Status', "Connection opened");
        send(JSON.stringify({method: '/', params: {hello: 'world'},  id: 1}));
        setTimeout(function(){ websocket.close() },1000)
    websocket.onclose = function(evt) { log('Status', "Connection closed") };
    websocket.onmessage = function(evt) { log('<span style="color: blue;">Received</span>', evt.data) };
    websocket.onerror = function(evt) {  log('<span style="color: red;">Error</span>', evt.data) };

##Work with nginx

server {
    listen       80;
    server_name  localhost;

    root /path/to/laravel/public;

    location / {
            try_files $uri $uri/ @laravoole;
            index  index.html index.htm index.php;

    # http
    location @laravoole {
        proxy_set_header   Host $host:$server_port;
        proxy_set_header   X-Real-IP $remote_addr;
        proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_http_version 1.1;


    # fastcgi
    location @laravoole {
        include fastcgi_params;

    # websocket
    # send close if there has not an upgrade header
    map $http_upgrade $connection_upgrade {
        default upgrade;
        '' close;
    location /websocket {
        proxy_connect_timeout 7d;
        proxy_send_timeout 7d;
        proxy_read_timeout 7d;
        proxy_http_version 1.1;
        proxy_set_header Upgrade    $http_upgrade;
        proxy_set_header Connection $connection_upgrade;

#License MIT