- Notifications
You must be signed in to change notification settings - Fork3.2k
🚀 Coroutine-based concurrency library for PHP
License
swoole/swoole-src
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Swoole is an event-driven, asynchronous, coroutine-based concurrency library with high performance for PHP.
Run Swoole program byDocker
docker run --rm phpswoole/swoole"php --ri swoole"For details on how to use it, see:How to Use This Image.
$http =newSwoole\Http\Server('127.0.0.1',9501);$http->set(['hook_flags' =>SWOOLE_HOOK_ALL]);$http->on('request',function ($request,$response) {$result = []; Co::join([go(function ()use (&$result) {$result['google'] =file_get_contents("https://www.google.com/"); }),go(function ()use (&$result) {$result['taobao'] =file_get_contents("https://www.taobao.com/"); }) ]);$response->end(json_encode($result));});$http->start();
Co\run(function() {Co\go(function() {while(1) {sleep(1);$fp =stream_socket_client("tcp://127.0.0.1:8000",$errno,$errstr,30);echofread($fp,8192),PHP_EOL; } });Co\go(function() {$fp =stream_socket_server("tcp://0.0.0.0:8000",$errno,$errstr,STREAM_SERVER_BIND |STREAM_SERVER_LISTEN);while(1) {$conn =stream_socket_accept($fp);fwrite($conn,'The local time is' .date('n/j/Y g:i a')); } });Co\go(function() {$redis =newRedis();$redis->connect('127.0.0.1',6379);while(true) {$redis->subscribe(['test'],function ($instance,$channelName,$message) {echo'New redis message:'.$channelName,"==>",$message,PHP_EOL; }); } });Co\go(function() {$redis =newRedis();$redis->connect('127.0.0.1',6379);$count =0;while(true) {sleep(2);$redis->publish('test','hello, world, count='.$count++); } });});
Swoole hooks the blocking io function of PHP at thebottom layer andautomatically converts it to a non-blocking function, so that these functions can be called concurrently in coroutines.
ext-curl(Supportsymfonyandguzzle)ext-redisext-mysqliext-pdo_mysqlext-pdo_pgsqlext-pdo_sqliteext-pdo_oracleext-pdo_odbcstream functions(e.g.stream_socket_client/stream_socket_server), SupportsTCP/UDP/UDG/Unix/SSL/TLS/FileSystem API/Pipeext-socketsext-soapsleep/usleep/time_sleep_untilproc_opengethostbyname/shell_exec/execfread/fopen/fsockopen/fwrite/flock
- IDE Helper & API:https://github.com/swoole/ide-helper
- Twitter:https://twitter.com/phpswoole
- Discord:https://discord.swoole.dev
- 中文社区:https://wiki.swoole.com/#/other/discussion
ProjectAwesome Swoole maintains a curated list of awesome things related to Swoole, including
- Swoole-based frameworks and libraries.
- Packages to integrate Swoole with popular PHP frameworks, including Laravel, Symfony, Slim, and Yii.
- Books, videos, and other learning materials about Swoole.
- Debugging, profiling, and testing tools for developing Swoole-based applications.
- Coroutine-friendly packages and libraries.
- Other Swoole related projects and resources.
The network layer in Swoole is event-based and takes full advantage of the underlying epoll/kqueue implementation, making it really easy to serve millions of requests.
Swoole 4.x uses a brand new engine kernel and now it has a full-time developer team, so we are entering an unprecedented period in PHP history which offers a unique possibility for rapid evolution in performance.
Swoole 4.x or later supports the built-in coroutine with high availability, and you can use fully synchronized code to implement asynchronous performance. PHP code without any additional keywords, the underlying automatic coroutine-scheduling.
Developers can understand coroutines as ultra-lightweight threads, and you can easily create thousands of coroutines in a single process.
Concurrency 10K requests to read data from MySQL takes only 0.2s!
$s =microtime(true);Co\run(function() {for ($c =100;$c--;) {go(function () {$mysql =newSwoole\Coroutine\MySQL;$mysql->connect(['host' =>'127.0.0.1','user' =>'root','password' =>'root','database' =>'test' ]);$statement =$mysql->prepare('SELECT * FROM `user`');for ($n =100;$n--;) {$result =$statement->execute();assert(count($result) >0); } }); }});echo'use' . (microtime(true) -$s) .' s';
You can create multiple services on the single event loop: TCP, HTTP, Websocket and HTTP2, and easily handle thousands of requests.
functiontcp_pack(string$data):string{returnpack('N',strlen($data)) .$data;}functiontcp_unpack(string$data):string{returnsubstr($data,4,unpack('N',substr($data,0,4))[1]);}$tcp_options = ['open_length_check' =>true,'package_length_type' =>'N','package_length_offset' =>0,'package_body_offset' =>4];
$server =newSwoole\WebSocket\Server('127.0.0.1',9501,SWOOLE_BASE);$server->set(['open_http2_protocol' =>true]);// http && http2$server->on('request',function (Swoole\Http\Request$request,Swoole\Http\Response$response) {$response->end('Hello' .$request->rawcontent());});// websocket$server->on('message',function (Swoole\WebSocket\Server$server,Swoole\WebSocket\Frame$frame) {$server->push($frame->fd,'Hello' .$frame->data);});// tcp$tcp_server =$server->listen('127.0.0.1',9502,SWOOLE_TCP);$tcp_server->set($tcp_options);$tcp_server->on('receive',function (Swoole\Server$server,int$fd,int$reactor_id,string$data) {$server->send($fd,tcp_pack('Hello' .tcp_unpack($data)));});$server->start();
Whether you DNS query or send requests or receive responses, all of these are scheduled by coroutine automatically.
go(function () {// http$http_client =newSwoole\Coroutine\Http\Client('127.0.0.1',9501);assert($http_client->post('/','Swoole Http'));var_dump($http_client->body);// websocket$http_client->upgrade('/');$http_client->push('Swoole Websocket');var_dump($http_client->recv()->data);});go(function () {// http2$http2_client =newSwoole\Coroutine\Http2\Client('localhost',9501);$http2_client->connect();$http2_request =newSwoole\Http2\Request;$http2_request->method ='POST';$http2_request->data ='Swoole Http2';$http2_client->send($http2_request);$http2_response =$http2_client->recv();var_dump($http2_response->data);});go(function ()use ($tcp_options) {// tcp$tcp_client =newSwoole\Coroutine\Client(SWOOLE_TCP);$tcp_client->set($tcp_options);$tcp_client->connect('127.0.0.1',9502);$tcp_client->send(tcp_pack('Swoole Tcp'));var_dump(tcp_unpack($tcp_client->recv()));});
Channel is the only way for exchanging data between coroutines, the development combination of theCoroutine + Channel is the famous CSP programming model.
In Swoole development, Channel is usually used for implementing connection pool or scheduling coroutine concurrent.
In the following example, we have a thousand concurrently requests to redis. Normally, this has exceeded the maximum number of Redis connections setting and will throw a connection exception, but the connection pool based on Channel can perfectly schedule requests. We don't have to worry about connection overload.
class RedisPool{/**@var \Swoole\Coroutine\Channel */protected$pool;/** * RedisPool constructor. * @param int $size max connections */publicfunction__construct(int$size =100) {$this->pool =new \Swoole\Coroutine\Channel($size);for ($i =0;$i <$size;$i++) {$redis =new \Swoole\Coroutine\Redis();$res =$redis->connect('127.0.0.1',6379);if ($res ==false) {thrownew \RuntimeException("failed to connect redis server."); }else {$this->put($redis); } } }publicfunctionget():\Swoole\Coroutine\Redis {return$this->pool->pop(); }publicfunctionput(\Swoole\Coroutine\Redis$redis) {$this->pool->push($redis); }publicfunctionclose():void {$this->pool->close();$this->pool =null; }}go(function () {$pool =newRedisPool();// max concurrency num is more than max connections// but it's no problem, channel will help you with schedulingfor ($c =0;$c <1000;$c++) {go(function ()use ($pool,$c) {for ($n =0;$n <100;$n++) {$redis =$pool->get();assert($redis->set("awesome-{$c}-{$n}",'swoole'));assert($redis->get("awesome-{$c}-{$n}") ==='swoole');assert($redis->delete("awesome-{$c}-{$n}"));$pool->put($redis); } }); }});
Some Swoole's clients implement the defer mode for concurrency, but you can still implement it flexible with a combination of coroutines and channels.
go(function () {// User: I need you to bring me some information back.// Channel: OK! I will be responsible for scheduling.$channel =newSwoole\Coroutine\Channel;go(function ()use ($channel) {// Coroutine A: Ok! I will show you the github addr info$addr_info = Co::getaddrinfo('github.com');$channel->push(['A',json_encode($addr_info,JSON_PRETTY_PRINT)]); });go(function ()use ($channel) {// Coroutine B: Ok! I will show you what your code look like$mirror = Co::readFile(__FILE__);$channel->push(['B',$mirror]); });go(function ()use ($channel) {// Coroutine C: Ok! I will show you the date$channel->push(['C',date(DATE_W3C)]); });for ($i =3;$i--;) {list($id,$data) =$channel->pop();echo"From{$id}:\n{$data}\n"; }// User: Amazing, I got every information at earliest time!});
$id =Swoole\Timer::tick(100,function () {echo"⚙️ Do something...\n";});Swoole\Timer::after(500,function ()use ($id) {Swoole\Timer::clear($id);echo"⏰ Done\n";});Swoole\Timer::after(1000,function ()use ($id) {if (!Swoole\Timer::exists($id)) {echo"✅ All right!\n"; }});
go(function () {$i =0;while (true) { Co::sleep(0.1);echo"📝 Do something...\n";if (++$i ===5) {echo"🛎 Done\n";break; } }echo"🎉 All right!\n";});
As of Swoole v4.1.0, we added the ability to transform synchronous PHP network libraries into co-routine libraries using a single line of code.
Simply call theSwoole\Runtime::enableCoroutine() method at the top of your script. In the sample below we connect to php-redis and concurrently read 10k requests in 0.1s:
Swoole\Runtime::enableCoroutine();$s =microtime(true);Co\run(function() {for ($c =100;$c--;) {go(function () { ($redis =newRedis)->connect('127.0.0.1',6379);for ($n =100;$n--;) {assert($redis->get('awesome') ==='swoole'); } }); }});echo'use' . (microtime(true) -$s) .' s';
By calling this method, the Swoole kernel replaces ZendVM stream function pointers. If you usephp_stream based extensions, all socket operations can be dynamically converted to be asynchronous IO scheduled by coroutine at runtime!
Sleep 10K times, read, write, check and delete files 10K times, use PDO and MySQLi to communicate with the database 10K times, create a TCP server and multiple clients to communicate with each other 10K times, create a UDP server and multiple clients to communicate with each other 10K times... Everything works well in one process!
Just see what the Swoole brings, just imagine...
Swoole\Runtime::enableCoroutine();$s =microtime(true);Co\run(function() {// i just want to sleep...for ($c =100;$c--;) {go(function () {for ($n =100;$n--;) {usleep(1000); } }); }// 10K file read and writefor ($c =100;$c--;) {go(function ()use ($c) {$tmp_filename ="/tmp/test-{$c}.php";for ($n =100;$n--;) {$self =file_get_contents(__FILE__);file_put_contents($tmp_filename,$self);assert(file_get_contents($tmp_filename) ===$self); }unlink($tmp_filename); }); }// 10K pdo and mysqli readfor ($c =50;$c--;) {go(function () {$pdo =newPDO('mysql:host=127.0.0.1;dbname=test;charset=utf8','root','root');$statement =$pdo->prepare('SELECT * FROM `user`');for ($n =100;$n--;) {$statement->execute();assert(count($statement->fetchAll()) >0); } }); }for ($c =50;$c--;) {go(function () {$mysqli =newMysqli('127.0.0.1','root','root','test');$statement =$mysqli->prepare('SELECT `id` FROM `user`');for ($n =100;$n--;) {$statement->bind_result($id);$statement->execute();$statement->fetch();assert($id >0); } }); }// php_stream tcp server & client with 12.8K requests in single processfunctiontcp_pack(string$data):string {returnpack('n',strlen($data)) .$data; }functiontcp_length(string$head):int {returnunpack('n',$head)[1]; }go(function () {$ctx =stream_context_create(['socket' => ['so_reuseaddr' =>true,'backlog' =>128]]);$socket =stream_socket_server('tcp://0.0.0.0:9502',$errno,$errstr,STREAM_SERVER_BIND |STREAM_SERVER_LISTEN,$ctx );if (!$socket) {echo"$errstr ($errno)\n"; }else {$i =0;while ($conn =stream_socket_accept($socket,1)) {stream_set_timeout($conn,5);for ($n =100;$n--;) {$data =fread($conn,tcp_length(fread($conn,2)));assert($data ==="Hello Swoole Server #{$n}!");fwrite($conn,tcp_pack("Hello Swoole Client #{$n}!")); }if (++$i ===128) {fclose($socket);break; } } } });for ($c =128;$c--;) {go(function () {$fp =stream_socket_client("tcp://127.0.0.1:9502",$errno,$errstr,1);if (!$fp) {echo"$errstr ($errno)\n"; }else {stream_set_timeout($fp,5);for ($n =100;$n--;) {fwrite($fp,tcp_pack("Hello Swoole Server #{$n}!"));$data =fread($fp,tcp_length(fread($fp,2)));assert($data ==="Hello Swoole Client #{$n}!"); }fclose($fp); } }); }// udp server & client with 12.8K requests in single processgo(function () {$socket =newSwoole\Coroutine\Socket(AF_INET,SOCK_DGRAM,0);$socket->bind('127.0.0.1',9503);$client_map = [];for ($c =128;$c--;) {for ($n =0;$n <100;$n++) {$recv =$socket->recvfrom($peer);$client_uid ="{$peer['address']}:{$peer['port']}";$id =$client_map[$client_uid] = ($client_map[$client_uid] ?? -1) +1;assert($recv ==="Client: Hello #{$id}!");$socket->sendto($peer['address'],$peer['port'],"Server: Hello #{$id}!"); } }$socket->close(); });for ($c =128;$c--;) {go(function () {$fp =stream_socket_client("udp://127.0.0.1:9503",$errno,$errstr,1);if (!$fp) {echo"$errstr ($errno)\n"; }else {for ($n =0;$n <100;$n++) {fwrite($fp,"Client: Hello #{$n}!");$recv =fread($fp,1024);list($address,$port) =explode(':', (stream_socket_get_name($fp,true)));assert($address ==='127.0.0.1' && (int)$port ===9503);assert($recv ==="Server: Hello #{$n}!"); }fclose($fp); } }); }});echo'use' . (microtime(true) -$s) .' s';
As with any open source project, Swoole always provides the most reliable stability and the most powerful features inthe latest released version. Please ensure as much as possible that you are using the latest version.
- Linux, OS X or Cygwin, WSL
- PHP 8.1.0 or later (The higher the version, the better the performance.)
- GCC 4.8 or later
pecl install swoole
Please download the source packages fromReleases or clone a specific version. Don't usemaster branch as it may be in development.
To clone the source code from git specify a tag:
git clone --branch v6.0.0 --single-branch https://github.com/swoole/swoole-src.git&& \cd swoole-src
Compile and install at the source folder:
phpize&& \./configure&& \make&& make install
After compiling and installing to the system successfully, you have to add a new lineextension=swoole.so tophp.ini to enable Swoole extension.
for example:
./configure --enable-openssl --enable-sockets
--enable-opensslor--with-openssl-dir=DIR--enable-sockets--enable-mysqlnd(need mysqlnd, it just for supporting$mysql->escapemethod)--enable-swoole-curl
⚠️ If you upgrade from source, don't forget tomake cleanbefore you upgrade your swoole
pecl upgrade swoolecd swoole-src && git pull && make clean && make && sudo make install- if you change your PHP version, please re-run
phpize clean && phpizethen try to compile
Async clients and API are moved to a separate PHP extensionswoole_async since version 4.3.0, installswoole_async:
git clone https://github.com/swoole/ext-async.gitcd ext-asyncphpize./configuremake -j 4sudo make installEnable it by adding a new lineextension=swoole_async.so tophp.ini.
- On the open sourceTechempower Web Framework benchmarks Swoole used MySQL database benchmark to rank first, and all performance tests ranked in the first echelon.
- You can just runBenchmark Script to quickly test the maximum QPS of Swoole-HTTP-Server on your machine.
Security issues should be reported privately, via email, to the Swoole develop teamteam@swoole.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
Your contribution to Swoole development is very welcome!
You may contribute in the following ways:
- Report issues and feedback
- Submit fixes, features via Pull Request
- Write/polish documentation
This project exists thanks to all the people who contribute. [Contributors].
Demin has been playing with PHP since 2000, focusing on building high-performance, secure web services. He is an occasional conference speaker on PHP and Swoole, and has been working for companies in the states like eBay, Visa and Glu Mobile for years. You may find Demin onTwitter orGitHub.
Apache License Version 2.0 seehttp://www.apache.org/licenses/LICENSE-2.0.html
About
🚀 Coroutine-based concurrency library for PHP
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.