分享每一天-Laravel 集成 GatewayWorker (Workerman) 记录

Laravel 集成 GatewayWorker (Workerman) 记录

PHP 3128 0 创建时间：2020-06-09 22:22:05

workerman

#### Laravel 集成 GatewayWorker (Workerman)
:tw-1f250: :tw-1f0cf: :tw-1f236: are you ready？

官方文档：http://doc.workerman.net

## Workerman是什么？
Workerman是一款纯PHP开发的开源高性能的PHP socket 服务框架。

Workerman不是重复造轮子，它不是一个MVC框架，而是一个更底层更通用的socket服务框架，你可以用它开发tcp代理、梯子代理、做游戏服务器、邮件服务器、ftp服务器、甚至开发一个php版本的redis、php版本的数据库、php版本的nginx、php版本的php-fpm等等。Workerman可以说是PHP领域的一次创新，让开发者彻底摆脱了PHP只能做WEB的束缚。

实际上Workerman类似一个PHP版本的nginx，核心也是多进程+Epoll+非阻塞IO。Workerman每个进程能维持上万并发连接。由于本身常住内存，不依赖Apache、nginx、php-fpm这些容器，拥有超高的性能。同时支持TCP、UDP、UNIXSOCKET，支持长连接，支持Websocket、HTTP、WSS、HTTPS等通讯协以及各种自定义协议。拥有定时器、异步socket客户端、异步Mysql、异步Redis、异步Http、异步消息队列等众多高性能组件。

### 安装 Workerman
GatewayWorker是基于Workerman开发的一套TCP长连接的应用框架，实现了单发、群发、广播等接口，内置了mysql类库，GatewayWorker分为Gateway进程和Worker进程，天然支持分布式部署，能够支持庞大的连接数（百万甚至千万连接级别的应用）。
选择了 workerman/gateway-worker 的扩展包，它已经引入了 workerman/workerman:
```php
composer require workerman/gateway-worker
```
安装报错
```php
Failed: [ErrorException] 0: proc_open(): fork failed - Cannot allocate memory
```
在linux服务器使用composer部署的，提示内存不足。
##### 解决方法： 
先运行 free -m 看下空间是多少
在命令行环境依次运行以下三条命令
```php
dd if=/dev/zero of=/var/swap.1 bs=1M count=1024
mkswap /var/swap.1
swapon /var/swap.1
```
解释：
```php
dd 从/dev/zero设备复制出一个1G大小的文件/var/swap.1

mkswap 格式化/var/swap.1

swapon 将swap分区挂在到文件系统

然后输入free -m 查看内存使用量信息
```
ok 安装成功！

