Swoole Server介绍

创建一个异步服务器程序，支持TCP、UDP、UnixSocket 3种协议，支持IPv4和IPv6，支持SSL/TLS单向双向证书的隧道加密。使用者无需关注底层实现细节，仅需要设置网络事件的回调函数即可。

swoole_server只能用于php-cli环境，否则会抛出致命错误

构建Server对象

$serv = new swoole_server("127.0.0.1", 9501, SWOOLE_BASE, SWOOLE_SOCK_TCP);

设置运行时参数

$serv->set(array(    'worker_num' => 4,    'daemonize' => true,    'backlog' => 128,));

注册事件回调函数

$serv->on('Connect', 'my_onConnect');$serv->on('Receive', 'my_onReceive');$serv->on('Close', 'my_onClose');

PHP中可以使用4种回调函数的风格

启动服务器

$serv->start();

属性列表

$serv->manager_pid;  //管理进程的PID，通过向管理进程发送SIGUSR1信号可实现柔性重启$serv->master_pid;  //主进程的PID，通过向主进程发送SIGTERM信号可安全关闭服务器$serv->connections; //当前服务器的客户端连接，可使用foreach遍历所有连接

运行流程图

进程/线程结构图

简单Swoole tcp server实例：

$serv = new SwooleServer("127.0.0.1", 9501);//设置服务器参数$serv->set(array(    'worker_num' => 8,   //工作进程数量    'daemonize' => true, //是否作为守护进程));//设置事件回调函数$serv->on('connect', function ($serv, $fd) {    echo "Client:Connect.
";});$serv->on('receive', function ($serv, $fd, $reactor_id, $data) {    $serv->send($fd, 'Swoole: ' . $data);    $serv->close($fd);});$serv->on('close', function ($serv, $fd) {    echo "Client: Close.
";});//启动服务器$serv->start();

Swoole Client介绍

swoole_client提供了tcp/udp socket的客户端的封装代码，使用时仅需 new swoole_client即可。 swoole的socket client对比PHP提供的stream族函数有哪些好处：

• stream函数存在超时设置的陷阱和Bug，一旦没处理好会导致Server端长时间阻塞
• fread有8192长度限制，无法支持UDP的大包
• swoole_client支持waitall，在知道包长度的情况下可以一次取完，不必循环取。
• swoole_client支持UDP connect，解决了UDP串包问题
• swoole_client是纯C的代码，专门处理socket，stream函数非常复杂。swoole_client性能更好

除了普通的同步阻塞+select的使用方法外，swoole_client还支持异步非阻塞回调。

同步阻塞客户端

