thinkphp 6.0 swoole扩展websocket使用教程

前言

thinkphp即将迎来最新版本6.0，针对目前越来越流行swoole，thinkphp也推出了最新的扩展think-swoole 3.0。

介绍

即将推出的tp6.0，已经适配swoole.并推出think-swoole 3.0，并且默认适配了socketio。和2.0版本在使用方法上面有些许不同。

websocket 继承与http，进行websocket连接之前需要一次http请求，如果当期地址支持websocket则返回101，然后进行连接。也就是说并不是我的服务支持websocket后，请求每个连接地址都可以进行websocket连接，而是需要预先适配才可以连接。

参数配置

'server'           => [        'host'      => '0.0.0.0', // 监听地址

        'port'      => 808, // 监听端口

        'mode'      => swoole_process, // 运行模式 默认为swoole_process

        'sock_type' => swoole_sock_tcp, // sock type 默认为swoole_sock_tcp

        'options'   => [            'pid_file'              => runtime_path() . 'swoole.pid',            'log_file'              => runtime_path() . 'swoole.log',            'daemonize'             => false,            // normally this value should be 1~4 times larger according to your cpu cores.

            'reactor_num'           => swoole_cpu_num(),            'worker_num'            => swoole_cpu_num(),            'task_worker_num'       => 4,//swoole_cpu_num(),

            'enable_static_handler' => true,            'document_root'         => root_path('public'),            'package_max_length'    => 20 * 1024 * 1024,            'buffer_output_size'    => 10 * 1024 * 1024,            'socket_buffer_size'    => 128 * 1024 * 1024,            'max_request'           => 3000,            'send_yield'            => true,

        ],

    ],    'websocket'        => [        'enabled'       => true,// 开启websocket

        'handler'       => handler::class,  //自定义wbesocket绑定类

        'parser'        => parser::class, //自定义解析类

        'route_file'    => base_path() . 'websocket.php',        'ping_interval' => 25000,        'ping_timeout'  => 60000,        'room'          => [            'type'        => tableroom::class,            'room_rows'   => 4096,            'room_size'   => 2048,            'client_rows' => 8192,            'client_size' => 2048,

        ],

    ],    'auto_reload'      => true,    'enable_coroutine' => true,    'resetters'        => [],    'tables'           => [],

handler和parser大大方便了自定义websocket服务，默认系统集成socketio。

本文主要介绍如何使用socketio，这里假设大家有socketio有一定了解和使用基础。

socketio默认会在请求地址后加相应的参数

同时，socketio默认情况下，会认为 http://url/socket.io/ 是支持websocket服务的地址。

而在tp-swoole3.0内部已经对该地址请求进行了处理

<?phpnamespace think\swoole\websocket\socketio;use think\config;use think\cookie;use think\request;class controller{    protected $transports = ['polling', 'websocket'];    public function upgrade(request $request, config $config, cookie $cookie)

    {        if (!in_array($request->param('transport'), $this->transports)) {            return json(

                [                    'code'    => 0,                    'message' => 'transport unknown',

                ],                400

            );

        }        if ($request->has('sid')) {

            $response = response('1:6');

        } else {

            $sid     = base64_encode(uniqid());

            $payload = json_encode(

                [                    'sid'          => $sid,                    'upgrades'     => ['websocket'],                    'pinginterval' => $config->get('swoole.websocket.ping_interval'),                    'pingtimeout'  => $config->get('swoole.websocket.ping_timeout'),

                ]

            );

            $cookie->set('io', $sid);

            $response = response('97:0' . $payload . '2:40');

        }        return $response->contenttype('text/plain');

    }    public function reject(request $request)

    {        return json(

            [                'code'    => 3,                'message' => 'bad request',

            ],            400

        );

    }

}

tp6.0,插件注册采用了service方式进行了注册，可在tp-swoole 服务注册文件中查看路由注册信息,如果想自定义链接规则，则可以覆盖该路由。

<?php// +----------------------------------------------------------------------// | thinkphp [ we can do it just think it ]// +----------------------------------------------------------------------// | copyright (c) 2006-2018 http://thinkphp.cn all rights reserved.// +----------------------------------------------------------------------// | licensed ( http://www.apache.org/licenses/license-2.0 )// +----------------------------------------------------------------------// | author: yunwuxin <[e-mail]>// +----------------------------------------------------------------------namespace think\swoole;use swoole\http\server as httpserver;use swoole\websocket\server as websocketserver;use think\app;use think\route;use think\swoole\command\server as servercommand;use think\swoole\facade\server;use think\swoole\websocket\socketio\controller;use think\swoole\websocket\socketio\middleware;class service extends \think\service{    protected $iswebsocket = false;    /**

     * @var httpserver | websocketserver

     */

    protected static $server;    public function register()

    {        $this->iswebsocket = $this->app->config->get('swoole.websocket.enabled', false);        $this->app->bind(server::class, function () {            if (is_null(static::$server)) {                $this->createswooleserver();

            }            return static::$server;

        });        $this->app->bind('swoole.server', server::class);        $this->app->bind(swoole::class, function (app $app) {            return new swoole($app);

        });        $this->app->bind('swoole', swoole::class);

    }    public function boot(route $route)

    {        $this->commands(servercommand::class);        if ($this->iswebsocket) {

            $route->group(function () use ($route) {

                $route->get('socket.io/', '@upgrade');

                $route->post('socket.io/', '@reject');

            })->prefix(controller::class)->middleware(middleware::class);

        }

    }    /**

     * create swoole server.

     */

    protected function createswooleserver()

    {

        $server     = $this->iswebsocket ? websocketserver::class : httpserver::class;

        $config     = $this->app->config;

        $host       = $config->get('swoole.server.host');

        $port       = $config->get('swoole.server.port');

        $sockettype = $config->get('swoole.server.socket_type', swoole_sock_tcp);

        $mode       = $config->get('swoole.server.mode', swoole_process);        static::$server = new $server($host, $port, $mode, $sockettype);

        $options = $config->get('swoole.server.options');        static::$server->set($options);

    }

}

socketio默认使用demo

<!doctype html><html lang="en"><head>

    <meta charset="utf-8">

    <title>title</title>

    <script src="./static/js/socket.io.js"></script></head><body><script>

    const socket = io('http://localhost:808');

    socket.emit("test", "your message");

    socket.on("test",function(res){console.log(res)});</script></body></html>

websocket路由配置方法

在app目录下新建websocket.php文件,其中需要注意，由于使用了反射，闭包参数名称不能随意定义，不然无法注入。第一个参数是websocket，是当前websocket的server对象，第二个参数data是客户端发送的数据。其中socketio emit的第一个参数和websocket::on的第一个参数一致，作为事件名称。

<?php/**

 * author:xavier yang

 * date:2019/6/5

 * email:[e-mail]

 */use \think\swoole\facade\websocket;

websocket::on("test", function (\think\swoole\websocket $websocket, $data) {    //var_dump($class);

    $websocket->emit("test", "asd");

});

websocket::on("test1", function ($websocket, $data) {

    $websocket->emit("test", "asd");

});

websocket::on("join", function (\think\swoole\websocket $websocket, $data) {

    $websocket->join("1");

});

参考如上方法即可使用全新的websocket服务。当然tp-swoole3.0同样还有许多其他的新功能，这些功能需要大家去摸索尝试。
我也会在接下来的文章中，一起与大家分享我的使用过程。