#### 服务端创建workerman命令
```php
php artisan make:command WorkermanServer
```
执行>/app/Console/Commands下面就会创建一个文件GatewayWorkerServer.php
 ```php
<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use GatewayWorker\BusinessWorker;
use GatewayWorker\Gateway;
use GatewayWorker\Register;
use Workerman\Worker;

class GatewayWorkerServer extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature =  'gateway-worker:server {action} {--d}';

/**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'GatewayWorker Server';

/**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

/**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        global $argv;
        $action = $this->argument('action');
        if(!in_array($action,['start','stop','restart'])){
            $this->error('Error action');
        }

$argv[0] = 'gateway-worker:server';
        $argv[1] = $action;
        $argv[2] = $this->option('d') ? '-d' : '';

$this->start();
    }
    //开启服务
    private function start()
    {
        $this->startGateWay();
        $this->startBusinessWorker();
        $this->startRegister();
        Worker::runAll();
    }

//启动Register服务，用于gateway-worker内部通讯
    private function startRegister()
    {
        new Register('text://0.0.0.0:12360');
    }

//启动gateway进程，用于暴露给客户端让其连接
    private function startGateWay()
    {
        $gateway = new Gateway("websocket://0.0.0.0:23460");   //0.0.0.0 监听本机所有网卡（内网、外网、都可以访问）
        $gateway->name                 = 'Gateway';                         //Gateway进程的名称
        $gateway->count                = 1;                                 //进程的数量=cup核心数。优化好linux内核，安装event扩展 每个进程可以维持上万的并发连接，否则只能1024个。
        $gateway->lanIp                = '127.0.0.1';                       //内网ip,多服务器分布式部署的时候需要填写真实的内网ip
        $gateway->startPort            = 2300;                              //监听本机端口的起始端口
        $gateway->pingInterval         = 30;                                //心跳检测时间间隔 单位：秒。如果设置为0代表不做任何心跳检测。
        $gateway->pingNotResponseLimit = 0;                                 //客户端连续n次$pingInterval时间内不发送任何数据则断开链接，并触发onClose。0表示不发送（由服务端发送）
        $gateway->pingData             = '{"mode":"heart"}';                //服务端定时给客户端发送的心跳数据
        $gateway->registerAddress      = '127.0.0.1:12360';                 //注册服务地址
    }

//启动BusinessWorker进程，用于运行业务逻辑
    private function startBusinessWorker()
    {
        $worker                  = new BusinessWorker();
        $worker->name            = 'BusinessWorker';                        //BusinessWorker进程的名称
        $worker->count           = 2;                                       //BusinessWorker进程的数量 = cup核心数的1-3倍
        $worker->registerAddress = '127.0.0.1:12360';                       //注册服务地址
        $worker->eventHandler    = \App\GateWayWorker\Event::class;        //设置使用哪个类来处理业务
    }
}

```
#### 创建文件 App\GateWayWorker\Event
 ```php
<?php 
namespace App\GateWayWorker;

use GatewayWorker\Lib\Gateway;
use Illuminate\Support\Facades\Log;

class Event
{

//当businessWorker进程启动时触发。每个进程生命周期内都只会触发一次。
    public static function onWorkerStart($businessWorker)
    {
        echo "BusinessWorker    Start\n";
    }

//当客户端连接上gateway进程时(TCP三次握手完毕时)触发的回调函数
    /*public static function onConnect($client_id)
    {
        Gateway::sendToClient($client_id, json_encode(['type' => 'init', 'client_id' => $client_id]));
    }*/

//当客户端连接上gateway完成websocket握手时触发的回调函数。
    public static function onWebSocketConnect($client_id)
    {
        /*可以在处理自己的一些业务逻辑...
        比如在此更新数据库中客户端/设备相关信息、
        进行客户端/设备id与client_id绑定 Gateway::bindUid(string $client_id, mixed $uid)  等...*/
        Gateway::sendToClient($client_id, json_encode(['type' => 'init', 'client_id' => $client_id]));
    }

//当客户端发来数据(Gateway进程收到数据)后触发的回调函数
    public static function onMessage($client_id, $message)
    {
        $response = ['code' => 0, 'msg' => 'ok', 'data' => []];
        $message = json_decode($message);

//根据接收到的客户端数据的不同模式 进行相应的处理以及回复。
        if (!isset($message->mode)) {
            $response['code'] = 500;
            $response['msg'] = 'fail';
            Gateway::sendToClient($client_id, json_encode($response));
        } else {
            switch ($message->mode) {
                case 'aaa':
                    // do something ...
                    $response['code'] = 200;
                    $response['msg'] = 'AAA';
                    $response['data'] = [];
                    break;
                case 'bbb':
                    // do something ...
                    $response['code'] = 200;
                    $response['msg'] = 'BBB';
                    $response['data'] = [];
                    break;
                default:
                    $response['code'] = 500;
                    $response['msg'] = 'Undefined';
            }

Gateway::sendToClient($client_id, json_encode($response));
        }
    }

//客户端与Gateway进程的连接断开时触发。
    public static function onClose($client_id)
    {
        //一般在这里做一些数据清理工作。
        Log::info('close connection' . $client_id);
    }

//当businessWorker进程退出时触发。每个进程生命周期内都只会触发一次。
    public static function onWorkerStop($businessWorker)
    {
        //可以在这里为每一个businessWorker进程做一些清理工作，例如保存一些重要数据等...
        echo "WorkerStop\n";
    }
}
```
#### 执行：
```php
php artisan gateway-worker:server start       //启动

php artisan gateway-worker:server start  --d  //后台启动

php artisan gateway-worker:server restart     //重启

php artisan gateway-worker:server stop        //停止
```
![](http://www.seedblog.cn/uploads/article/2020-06-11/b6gmJ0f8f6iYDDPo4Mp9HTqjz2fNeuMwMqdZeF6E.png)

#### 中途遇到：

pcntl_wait() has been disabled for security reasons workerman；

php禁用函数中删除掉。

Laravel 集成 GatewayWorker (Workerman) 记录

商品推荐

广告推荐

推荐文章