xavier-swoole: thinkphp5.0的SWOOLE扩展

原作者: [db:作者] 来自: 网络收藏邀请

开源软件名称：

xavier-swoole

开源软件地址：

https://gitee.com/xavier007/xavier-swoole

开源软件介绍：

ThinkPHP 5.0 Swoole 扩展

参考官方think-swoole2.0和easyswoole开发基于TP5.0的swoole扩展包

增加异步任务投递QQ499873958

<?phpnamespace app\index\controller;use xavier\swoole\Task;class Index{    public function index()    {        return "index";    }    public function test()    {        echo 1;        $param = request()->param();        $post  = request()->post();        //异步任务投递        Task::async(function ($serv, $task_id, $data) {            $i = 0;            while ($i < 10) {                $i++;                echo $i;                sleep(1);            }        });        //使用swoole4.0协程        \go(function () {            $i = 0;            while ($i < 10) {                echo 2;                $i++;                \co::sleep(1);            };        });        return json($post);    }}

配置文件

第三方包的配置文件必须在application/extra下，文件名为swoole.php

<?phpreturn [    'host'                  => '0.0.0.0', // 监听地址    'port'                  => 9501, // 监听端口    'mode'                  => '', // 运行模式 默认为SWOOLE_PROCESS    'sock_type'             => '', // sock type 默认为SWOOLE_SOCK_TCP    'app_path'              => getcwd() . '/application', // 应用地址 如果开启了 'daemonize'=>true 必须设置（使用绝对路径）    'file_monitor'          => false, // 是否开启PHP文件更改监控（调试模式下自动开启）    'file_monitor_interval' => 2, // 文件变化监控检测时间间隔（秒）    'file_monitor_path'     => [], // 文件监控目录 默认监控application和config目录    // 可以支持swoole的所有配置参数    'pid_file'              => getcwd()  . '/runtime/swoole.pid',    'log_file'              => getcwd()  . '/runtime/swoole.log',    'task_worker_num'       => 20,    //'document_root'         => getcwd() . 'public',    //'enable_static_handler' => true,    'daemonize'                => 1,//守护    'worker_num' => 8,    //worker process num    'max_request' => 10000,];

注意：\think\Request 增加如下静态方法。由于TP运行在Apache或者NGINX下，是每次请求后都会销毁，所以这里的单例并不会造成什么问题，但是在Swoole下，由于常驻内存，所以请求单例一旦实例化则不会改变，所以这里就将其删除，每次请求后重新实例化

目前TP官方已经支持如下方法，已经不需要修改，但目前尚未合并到5.0分支，如需要可以下载官方master分支

public static function destroy()    {        if (!is_null(self::$instance)) {            self::$instance=null;        }    }

修改如下代码,由于采用命令行模式运行无论什么请求都会被认为是get

/**     * 当前的请求类型     * @access public     * @param bool $method true 获取原始请求类型     * @return string     */    public function method($method = false)        {            if (true === $method) {                // 获取原始请求类型                $this->method = IS_CLI ?(defined('IS_SWOOLE')?((isset($this->server['REQUEST_METHOD'])? $this->server['REQUEST_METHOD'] : isset($_SERVER['REQUEST_METHOD'])?$_SERVER['REQUEST_METHOD']:'GET')):'GET') : (isset($this->server['REQUEST_METHOD']) ? $this->server['REQUEST_METHOD'] : $_SERVER['REQUEST_METHOD']);            } elseif (!$this->method) {                if (isset($_POST[Config::get('var_method')])) {                    $this->method = strtoupper($_POST[Config::get('var_method')]);                    $this->{$this->method}($_POST);                } elseif (isset($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE'])) {                    $this->method = strtoupper($_SERVER['HTTP_X_HTTP_METHOD_OVERRIDE']);                } else {                    $this->method = IS_CLI ?(defined('IS_SWOOLE')?((isset($this->server['REQUEST_METHOD'])? $this->server['REQUEST_METHOD'] : isset($_SERVER['REQUEST_METHOD'])?$_SERVER['REQUEST_METHOD']:'GET')):'GET') : (isset($this->server['REQUEST_METHOD']) ? $this->server['REQUEST_METHOD'] : $_SERVER['REQUEST_METHOD']);                }            }                return $this->method;        }

启动命令

php think swoole start

守护启动

php think swoole start -d

停止服务

php think swoole stop

Demo

<?phpnamespace app\index\controller;use xavier\swoole\Task;use xavier\swoole\Timer;use xavier\swoole\Component\HttpClient;class Index{    public function __construct()    {    }    public function index()    {        return "indexss";    }    public function test()    {        $param = request()->param();        $post  = request()->post();        Task::async(function ($serv, $task_id, $data)use($post) {            $i = 0;            while ($i < 10) {                $i++;                echo $i;                //var_dump($post);                sleep(1);            }        });        //Task::async("\\app\\lib\\Task");        $task=new \app\lib\Task($post,1);        Task::async($task);        \go(function ()use($post) {            $i = 0;            while ($i < 10) {                $i++;                //var_dump($post);                \co::sleep(1);            };        });        return json($post);    }    public function send()    {        $data  = [1, 2, 3,];        $datas = ['a', 'b1232'];        $redt  = HttpClient::instance("http://127.0.0.1:9501")->url('index/index')->gets([            'data'  => $data,            'datas' => $datas,        ]);        var_dump($redt);    }    public function sendhtml()    {        $data  = [1, 2, 3,];        $datas = ['a', 'b1232'];        $redt  = HttpClient::instance("http://127.0.0.1:9501")->url('index/index')->setContentType('html')->test([            'data'  => $data,            'datas' => $datas,        ]);        var_dump($redt);    }    public function gets($data=null,$datas=null)    {        return json(array_merge($data,$datas));    }}

定时器

如下是定时器接口的实现

<?php/** * Created by PhpStorm. * User: xavier * Date: 2018/8/15 * Time: 下午5:45 */namespace app\lib;use xavier\swoole\template\Timer as TimerC;class Timer extends TimerC{    public function _initialize(...$arg)    {        // TODO: Implement _initialize() method.    }    public function run()    {        // TODO: Implement run() method.        var_dump('timer');    }}

只需要在定时器配置中配置定时任务的时间

<?php/** * Created by PhpStorm. * User: xavier * Date: 2018/8/15 * Time: 下午2:14 * 秒 分 时 日 月 星期几 * crontab 格式 * *  *  *  * *    => "类" * *中间一个空格 * 系统定时任务需要在swoole.php中开启 * 自定义定时器不受其影响 */return [    '*/5 * * * * *'=>'\\app\\lib\\Timer',//每5秒执行一次，从第一位一次表示 秒，分，时，日，月];

同时定时任务支持在任务进程执行

<?phpuse xavier\swoole\Timer;//支持回调Timer::tick(1000,function(){    });//支持执行定时器接口实现的类Timer::tick(1000,'\\app\\lib\\Timer');

不建议在任意进程随意使用定时器，建议使用系统配置的定时器，请注意自定义定时器使用和销毁

系统配置的定时器，在第一个worker创建一个定时器，根据任务是否到期需要执行来进行异步任务投递，并不是对当前进程造成阻塞但是需要配置task_work_num

----------------------2018-08-24-------------------------

和think-swoole 官方统一类的命名空间

xavier-swoole会和官方think-swoole保持同步更新

接口文件统一存放在 xavier\swoole\template命名空间下

自定义服务启动

该方法等同于swoole onWorkerStart

使用方法

<?phpnamespace app\lib;/** * Created by PhpStorm. * User: xavier * Date: 2018/8/24 * Time: 上午9:26 * Email:[email protected] */use xavier\swoole\template\WorkerStart as Worker;class WorkerStart extends Worker{    public function _initialize($server, $worker_id)    {        // TODO: Implement _initialize() method.    }    public function run()    {            }}

在swoole.php中配置

'wokerstart'=>'\\app\\lib\\WorkStart'

//闭包方式

'wokerstart'=>function($server, $worker_id){    //如果只在一个进程处理 则可以这样    if (0==$woker_id){        //这样只会在第一个woker进程处理    }}

基于SwooleTable的高速跨进程缓存，只需要更改如下配置，Cache即可变身高速缓存

'cache'                  => [        // 驱动方式        'type'   => 'Table',        // 缓存前缀        'prefix' => '',        // 缓存有效期 0表示永久缓存        'expire' => 0,    ],

------------------2018-10-04--------------------------------

1.支持websocket服务2.编写websocket测试JS库

注：websocket模式，为测试开发阶段，如采用websocket命令启动服务，xavier-swoole的较多特性无法启用，稍后更新中会将http服务和websocket服务整合

启动命令

php think swoole:server

配置文件，WebsSocket的配置文件为server.php,路径和swoole.php路径相同

<?phpreturn [    'host'                  => '0.0.0.0', // 监听地址    'port'                  => 9502, // 监听端口    'mode'                  => '', // 运行模式 默认为SWOOLE_PROCESS    'sock_type'             => '', // sock type 默认为SWOOLE_SOCK_TCP    'app_path'              => getcwd() . '/application', // 应用地址 如果开启了 'daemonize'=>true 必须设置（使用绝对路径）    'file_monitor'          => false, // 是否开启PHP文件更改监控（调试模式下自动开启）    'file_monitor_interval' => 2, // 文件变化监控检测时间间隔（秒）    'file_monitor_path'     => [], // 文件监控目录 默认监控application和config目录    // 可以支持swoole的所有配置参数    'pid_file'              => getcwd()  . '/runtime/swoole.pid',    'log_file'              => getcwd()  . '/runtime/swoole.log',    'task_worker_num'       => 20,    // 'document_root'         => getcwd() . '/public',    // 'enable_static_handler' => true,    'daemonize'                => false,//守护    'worker_num' => 8,    //worker process num    'max_request' => 10000,];

WebSocket通讯数据结构

{    "event":"",//事件名称    "url":"",//目标地址    "arguments":{//客户端投递数据        "post":[],//post数据        "get":[],//get数据        "cookie":[],//cookie数据   }}

详解

event 该参数为事件名称，用于触发客户端事件，即接收服务器推送数据处理指定任务
url，该为访问的目标地址，相当于http模式下http://xxx.com/url
arguments 客户端投递的所有数据，如果希望可以按照原来POST,GET的方式处理数据，可以提交时按照上述方式提交，会自动处理

客户端JS可以参考example里websocketclient.js

服务端发送数据

use xavier\swoole\WebSocketFrame;$client=WebSocketFrame::getInstance();//发送数据给当前请求的客户端$client->pushToClient([]);//参数为数组，字符串，数字//发送给所有客户端$client->pushToClients([]);//参数为数组，字符串，数字$client->getArgs();//获取arguments里的参数$client->getData();//获取客户端发送给的所有数据$client->getServer();//获取当前server$client->getFrame();//获取当前客户端给发送的原始数据

---------------------------------2018-10-09------------------------------------------

新增队列支持

think-queue，是一个非常好用的队列服务，xavier-swoole的队列服务依赖于think-queue，使用方法和think-queue保持一致

主要增加如下功能

采用多进程模式运行或采用Task异步执行
可以指定同时消耗队列任务的进程数量
Task模式和Server共享Task进程，充分利用资源
Process模式采用进程模式，各个任务之间相互隔离，执行一定次数后，重启进程，防止内存泄露

如果任务较多且复杂，推荐采用Process模式

'queue_type'=>'task',//task or process    'queue'=>[        "Index"=>[                      "delay"=>0,//延迟时间                      "sleep"=>3,//休息时间                      "maxTries"=>0,//重试次数                      "nums"=>2//进程数量        ],    ]