1.快速起步
Swoole的绝大部分功能只能用于cli命令行环境,执行下面环境 php /path/to/your_file.php
2.进程管理
默认使用SWOOLE_PROCESS模式,因此会额外创建Master和Manager两个进程。 在设置worker_num之后,实际会出现2 + worker_num个进程 服务器启动后,可以通过kill 主进程ID来结束所有工作进程
3.创建TCP服务器
//创建Server对象,监听 127.0.0.1:9501端口 $serv = new swoole_server("127.0.0.1", 9501); //监听连接进入事件 $serv->on('connect', function ($serv, $fd) { echo "Client: Connect.\n"; }); //监听数据接收事件 $serv->on('receive', function ($serv, $fd, $from_id, $data) { $serv->send($fd, "Server: ".$data); }); //监听连接关闭事件 $serv->on('close', function ($serv, $fd) { echo "Client: Close.\n"; }); //启动服务器 $serv->start();
swoole_server是异步服务器,所以是通过监听事件的方式来编写程序的。 当对应的事件发生时底层会主动回调指定的PHP函数。 如当有新的TCP连接进入时会执行onConnect事件回调,当某个连接向服务器发送数据时会回调onReceive函数。 服务器可以同时被成千上万个客户端连接,$fd就是客户端连接的唯一标识符 调用 $server->send() 方法向客户端连接发送数据,参数就是$fd客户端标识符 调用 $server->close() 方法可以强制关闭某个客户端连接 客户端可能会主动断开连接,此时会触发onClose事件回调
https://wiki.swoole.com/wiki/page/476.html
4.创建UDP服务器
//创建Server对象,监听 127.0.0.1:9502端口,类型为SWOOLE_SOCK_UDP $serv = new swoole_server("127.0.0.1", 9502, SWOOLE_PROCESS, SWOOLE_SOCK_UDP); //监听数据接收事件 $serv->on('Packet', function ($serv, $data, $clientInfo) { $serv->sendto($clientInfo['address'], $clientInfo['port'], "Server ".$data); var_dump($clientInfo); }); //启动服务器 $serv->start();
UDP服务器与TCP服务器不同,UDP没有连接的概念。 启动Server后,客户端无需Connect,直接可以向Server监听的9502端口发送数据包。 对应的事件为onPacket。 $clientInfo是客户端的相关信息,是一个数组,有客户端的IP和端口等内容 调用 $server->sendto 方法向客户端发送数据 UDP服务器可以使用netcat -u 来连接测试 netcat -u 127.0.0.1 9502 hello Server: hello
https://wiki.swoole.com/wiki/page/477.html
5.创建Web服务器
$http = new swoole_http_server("0.0.0.0", 9501); $http->on('request', function ($request, $response) { var_dump($request->get, $request->post); $response->header("Content-Type", "text/html; charset=utf-8"); $response->end("<h1>Hello Swoole. #".rand(1000, 9999)."</h1>"); }); $http->start();
Http服务器只需要关注请求响应即可,所以只需要监听一个onRequest事件。当有新的Http请求进入就会触发此事件。 事件回调函数有2个参数,一个是$request对象,包含了请求的相关信息,如GET/POST请求的数据。 另外一个是response对象,对request的响应可以通过操作response对象来完成。$response->end()方法表示输出一段HTML内容,并结束此请求。 0.0.0.0 表示监听所有IP地址,一台服务器可能同时有多个IP, 如127.0.0.1本地回环IP、192.168.1.100局域网IP、210.127.20.2 外网IP,这里也可以单独指定监听一个IP 9501 监听的端口,如果被占用程序会抛出致命错误,中断执行。 启动服务 php http_server.php 可以打开浏览器,访问http://127.0.0.1:9501查看程序的结果。 也可以使用apache ab工具对服务器进行压力测试
https://wiki.swoole.com/wiki/page/478.html
6.创建WebSocket服务器
//创建websocket服务器对象,监听0.0.0.0:9502端口 $ws = new swoole_websocket_server("0.0.0.0", 9502); //监听WebSocket连接打开事件 $ws->on('open', function ($ws, $request) { var_dump($request->fd, $request->get, $request->server); $ws->push($request->fd, "hello, welcome\n"); }); //监听WebSocket消息事件 $ws->on('message', function ($ws, $frame) { echo "Message: {$frame->data}\n"; $ws->push($frame->fd, "server: {$frame->data}"); }); //监听WebSocket连接关闭事件 $ws->on('close', function ($ws, $fd) { echo "client-{$fd} is closed\n"; }); $ws->start();
WebSocket服务器是建立在Http服务器之上的长连接服务器,客户端首先会发送一个Http的请求与服务器进行握手。 握手成功后会触发onOpen事件,表示连接已就绪,onOpen函数中可以得到$request对象, 包含了Http握手的相关信息,如GET参数、Cookie、Http头信息等。 建立连接后客户端与服务器端就可以双向通信了。 客户端向服务器端发送信息时,服务器端触发onMessage事件回调 服务器端可以调用$server->push()向某个客户端(使用$fd标识符)发送消息 服务器端可以设置onHandShake事件回调来手工处理WebSocket握手 可以使用Chrome浏览器进行测试,JS代码为: var wsServer = 'ws://127.0.0.1:9502'; var websocket = new WebSocket(wsServer); websocket.onopen = function (evt) { console.log("Connected to WebSocket server."); }; websocket.onclose = function (evt) { console.log("Disconnected"); }; websocket.onmessage = function (evt) { console.log('Retrieved data from server: ' + evt.data); }; websocket.onerror = function (evt, e) { console.log('Error occured: ' + evt.data); }; 不能直接使用swoole_client与websocket服务器通信,swoole_client是TCP客户端 必须实现WebSocket协议才能和WebSocket服务器通信,可以使用swoole/framework提供的PHP WebSocket客户端 Comet WebSocket服务器除了提供WebSocket功能之外,实际上也可以处理Http长连接。只需要增加onRequest事件监听即可实现Comet方案Http长轮询。
https://wiki.swoole.com/wiki/page/479.html
7.设置定时器
swoole提供了类似JavaScript的setInterval/setTimeout异步高精度定时器,粒度为毫秒级。使用也非常简单。 //每隔2000ms触发一次 swoole_timer_tick(2000, function ($timer_id) { echo "tick-2000ms\n"; }); //3000ms后执行此函数 swoole_timer_after(3000, function () { echo "after 3000ms.\n"; }); swoole_timer_tick函数就相当于setInterval,是持续触发的 swoole_timer_after函数相当于setTimeout,仅在约定的时间触发一次 swoole_timer_tick和swoole_timer_after函数会返回一个整数,表示定时器的ID 可以使用 swoole_timer_clear 清除此定时器,参数为定时器ID
https://wiki.swoole.com/wiki/page/480.html
8.执行异步任务
在Server程序中如果需要执行很耗时的操作,比如一个聊天服务器发送广播, Web服务器中发送邮件。如果直接去执行这些函数就会阻塞当前进程,导致服务器响应变慢。 Swoole提供了异步任务处理的功能,可以投递一个异步任务到TaskWorker进程池中执行,不影响当前请求的处理速度 基于第一个TCP服务器,只需要增加onTask和onFinish2个事件回调函数即可。 另外需要设置task进程数量,可以根据任务的耗时和任务量配置适量的task进程。 $serv = new swoole_server("127.0.0.1", 9501); //设置异步任务的工作进程数量 $serv->set(array('task_worker_num' => 4)); $serv->on('receive', function($serv, $fd, $from_id, $data) { //投递异步任务 $task_id = $serv->task($data); echo "Dispath AsyncTask: id=$task_id\n"; }); //处理异步任务 $serv->on('task', function ($serv, $task_id, $from_id, $data) { echo "New AsyncTask[id=$task_id]".PHP_EOL; //返回任务执行的结果 $serv->finish("$data -> OK"); }); //处理异步任务的结果 $serv->on('finish', function ($serv, $task_id, $data) { echo "AsyncTask[$task_id] Finish: $data".PHP_EOL; }); $serv->start(); 调用$serv->task()后,程序立即返回,继续向下执行代码。onTask回调函数Task进程池内被异步执行。 执行完成后调用$serv->finish()返回结果。 finish操作是可选的,也可以不返回任何结果
https://wiki.swoole.com/wiki/page/481.html
9.创建同步TCP客户端
$client = new swoole_client(SWOOLE_SOCK_TCP); //连接到服务器 if (!$client->connect('127.0.0.1', 9501, 0.5)) { die("connect failed."); } //向服务器发送数据 if (!$client->send("hello world")) { die("send failed."); } //从服务器接收数据 $data = $client->recv(); if (!$data) { die("recv failed."); } echo $data; //关闭连接 $client->close(); 创建一个TCP的同步客户端,此客户端可以用于连接到我们第一个示例的TCP服务器。 向服务器端发送一个hello world字符串,服务器会返回一个 Server: hello world字符串。 这个客户端是同步阻塞的,connect/send/recv 会等待IO完成后再返回。同步阻塞操作并不消耗CPU资源,IO操作未完成当前进程会自动转入sleep模式, 当IO完成后操作系统会唤醒当前进程,继续向下执行代码。 TCP需要进行3次握手,所以connect至少需要3次网络传输过程 在发送少量数据时$client->send都是可以立即返回的。发送大量数据时,socket缓存区可能会塞满,send操作会阻塞。 recv操作会阻塞等待服务器返回数据,recv耗时等于服务器处理时间+网络传输耗时之合 执行程序 php client.php Server: hello world
https://wiki.swoole.com/wiki/page/482.html
10.创建异步TCP客户端
$client = new swoole_client(SWOOLE_SOCK_TCP, SWOOLE_SOCK_ASYNC); //注册连接成功回调 $client->on("connect", function($cli) { $cli->send("hello world\n"); }); //注册数据接收回调 $client->on("receive", function($cli, $data){ echo "Received: ".$data."\n"; }); //注册连接失败回调 $client->on("error", function($cli){ echo "Connect failed\n"; }); //注册连接关闭回调 $client->on("close", function($cli){ echo "Connection close\n"; }); //发起连接 $client->connect('127.0.0.1', 9501, 0.5); 异步客户端与上一个同步TCP客户端不同,异步客户端是非阻塞的。可以用于编写高并发的程序。 swoole官方提供的redis-async、mysql-async都是基于异步swoole_client实现的。 异步客户端需要设置回调函数,有4个事件回调必须设置onConnect、onError、onReceive、onClose。 分别在客户端连接成功、连接失败、收到数据、连接关闭时触发。 $client->connect() 发起连接的操作会立即返回,不存在任何等待。 当对应的IO事件完成后,swoole底层会自动调用设置好的回调函数。 异步客户端只能用于cli环境
https://wiki.swoole.com/wiki/page/483.html
11.网络通信协议设计
为什么需要通信协议 TCP协议在底层机制上解决了UDP协议的顺序和丢包重传问题。 但相比UDP又带来了新的问题,TCP协议是流式的,数据包没有边界。应用程序使用TCP通信就会面临这些难题。 因为TCP通信是流式的,在接收1个大数据包时,可能会被拆分成多个数据包发送。 多次Send底层也可能会合并成一次进行发送。这里就需要2个操作来解决: 分包:Server收到了多个数据包,需要拆分数据包 合包:Server收到的数据只是包的一部分,需要缓存数据,合并成完整的包 所以TCP网络通信时需要设定通信协议。常见的TCP网络通信协议有HTTP、 HTTPS、FTP、SMTP、POP3、IMAP、SSH、Redis、Memcache、MySQL 。 如果要设计一个通用协议的Server,那么就要按照通用协议的标准去处理网络数据。 除了通用协议外还可以自定义协议。Swoole支持了2种类型的自定义网络通信协议。 EOF结束符协议 EOF协议处理的原理是每个数据包结尾加一串特殊字符表示包已结束。 如memcache、ftp、stmp都使用\r\n作为结束符。发送数据时只需要在包末尾增加\r\n即可。 使用EOF协议处理,一定要确保数据包中间不会出现EOF,否则会造成分包错误。 在swoole_server和swoole_client的代码中只需要设置2个参数就可以使用EOF协议处理。 $server->set(array( 'open_eof_split' => true, 'package_eof' => "\r\n", )); $client->set(array( 'open_eof_split' => true, 'package_eof' => "\r\n", ));
固定包头+包体协议 固定包头的协议非常通用,在BAT的服务器程序中经常能看到。这种协议的特点是一个数据包总是由包头+包体2部分组成。 包头由一个字段指定了包体或整个包的长度,长度一般是使用2字节/4字节整数来表示。 服务器收到包头后,可以根据长度值来精确控制需要再接收多少数据就是完整的数据包。Swoole的配置可以很好的支持这种协议,可以灵活地设置4项参数应对所有情况。 Swoole的Server和异步Client都是在onReceive回调函数中处理数据包,当设置了协议处理后, 只有收到一个完整数据包时才会触发onReceive事件。同步客户端在设置了协议处理后, 调用 $client->recv() 不再需要传入长度,recv函数在收到完整数据包或发生错误后返回。 $server->set(array( 'open_length_check' => true, 'package_max_length' => 81920, 'package_length_type' => 'n', //see php pack() 'package_length_offset' => 0, 'package_body_offset' => 2, ));
https://wiki.swoole.com/wiki/page/484.html
12.使用异步客户端
PHP提供的MySQL、CURL、Redis 等客户端是同步的,会导致服务器程序发生阻塞。 Swoole提供了常用的异步客户端组件,来解决此问题。编写纯异步服务器程序时,可以使用这些异步客户端。 异步客户端可以配合使用SplQueue实现连接池,以达到长连接复用的目的。 在实际项目中可以使用PHP提供的Yield/Generator语法实现半协程的异步框架。 也可以基于Promises简化异步程序的编写。 MySQL $db = new Swoole\MySQL; $server = array( 'host' => '127.0.0.1', 'user' => 'test', 'password' => 'test', 'database' => 'test', ); $db->connect($server, function ($db, $result) { $db->query("show tables", function (Swoole\MySQL $db, $result) { var_dump($result); $db->close(); }); }); 与mysqli和PDO等客户端不同,Swoole\MySQL是异步非阻塞的,连接服务器、执行SQL时, 需要传入一个回调函数。connect的结果不在返回值中,而是在回调函数中。 query的结果也需要在回调函数中进行处理。 Redis $redis = new Swoole\Redis; $redis->connect('127.0.0.1', 6379, function ($redis, $result) { $redis->set('test_key', 'value', function ($redis, $result) { $redis->get('test_key', function ($redis, $result) { var_dump($result); }); }); }); Http $cli = new Swoole\Http\Client('127.0.0.1', 80); $cli->setHeaders(array('User-Agent' => 'swoole-http-client')); $cli->setCookies(array('test' => 'value')); $cli->post('/dump.php', array("test" => 'abc'), function ($cli) { var_dump($cli->body); $cli->get('/index.php', function ($cli) { var_dump($cli->cookies); var_dump($cli->headers); }); }); Swoole\Http\Client的作用与CURL完全一致,它完整实现了Http客户端的相关功能。具体请参考 HttpClient文档 其他客户端 Swoole底层目前只提供了最常用的MySQL、Redis、Http异步客户端,如果你的应用程序中需要实现其他协议客户端, 如Kafka、AMQP等协议,可以基于Swoole\Client异步TCP客户端,开发相关协议解析代码,来自行实现。
https://wiki.swoole.com/wiki/page/788.html
13.多进程共享数据
由于PHP语言不支持多线程,因此Swoole使用多进程模式。 在多进程模式下存在进程内存隔离,在工作进程内修改global全局变量和超全局变量时,在其他进程是无效的。 $fds = array(); $server->on('connect', function ($server, $fd){ echo "connection open: {$fd}\n"; global $fds; $fds[] = $fd; var_dump($fds); }); $fds 虽然是全局变量,但只在当前的进程内有效。 Swoole服务器底层会创建多个Worker进程,在var_dump($fds)打印出来的值,只有部分连接的fd。 对应的解决方案就是使用外部存储服务: 数据库,如:MySQL、MongoDB 缓存服务器,如:Redis、Memcache 磁盘文件,多进程并发读写时需要加锁 普通的数据库和磁盘文件操作,存在较多IO等待时间。因此推荐使用: Redis 内存数据库,读写速度非常快 /dev/shm 内存文件系统,读写操作全部在内存中完成,无IO消耗,性能极高 除了使用存储之外,还可以使用共享内存来保存数据
共享内存 PHP提供了多套共享内存的扩展,但实际上真正在实际项目中可用的并不多。 shm 扩展 提供了shm_put_var/shm_get_var共享内存读写方法。但其底层实现使用链表结构,在保存大量数值时时间复杂度为O(N),性能非常差。并且读写数据没有加锁,存在数据同步问题,需要使用者自行加锁。 不推荐使用 shmop 扩展 提供了shmop_read/shmop_write共享内存读写方法。仅提供了基础的共享内存操作指令,并未提供数据结构和封装。不适合普通开发者使用。 不推荐使用 apcu 扩展 提供了apc_fetch/apc_store可以使用Key-Value方式访问。 APC扩展总体上是可以用于实际项目的,缺点是锁的粒度较粗,在大量并发读写操作时锁的碰撞较为密集。 yac扩展,不适合用于保存数据,其设计原理导致存在一定的数据miss率,仅作为缓存,不可作为存储 swoole_table Swoole官方提供的共享内存读写工具,提供了Key-Value操作方式,使用非常简单。 底层使用自旋锁实现,在大量并发读写操作时性能依然非常强劲。推荐使用。 swoole_table仍然存在一个两个缺点,使用时需要根据实际情况来选择。 提前申请内存,swoole_table在使用前就需要分配好内存,可能会占用较多内存 无法动态扩容,swoole_table内存管理是静态的,不支持动态申请新内存,因此一个Table在设置为N行之后,不能超过限制
https://wiki.swoole.com/wiki/page/836.html