前言
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 连接，而是需要预先适配才可以连接。
参数配置
如果要使用 websocket 需要在配置中启用, 将 websocket 下的 enable 设置为 true
'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 内部已经对该地址请求进行了处理
<?php
namespace 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 <448901948@qq.com>
// +----------------------------------------------------------------------
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:499873958@qq.com
*/
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 同样还有许多其他的新功能，这些功能需要大家去摸索尝试。
我也会在接下来的文章中，一起与大家分享我的使用过程。