$client = new swoole_client(SWOOLE_SOCK_TCP);if (!$client->connect('127.0.0.1', 9501, -1)){    exit("connect failed. Error: {$client->errCode}
");}$client->send("hello world
");echo $client->recv();$client->close();

php-fpm/apache环境下只能使用同步客户端
apache环境下仅支持prefork多进程模式，不支持prework多线程

异步非阻塞客户端

$client = new swoole_client(SWOOLE_SOCK_TCP, SWOOLE_SOCK_ASYNC);$client->on("connect", function(swoole_client $cli) {    $cli->send("GET / HTTP/1.1

");});$client->on("receive", function(swoole_client $cli, $data){    echo "Receive: $data";    $cli->send(str_repeat('A', 100)."
");    sleep(1);});$client->on("error", function(swoole_client $cli){    echo "error
";});$client->on("close", function(swoole_client $cli){    echo "Connection close
";});$client->connect('127.0.0.1', 9501);

异步客户端只能使用在cli命令行环境

Swoole HttpServer介绍

swoole-1.7.7增加了内置Http服务器的支持，通过几行代码即可写出一个异步非阻塞多进程的Http服务器。

常见使用场景：因为swoole是在cli命令下执行的，在传统通过nginx+fastcgi模式下很多root的shell无法执行，而使用这个swoole服务器就很好的控制rsync，git，svn等。

$http = new swoole_http_server("127.0.0.1", 9501);$http->on('request', function ($request, $response) {    $response->end("<h1>Hello Swoole. #".rand(1000, 9999)."</h1>");});$http->start();

swoole_http_server对Http协议的支持并不完整，建议仅作为应用服务器。并且在前端增加Nginx作为代理

简单实例：

$serv = new SwooleHttpServer("127.0.0.1", 9502);$serv->on('Request', function($request, $response) {    var_dump($request->get);    var_dump($request->post);    var_dump($request->cookie);    var_dump($request->files);    var_dump($request->header);    var_dump($request->server);    $response->cookie("User", "Swoole");    $response->header("X-Server", "Swoole");    $response->end("<h1>Hello Swoole!</h1>");});$serv->start();

通过使用apache bench工具进行压力测试，在Inter Core-I5 4核 + 8G内存的普通PC机器上，swoole_http_server可以达到近11万QPS。远远超过php-fpm，golang自带http服务器，node.js自带http服务器。性能几乎接近与Nginx的静态文件处理。

ab -c 200 -n 200000 -k http://127.0.0.1:9501

• 需要依赖nghttp2库，下载nghttp2后编译安装
• 使用Http2协议必须开启openssl
• 需要高版本openssl必须支持TLS1.2、ALPN、NPN

./configure --enable-openssl --enable-http2

设置http服务器的open_http2_protocol为true

$serv->set([    'ssl_cert_file' => $ssl_dir . '/ssl.crt',    'ssl_key_file' => $ssl_dir . '/ssl.key',    'open_http2_protocol' => true,]);

nginx+swoole配置

server {    root /data/wwwroot/;    server_name local.swoole.com;    location / {        if (!-e $request_filename) {             proxy_pass http://127.0.0.1:9501;             proxy_http_version 1.1;             proxy_set_header Connection "keep-alive";        }    }}

异步Http/WebSocket客户端

Swoole-1.8.0版本增加了对异步Http/WebSocket客户端的支持。底层是用纯C编写，拥有超高的性能。

异步HTTP客户端目前仍在实验阶段，请谨慎使用

启用Http客户端

• 1.8.6版本之前，需要在编译swoole时增加--enable-async-httpclient来开启此功能。
• swoole_http_client不依赖任何第三方库
• 支持Http-Chunk、Keep-Alive特性，暂不支持form-data格式
• Http协议版本为HTTP/1.1
• gzip压缩格式支持需要依赖zlib库

构造方法

function swoole_http_client->__construct(string $ip, int port, bool $ssl = false);

• $ip 目标服务器的IP地址，可使用swoole_async_dns_lookup查询域名对应的IP地址
• $port 目标服务器的端口，一般http为80，https为443
• $ssl 是否启用SSL/TLS隧道加密，如果目标服务器是https必须设置$ssl参数为true

Swoole WebSocket介绍

swoole-1.7.9 增加了内置的websocket服务器支持，通过几行PHP代码就可以写出一个异步非阻塞多进程的WebSocket服务器。

常见使用场景：我们在使用php开发的时候，原生最不好用的是socket类库了，而在开发IM和及时通信项目是，我们现在有了新的选择后端使用php Swoole WebSocket + 前端 html5 WebSocket；

简单实例：

$server = new swoole_websocket_server("0.0.0.0", 9501);$server->on('open', function (swoole_websocket_server $server, $request) {    echo "server: handshake success with fd{$request->fd}
";});$server->on('message', function (swoole_websocket_server $server, $frame) {    echo "receive from {$frame->fd}:{$frame->data},opcode:{$frame->opcode},fin:{$frame->finish}
";    $server->push($frame->fd, "this is server");});$server->on('close', function ($ser, $fd) {    echo "client {$fd} closed
";});$server->start();

onRequest回调

swoole_websocket_server 继承自 swoole_http_server

• 设置了onRequest回调，websocket服务器也可以同时作为http服务器
• 未设置onRequest回调，websocket服务器收到http请求后会返回http 400错误页面

客户端

• Chrome/Firefox/高版本IE/Safari等浏览器内置了JS语言的WebSocket客户端
• 异步的PHP程序中可以使用SwooleHttpClient作为WebSocket客户端
• apache/php-fpm或其他同步阻塞的PHP程序中可以使用swoole/framework提供的同步WebSocket客户端
• 非WebSocket客户端不能与WebSocket服务器通信

甚至你还可以结合使用socket.io来配合开发

Swoole RedisServer异步客户端介绍

Swoole-1.8.14版本增加一个兼容Redis服务器端协议的Server框架，可基于此框架实现Redis协议的服务器程序。SwooleRedisServer继承自SwooleServer，可调用父类提供的所有方法。

RedisServer不需要设置onReceive回调。实例程序：https://github.com/swoole/swoole-src/blob/master/examples/redis/server.php

可用的客户端

• 任意编程语言的redis客户端，包括PHP的redis扩展和phpredis库
• Swoole扩展提供的异步Redis客户端
• Redis提供的命令行工具，包括redis-cli、redis-benchmark

make -jsudo make installsudo ldconfig

./configure --enable-async-redismake cleanmake -jsudo make install

简单实例：

$redis = new SwooleRedis;$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);        });    });});$cli = new SwooleHttpClient('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异步MySQL介绍

$db = new SwooleMySQL;$server = array(    'host' => '127.0.0.1',    'user' => 'test',    'password' => 'test',    'database' => 'test',);$db->connect($server, function ($db, $result) {    $db->query("show tables", function (SwooleMySQL $db, $result) {        if ($result === false) {            var_dump($db->error, $db->errno);        } elseif ($result === true) {            var_dump($db->affected_rows, $db->insert_id);        } else {            var_dump($result);            $db->close();        }    });});

MySQL长连接

MySQL短连接每次请求操作数据库都需要建立与MySQL服务器建立TCP连接，这是需要时间开销的。TCP连接需要3次网络通信。这样就增加了一定的延时和额外的IO消耗。请求结束后会关闭MySQL连接，还会发生3/4次网络通信。

close操作不会增加响应延时，原因是close后是由操作系统自动进行通信的，应用程序感知不到

长连接就可以避免每次请求都创建连接的开销，节省了时间和IO消耗。提升了PHP程序的性能。

断线重连

在cli环境下，PHP程序需要长时间运行，客户端与MySQL服务器之间的TCP连接是不稳定的。

• MySQL-Server会在一定时间内自动切断连接
• PHP程序遇到空闲期时长时间没有MySQL查询，MySQL-Server也会切断连接回收资源
• 其他情况，在MySQL服务器中执行kill process杀掉某个连接，MySQL服务器重启

这时PHP程序中的MySQL连接就失效了。如果仍然执行mysql_query，就会报一个“MySQL server has gone away”的错误。程序处理不到就直接遇到致命错误并退出了。所以PHP程序中需要断线重连。

有很多人提出了mysql_ping的方案，每次mysql_query进行连接检测或者定时连接检测。这个方案不是最好的。原因是

• mysql_ping需要主动侦测连接，带来了额外的消耗
• 定时执行mysql_ping不能解决问题，如刚刚执行过mysql_ping检测之后，连接就关闭了

最佳的方案是，进行断线重连 。它的原理是：

1. mysql_query执行后检测返回值
2. 如果mysql_query返回失败，检测错误码发现为2006/2013（这2个错误表示连接失败），再执行一次mysql_connect
3. 执行mysql_connect后，重新执行mysql_query，这时必然会成功，因为已经重新建立了连接
4. 如果mysql_query返回成功，那么连接是有效的，这是一次正常的调用

可参考swoole_framework中的代码

MySQL异步

MySQL异步是指将MySQL连接事件驱动化，这样就编程了非阻塞IO。数据库操作并不会阻塞进程，在MySQL-Server返回结果时再执行对应的逻辑。

有几个点需要注意一下：

• 异步MySQL并没有节省SQL执行的时间
• 一个MySQL连接同时只能执行1个SQL，如果异步MySQL存在并发那么必须创建多个MySQL连接

异步回调程序中，异步MySQL并没有提升性能。异步最大的好处是可以高并发，如果并发1万个请求，那么就需要建立1万个MySQL连接，这会给MySQL-Server带来巨大的压力。

MySQL是根据连接数分配资源的，一个连接需要开启一个线程。1000连接那么需要维持1000线程才可以。线程数量增加后，线程间切换会占用大量CPU资源
MySQL短连接反而不会出现此问题，因为短连接在使用完后就释放了。不会占用MySQL-Server的连接资源

虽然应用层代码使用异步回调避免了自身的阻塞，实际上真正的瓶颈是数据库服务器。异步MySQL还带来了额外的编程复杂度，所以除非是特殊场景的需求，否则不建议使用异步MySQL。

如果程序中坚持要使用异步，那么必须是异步MySQL+连接池的形式。超过规定的MySQL最大连接后，应当对SQL请求进行排队，而不是创建新连接，避免大量并发请求导致MySQL服务器崩溃。

MySQL连接池

连接池是可以有效降低MySQL-Server负载的。原理是 连接池使用一个共享资源的模式，如并发100个请求，实际上并不是每个请求的所有时间都在执行SQL查询。这样100个请求，共享20个MySQL连接就可以满足需求了。当一个请求操作完数据库后，开始进入模板渲染等流程，这时就会释放数据库连接给其他的请求使用。

连接池仅在超大型应用中才有价值。普通的应用采用MySQL长连接方案，每个php-fpm创建一个MySQL连接，每台机器开启100个php-fpm进程。如果有10台机器，每台机器并发的请求为100。实际上只需要创建1000个MySQL连接就能满足需求，数据库的压力并不大。即使有100台机器，硬件配置好的存储服务器依然可以承受。

达到数百或者数千台应用服务器时，MySQL服务器就需要维持十万级的连接。这时数据库的压力就会非常大了。连接池技术就可以派上用场了，可以大大降低数据库连接数。

基于swoole的AsyncTask模块实现的连接池是完美方案，编程简单，没有数据同步和锁的问题。甚至可以多个服务共享连接池。缺点是1, 灵活性不如多线程连接池，无法动态增减连接。2, 有一次进程间通信的开销。
node.js/ngx_lua等在多进程的模式下，无法开发出真正的连接池，除非也像swoole_task这样来实现

Swoole AsyncIO异步文件读写介绍

swoole1.6.12后增加了异步文件读写，异步DNS等特性。自此建立了完整的异步并行API。

• swoole_server的Task进程是同步阻塞的，没有EventLoop，因此无法使除定时器之外的用任何异步IO
• signalfd是Linux2.6.27提供文件句柄方式处理信号特性，优点是可以将信号加入到EventLoop中，Reactor操作不会被信号打断提高了性能。缺点是有些同步阻塞的程序可能会出现问题，无法从阻塞中中断，可以使用swoole_async_set关闭signalfd特性

swoole_async_set(array $setting);

$fp = stream_socket_client("tcp://127.0.0.1:80", $code, $msg, 3);$http_request = "GET /index.html HTTP/1.1

";fwrite($fp, $http_request);SwooleEvent::add($fp, function($fp){    echo fread($fp, 8192);    swoole_event_del($fp);    fclose($fp);});SwooleTimer::after(2000, function() {    echo "2000ms timeout
";});SwooleTimer::tick(1000, function() {    echo "1000ms interval
";});

Swoole Task异步任务介绍

swoole 的异步任务task系统可以很方便的为我们在开发的过程中调用异步任务的执行，而无需等待。

常见使用场景：

task模块用来做一些异步的慢速任务，比如webim中发广播，发送邮件，异步订单处理、异步支付处理等。

• task进程必须是同步阻塞的
• task进程支持定时器

node.js 假如有10万个连接，要发广播时，那会循环10万次，这时候程序不能做任何事情，不能接受新的连接，也不能收包发包。

而swoole不同，丢给task进程之后，worker进程可以继续处理新的数据请求。任务完成后会异步地通知worker进程告诉它此任务已经完成。

当然task模块的作用还不仅如此，实现PHP的数据库连接池，异步队列等，还需要进一步挖掘。

简单实例：

$serv = new SwooleServer("127.0.0.1", 9502);$serv->set(array('task_worker_num' => 4));$serv->on('Receive', function($serv, $fd, $from_id, $data) {    $task_id = $serv->task("Async");    echo "Dispath AsyncTask: id=$task_id
";});$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();

swoole_server task异步任务介绍

投递一个异步任务到task_worker池中。此函数是非阻塞的，执行完毕会立即返回。worker进程可以继续处理新的请求。

int swoole_server::task(mixed $data, int $dst_worker_id = -1) $task_id = $serv->task("some data");//swoole-1.8.6或更高版本$serv->task("taskcallback", -1, function (swoole_server $serv, $task_id, $data) {    echo "Task Callback: ";    var_dump($task_id, $data);});

• $data要投递的任务数据，可以为除资源类型之外的任意PHP变量
• $dst_worker_id可以制定要给投递给哪个task进程，传入ID即可，范围是0 - (serv->task_worker_num -1)
• 调用成功，返回值为整数$task_id，表示此任务的ID。如果有finish回应，onFinish回调中会携带$task_id参数
• 调用失败，返回值为false
• 未指定目标Task进程，调用task方法会判断Task进程的忙闲状态，底层只会向处于空闲状态的Task进程投递任务
• 1.8.6版本增加了第三个参数，可以直接设置onFinish函数，如果任务设置了回调函数，Task返回结果时会直接执行制定的回调函数，不再执行Server的onFinish回调

$dst_worker_id在1.6.11+后可用，默认为随机投递
$task_id是从0-42亿的整数，在当前进程内是唯一的
task方法不能在task进程/用户自定义进程中调用

此功能用于将慢速的任务异步地去执行，比如一个聊天室服务器，可以用它来进行发送广播。当任务完成时，在task进程中调用$serv->finish("finish")告诉worker进程此任务已完成。当然swoole_server->finish是可选的。

task底层使用Unix Socket管道通信，是全内存的，没有IO消耗。单进程读写性能可达100万/s，不同的进程使用不同的管道通信，可以最大化利用多核。

AsyncTask功能在1.6.4版本增加，默认不启动task功能，需要在手工设置task_worker_num来启动此功能
task_worker的数量在swoole_server::set参数中调整，如task_worker_num => 64，表示启动64个进程来接收异步任务

配置参数

swoole_server->task/taskwait/finish 3个方法当传入的$data数据超过8K时会启用临时文件来保存。当临时文件内容超过server->package_max_length 时底层会抛出一个警告。

WARN: task package is too big.

server->package_max_length 默认为2M

注意事项

• 使用swoole_server_task必须为Server设置onTask和onFinish回调，否则swoole_server->start会失败
• task操作的次数必须小于onTask处理速度，如果投递容量超过处理能力，task会塞满缓存区，导致worker进程发生阻塞。worker进程将无法接收新的请求
• 使用addProcess添加的用户进程中无法使用task投递任务，请使用sendMessage接口与工作进程通信

函数原型：

string $result = swoole_server->taskwait(mixed $task_data, float $timeout = 0.5, int $dst_worker_id = -1);

taskwait与task方法作用相同，用于投递一个异步的任务到task进程池去执行。与task不同的是taskwait是阻塞等待的，直到任务完成或者超时返回。

$result为任务执行的结果，由$serv->finish函数发出。如果此任务超时，这里会返回false。

taskwait是阻塞接口，如果你的Server是全异步的请使用swoole_server::task和swoole_server::finish,不要使用taskwait
第3个参数可以制定要给投递给哪个task进程，传入ID即可，范围是0 - serv->task_worker_num
$dst_worker_id在1.6.11+后可用，默认为随机投递
taskwait方法不能在task进程中调用

onTask

在task_worker进程内被调用。worker进程可以使用swoole_server_task函数向task_worker进程投递新的任务。当前的Task进程在调用onTask回调函数时会将进程状态切换为忙碌，这时将不再接收新的Task，当onTask函数返回时会将进程状态切换为空闲然后继续接收新的Task。

function onTask((swoole_server $serv, int $task_id, int $src_worker_id, string $data));

• $task_id是任务ID，由swoole扩展内自动生成，用于区分不同的任务。$task_id和$src_worker_id组合起来才是全局唯一的，不同的worker进程投递的任务ID可能会有相同
• $src_worker_id来自于哪个worker进程
• $data 是任务的内容

返回执行结果到worker进程

1.7.2以上的版本，在onTask函数中 return字符串，表示将此内容返回给worker进程。worker进程中会触发onFinish函数，表示投递的task已完成。

• return的变量可以是任意非null的PHP变量

1.7.2以前的版本，需要调用swoole_server->finish()函数将结果返回给worker进程

Swoole 2.0正式版发布了。2.0版本最大的更新是增加了对协程（Coroutine）的支持。正式版已同时支持PHP5和PHP7。基于Swoole2.0协程PHP开发者可以已同步的方式编写代码，底层自动进行协程调度，转变为异步IO。解决了传统异步编程嵌套回调的问题。

与Node.js（ES6+）、Python等语言使用yield/generator、async/await的实现方式相比，Swoole协程无需修改代码添加额外的关键词。

与Go语言的goroutine相比，Swoole协程是内置式的，应用层代码无需添加go关键词启动协程，只需要使用封装好的协程客户端即可，使用更简单。另外Swoole协程的IO组件在底层内置了超时机制，不需要使用复杂的select/chan/timer实现客户端超时。

目前Swoole底层内置的协程客户端组件包括：udpclient、tcpclient、httpclient、redisclient、mysqlclient，基本涵盖了开发者常用的几种通信协议。协程组件只能在服务器的onConnect、onRequest、onReceive、onMessage 回调函数中使用。

使用示例：

$server = new SwooleHttpServer('127.0.0.1', 9501);/*    触发on request事件时，SWOOLE会开辟一个协程栈，对协程栈进行初始化 */$server->on('Request', function ($request, $response) {    $tcp_cli = new SwooleCoroutineClient(SWOOLE_SOCK_TCP);    /**        client在调用connect函数后，SWOOLE会将PHP上下文信息保存到当前栈内        然后将协程挂起，待确认连接成功后，触发epoll事件，然后协程切换        恢复PHP上下文信息，返回结果，继续执行PHP代码     */    if ($tcp_cli->connect('127.0.0.1', 9906) === false) {        $response->end("connect server failed.");        return;    }    $tcp_cli->send('test for the coro');    /*        client在调用recv函数后，SWOOLE会将PHP上下文信息保存到当前栈内        然后将协程挂起待后端svr回包，触发epoll事件，然后协程切换        恢复PHP上下文信息，返回结果，继续执行PHP代码        如果后端在设定的超时时间内，未能回包，返回false        client的errCode定为110     */    $ret = $tcp_cli->recv(100);    $tcp_cli->close();    if ($ret) {        $response->end(" swoole response is ok");    } else {        $response->end(" recv failed error : {$tcp_cli->errCode}");    }});$server->start();

UDP客户端

$udp_cli = new SwooleCoroutineClient(SWOOLE_SOCK_UDP);$ret = $udp_cli->connect('127.0.0.1', 9906);$udp_cli->send('test for the coro');$ret = $udp_cli->recv(100);$udp_cli->close();if ($ret){    $response->end("swoole response is ok");}else{    $response->end("recv failed error : {$client->errCode}");}

MySQL客户端

$swoole_mysql = new SwooleCoroutineMySQL();$swoole_mysql->connect([    'host' => '127.0.0.1',    'user' => 'user',    'password' => 'pass',    'database' => 'test']);$res = $swoole_mysql->query('select sleep(1)');

Redis客户端

$redis = new SwooleCoroutineRedis();$redis->connect('127.0.0.1', 6379);$val = $redis->get('key');

Http客户端

$cli = new SwooleCoroutineHttpClient('127.0.0.1', 80);$cli->setHeaders([    'Host' => "localhost",    "User-Agent" => 'Chrome/49.0.2587.3',    'Accept' => 'text/html,application/xhtml+xml,application/xml',    'Accept-Encoding' => 'gzip',]);$cli->set([ 'timeout' => 1]);$cli->get('/index.php');echo $cli->body;  $cli->close();

Swoole在2.0开始内置协程(Coroutine)的能力，提供了具备协程能力IO接口（统一在名空间SwooleCoroutine*）。

2.0.2或更高版本已支持PHP7

协程可以理解为纯用户态的线程，其通过协作而不是抢占来进行切换。相对于进程或者线程，协程所有的操作都可以在用户态完成，创建和切换的消耗更低。Swoole可以为每一个请求创建对应的协程，根据IO的状态来合理的调度协程，这会带来了以下优势：

1. 开发者可以无感知的用同步的代码编写方式达到异步IO的效果和性能，避免了传统异步回调所带来的离散的代码逻辑和陷入多层回调中导致代码无法维护。

2. 同时由于swoole是在底层封装了协程，所以对比传统的php层协程框架，开发者不需要使用yield关键词来标识一个协程IO操作，所以不再需要对yield的语义进行深入理解以及对每一级的调用都修改为yield，这极大的提高了开发效率。

协程API目前针对了TCP，UDP等主流协议client的封装，包括：

• UDP
• TCP
• HTTP
• Mysql
• Redis

可以满足大部分开发者的需求。对于私有协议，开发者可以使用协程的TCP或者UDP接口去方便的封装。

启用

Prerequisite:

• PHP版本要求：>= 5.5，包括5.5、5.6、7.0、7.1
• 基于swoole_server或者swoole_http_server进行开发，目前只支持在onRequet, onReceive, onConnect事件回调函数中使用协程。

swoole2.0需要通过添加--enable-coroutine编译参数启用协程能力，示例如下：

phpize./configure --with-php-config={path-to-php-config}  --enable-coroutinemakemake install

添加编译参数，swoole server将切换到协程模式。

开启协程模式后，swoole_server和swoole_http_server将以为每一个请求创建对应的协程，开发者可以在onRequet、onReceive、onConnect 3个事件回调中使用协程客户端。

相关配置

在SwooleServer的set方法中增加了一个配置参数max_coro_num，用于配置一个worker进程最多同时处理的协程数目。因为随着worker进程处理的协程数目的增加，其占用的内存也会增加，为了避免超出php的memory_limit限制，请根据实际业务的压测结果设置该值，默认为3000。

使用示例

当代码执行到connect()和recv()函数时，swoole会触发进行协程切换，此时swoole可以去处理其他的事件或者接受新的请求。当此client连接成功或者后端服务回包后，swoole server会恢复协程上下文，代码逻辑继续从切换点开始恢复执行。开发者整个过程不需要关心整个切换过程。具体使用可以参考client的文档。

注意事项

1. 全局变量：协程使得原有的异步逻辑同步化，但是在协程的切换是隐式发生的，所以在协程切换的前后不能保证全局变量以及static变量的一致性。
2. 请勿在以下场景中触发协程切换：
   • 析构函数
   • 魔术方法__call()
3. gcc 4.4下如果在编译swoole的时候（即make阶段），出现gcc warning：dereferencing pointer ‘v.327’ does break strict-aliasing rules、dereferencing type-punned pointer will break strict-aliasing rules 请手动编辑Makefile，将CFLAGS = -Wall -pthread -g -O2替换为CFLAGS = -Wall -pthread -g -O2 -fno-strict-aliasing，然后重新编译make clean;make;make install
4. 与xdebug、xhprof等zend扩展不兼容，例如不能使用xhprof对协程server进行性能分析采样。
5. 在PHP5中，原生的call_user_func和call_user_func_array中无法使用协程client，请使用SwooleCoroutine::call_user_func和SwooleCoroutine::call_user_func_array代替
6. 在PHP7中可直接调用原生的call_user_func和call_user_func_array

bool getDefer();

bool setDefer([bool $is_defer = true]);

mixed recv();

<?php$server = new SwooleHttpServer("127.0.0.1", 9502, SWOOLE_BASE);$server->set([    'worker_num' => 1,]);$server->on('Request', function ($request, $response) {    $tcpclient = new SwooleCoroutineClient(SWOOLE_SOCK_TCP);    $tcpclient->connect('127.0.0.1', 9501，0.5)    $tcpclient->send("hello world
");    $redis = new SwooleCoroutineRedis();    $redis->connect('127.0.0.1', 6379);    $redis->setDefer();    $redis->get('key');    $mysql = new SwooleCoroutineMySQL();    $mysql->connect([        'host' => '127.0.0.1',        'user' => 'user',        'password' => 'pass',        'database' => 'test',    ]);    $mysql->setDefer();    $mysql->query('select sleep(1)');    $httpclient = new SwooleCoroutineHttpClient('0.0.0.0', 9599);    $httpclient->setHeaders(['Host' => "api.mp.qq.com"]);    $httpclient->set([ 'timeout' => 1]);    $httpclient->setDefer();    $httpclient->get('/');    $tcp_res  = $tcpclient->recv();    $redis_res = $redis->recv();    $mysql_res = $mysql->recv();    $http_res  = $httpclient->recv();    $response->end('Test End');});$server->start();

$server = new SwooleHttpServer('127.0.0.1', 9501, SWOOLE_BASE);#1$server->on('Request', function($request, $response) {    $mysql = new SwooleCoroutineMySQL();    #2    $res = $mysql->connect([        'host' => '127.0.0.1',        'user' => 'root',        'password' => 'root',        'database' => 'test',    ]);    #3    if ($res == false) {        $response->end("MySQL connect fail!");        return;    }    $ret = $mysql->query('show tables', 2);    $response->end("swoole response is ok, result=".var_export($ret, true));});$server->start();

Server Software:        swoole-http-serverServer Hostname:        127.0.0.1Server Port:            9501Document Path:          /Document Length:        348 bytesConcurrency Level:      100Time taken for tests:   0.883 secondsComplete requests:      10000Failed requests:        168   (Connect: 0, Receive: 0, Length: 168, Exceptions: 0)Total transferred:      4914560 bytesHTML transferred:       3424728 bytesRequests per second:    11323.69 [#/sec] (mean)Time per request:       8.831 [ms] (mean)Time per request:       0.088 [ms] (mean, across all concurrent requests)Transfer rate:          5434.67 [Kbytes/sec] receivedConnection Times (ms)              min  mean[+/-sd] median   maxConnect:        0    0   0.2      0       2Processing:     0    9   9.6      6      96Waiting:        0    9   9.6      6      96Total:          0    9   9.6      6      96Percentage of the requests served within a certain time (ms)  50%      6  66%      9  75%     11  80%     12  90%     19  95%     27  98%     43  99%     51 100%     96 (longest request)

Swoole Server介绍

创建一个异步服务器程序，支持TCP、UDP、UnixSocket 3种协议，支持IPv4和IPv6，支持SSL/TLS单向双向证书的隧道加密。使用者无需关注底层实现细节，仅需要设置网络事件的回调函数即可。

swoole_server只能用于php-cli环境，否则会抛出致命错误

构建Server对象

$serv = new swoole_server("127.0.0.1", 9501, SWOOLE_BASE, SWOOLE_SOCK_TCP);

设置运行时参数

$serv->set(array(    'worker_num' => 4,    'daemonize' => true,    'backlog' => 128,));

注册事件回调函数

$serv->on('Connect', 'my_onConnect');$serv->on('Receive', 'my_onReceive');$serv->on('Close', 'my_onClose');

PHP中可以使用4种回调函数的风格

启动服务器

$serv->start();

属性列表

$serv->manager_pid;  //管理进程的PID，通过向管理进程发送SIGUSR1信号可实现柔性重启$serv->master_pid;  //主进程的PID，通过向主进程发送SIGTERM信号可安全关闭服务器$serv->connections; //当前服务器的客户端连接，可使用foreach遍历所有连接

运行流程图

进程/线程结构图

简单Swoole tcp server实例：

$serv = new SwooleServer("127.0.0.1", 9501);//设置服务器参数$serv->set(array(    'worker_num' => 8,   //工作进程数量    'daemonize' => true, //是否作为守护进程));//设置事件回调函数$serv->on('connect', function ($serv, $fd) {    echo "Client:Connect.
";});$serv->on('receive', function ($serv, $fd, $reactor_id, $data) {    $serv->send($fd, 'Swoole: ' . $data);    $serv->close($fd);});$serv->on('close', function ($serv, $fd) {    echo "Client: Close.
";});//启动服务器$serv->start();

Swoole Client介绍

swoole_client提供了tcp/udp socket的客户端的封装代码，使用时仅需 new swoole_client即可。 swoole的socket client对比PHP提供的stream族函数有哪些好处：

• stream函数存在超时设置的陷阱和Bug，一旦没处理好会导致Server端长时间阻塞
• fread有8192长度限制，无法支持UDP的大包
• swoole_client支持waitall，在知道包长度的情况下可以一次取完，不必循环取。
• swoole_client支持UDP connect，解决了UDP串包问题
• swoole_client是纯C的代码，专门处理socket，stream函数非常复杂。swoole_client性能更好

除了普通的同步阻塞+select的使用方法外，swoole_client还支持异步非阻塞回调。

同步阻塞客户端

$client = new swoole_client(SWOOLE_SOCK_TCP);if (!$client->connect('127.0.0.1', 9501, -1)){    exit("connect failed. Error: {$client->errCode}
");}$client->send("hello world
");echo $client->recv();$client->close();

php-fpm/apache环境下只能使用同步客户端
apache环境下仅支持prefork多进程模式，不支持prework多线程

异步非阻塞客户端

$client = new swoole_client(SWOOLE_SOCK_TCP, SWOOLE_SOCK_ASYNC);$client->on("connect", function(swoole_client $cli) {    $cli->send("GET / HTTP/1.1

");});$client->on("receive", function(swoole_client $cli, $data){    echo "Receive: $data";    $cli->send(str_repeat('A', 100)."
");    sleep(1);});$client->on("error", function(swoole_client $cli){    echo "error
";});$client->on("close", function(swoole_client $cli){    echo "Connection close
";});$client->connect('127.0.0.1', 9501);

异步客户端只能使用在cli命令行环境

Swoole HttpServer介绍

swoole-1.7.7增加了内置Http服务器的支持，通过几行代码即可写出一个异步非阻塞多进程的Http服务器。

常见使用场景：因为swoole是在cli命令下执行的，在传统通过nginx+fastcgi模式下很多root的shell无法执行，而使用这个swoole服务器就很好的控制rsync，git，svn等。

$http = new swoole_http_server("127.0.0.1", 9501);$http->on('request', function ($request, $response) {    $response->end("<h1>Hello Swoole. #".rand(1000, 9999)."</h1>");});$http->start();

swoole_http_server对Http协议的支持并不完整，建议仅作为应用服务器。并且在前端增加Nginx作为代理

简单实例：

$serv = new SwooleHttpServer("127.0.0.1", 9502);$serv->on('Request', function($request, $response) {    var_dump($request->get);    var_dump($request->post);    var_dump($request->cookie);    var_dump($request->files);    var_dump($request->header);    var_dump($request->server);    $response->cookie("User", "Swoole");    $response->header("X-Server", "Swoole");    $response->end("<h1>Hello Swoole!</h1>");});$serv->start();

通过使用apache bench工具进行压力测试，在Inter Core-I5 4核 + 8G内存的普通PC机器上，swoole_http_server可以达到近11万QPS。远远超过php-fpm，golang自带http服务器，node.js自带http服务器。性能几乎接近与Nginx的静态文件处理。

ab -c 200 -n 200000 -k http://127.0.0.1:9501

• 需要依赖nghttp2库，下载nghttp2后编译安装
• 使用Http2协议必须开启openssl
• 需要高版本openssl必须支持TLS1.2、ALPN、NPN

./configure --enable-openssl --enable-http2

设置http服务器的open_http2_protocol为true

$serv->set([    'ssl_cert_file' => $ssl_dir . '/ssl.crt',    'ssl_key_file' => $ssl_dir . '/ssl.key',    'open_http2_protocol' => true,]);

nginx+swoole配置

server {    root /data/wwwroot/;    server_name local.swoole.com;    location / {        if (!-e $request_filename) {             proxy_pass http://127.0.0.1:9501;             proxy_http_version 1.1;             proxy_set_header Connection "keep-alive";        }    }}

异步Http/WebSocket客户端

Swoole-1.8.0版本增加了对异步Http/WebSocket客户端的支持。底层是用纯C编写，拥有超高的性能。

异步HTTP客户端目前仍在实验阶段，请谨慎使用

启用Http客户端

• 1.8.6版本之前，需要在编译swoole时增加--enable-async-httpclient来开启此功能。
• swoole_http_client不依赖任何第三方库
• 支持Http-Chunk、Keep-Alive特性，暂不支持form-data格式
• Http协议版本为HTTP/1.1
• gzip压缩格式支持需要依赖zlib库

构造方法

function swoole_http_client->__construct(string $ip, int port, bool $ssl = false);

• $ip 目标服务器的IP地址，可使用swoole_async_dns_lookup查询域名对应的IP地址
• $port 目标服务器的端口，一般http为80，https为443
• $ssl 是否启用SSL/TLS隧道加密，如果目标服务器是https必须设置$ssl参数为true

Swoole WebSocket介绍

swoole-1.7.9 增加了内置的websocket服务器支持，通过几行PHP代码就可以写出一个异步非阻塞多进程的WebSocket服务器。

常见使用场景：我们在使用php开发的时候，原生最不好用的是socket类库了，而在开发IM和及时通信项目是，我们现在有了新的选择后端使用php Swoole WebSocket + 前端 html5 WebSocket；

简单实例：

$server = new swoole_websocket_server("0.0.0.0", 9501);$server->on('open', function (swoole_websocket_server $server, $request) {    echo "server: handshake success with fd{$request->fd}
";});$server->on('message', function (swoole_websocket_server $server, $frame) {    echo "receive from {$frame->fd}:{$frame->data},opcode:{$frame->opcode},fin:{$frame->finish}
";    $server->push($frame->fd, "this is server");});$server->on('close', function ($ser, $fd) {    echo "client {$fd} closed
";});$server->start();

onRequest回调

swoole_websocket_server 继承自 swoole_http_server

• 设置了onRequest回调，websocket服务器也可以同时作为http服务器
• 未设置onRequest回调，websocket服务器收到http请求后会返回http 400错误页面

客户端

• Chrome/Firefox/高版本IE/Safari等浏览器内置了JS语言的WebSocket客户端
• 异步的PHP程序中可以使用SwooleHttpClient作为WebSocket客户端
• apache/php-fpm或其他同步阻塞的PHP程序中可以使用swoole/framework提供的同步WebSocket客户端
• 非WebSocket客户端不能与WebSocket服务器通信

甚至你还可以结合使用socket.io来配合开发

Swoole RedisServer异步客户端介绍

Swoole-1.8.14版本增加一个兼容Redis服务器端协议的Server框架，可基于此框架实现Redis协议的服务器程序。SwooleRedisServer继承自SwooleServer，可调用父类提供的所有方法。

RedisServer不需要设置onReceive回调。实例程序：https://github.com/swoole/swoole-src/blob/master/examples/redis/server.php

可用的客户端

• 任意编程语言的redis客户端，包括PHP的redis扩展和phpredis库
• Swoole扩展提供的异步Redis客户端
• Redis提供的命令行工具，包括redis-cli、redis-benchmark

make -jsudo make installsudo ldconfig