協(xié)程篇 | Workerman 5.x 協(xié)程上下文 Context
協(xié)程
協(xié)程是一種比線程更輕量級的用戶級并發(fā)機制,能夠在進程中實現(xiàn)多任務(wù)調(diào)度。它通過手動控制掛起和恢復(fù)來實現(xiàn)協(xié)程間的切換,避免了進程上下文切換的開銷。workerman提供了一個通用的協(xié)程接口,底層自動兼容Swoole/Swow/Fiber驅(qū)動。
提示:此特性需要 workerman>=5.1.0
注意
- 協(xié)程僅支持Swoole Swow Fiber驅(qū)動
- 如果使用Fiber驅(qū)動時需要安裝 composer require revolt/event-loop
- Swoole或者Swow驅(qū)動可以實現(xiàn)PHP阻塞函數(shù)自動協(xié)程化,從而實現(xiàn)原來的同步代碼異步執(zhí)行
- 但Fiber無法像Swoole和Swow那樣自動協(xié)程化,遇到PHP自帶的阻塞函數(shù)時會阻塞整個進程,并不會發(fā)生協(xié)程切換
- 當(dāng)使用Swoole Swow Fiber驅(qū)動時,workerman每次運行onWorkerStart onMessage onConnect onClose等回調(diào)時會自動創(chuàng)建一個協(xié)程來執(zhí)行
- 可以利用$worker->eventLoop=xxx;給不同worker設(shè)置不同的協(xié)程驅(qū)動
案例
coroutine.php文件
<?php
declare(strict_types=1);
use Workerman\Connection\TcpConnection;
use Workerman\Coroutine;
use Workerman\Events\Swoole;
use Workerman\Events\Fiber;
use Workerman\Protocols\Http\Request;
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';
$worker1 = new Worker('http://0.0.0.0:8201');
$worker1->eventLoop = Swoole::class; // 使用Swoole協(xié)程
$worker1->onMessage = function (TcpConnection $connection, Request $request) {
Coroutine::create(function () {
echo file_get_contents("http://www.baidu.com");
});
$connection->send('Swoole ok');
};
$worker2 = new Worker('http://0.0.0.0:8202');
$worker2->eventLoop = Fiber::class; // 使用自帶的Fiber協(xié)程
$worker2->onMessage = function (TcpConnection $connection, Request $request) {
Coroutine::create(function () {
echo file_get_contents("http://www.baidu.com");
});
$connection->send('Fiber ok');
};
Worker::runAll();
啟動服務(wù)
php coroutine.php start
Workerman[worker.php] start in DEBUG mode
-------------------------------------------- WORKERMAN ---------------------------------------------
Workerman/5.1.0 PHP/8.3.15 (Jit off) Linux/5.10.102.1-microsoft-standard-WSL2
--------------------------------------------- WORKERS ----------------------------------------------
event-loop proto user worker listen count state
swoole tcp root none http://0.0.0.0:8201 1 [OK]
fiber tcp root none http://0.0.0.0:8202 1 [OK]
----------------------------------------------------------------------------------------------------
Press Ctrl+C to stop. Start success.
訪問
- Swoole 服務(wù) :http://127.0.0.1:8201
- Fiber 服務(wù) :http://127.0.0.1:8202
協(xié)程提供的接口
interface CoroutineInterface
{
/**
* 創(chuàng)建協(xié)程并立即執(zhí)行
*/
public static function create(callable $callable, ...$data): CoroutineInterface;
/**
* 開始協(xié)程運行
*/
public function start(mixed ...$args): mixed;
/**
* 恢復(fù)協(xié)程運行
*/
public function resume(mixed ...$args): mixed;
/**
* 獲取協(xié)程id
*/
public function id(): int;
/**
* 設(shè)置協(xié)程銷毀時的回調(diào)
*/
public static function defer(callable $callable): void;
/**
* 暫停當(dāng)前協(xié)程
*/
public static function suspend(mixed $value = null): mixed;
/**
* 獲取當(dāng)前協(xié)程
*/
public static function getCurrent(): CoroutineInterface|Fiber|SwowCoroutine|static;
/**
* 判斷當(dāng)前是否是協(xié)程環(huán)境
*/
public static function isCoroutine(): bool;
}
關(guān)于協(xié)程
優(yōu)勢
PHP引入?yún)f(xié)程后最大的作用就是可以用同步的方式編寫異步代碼,避免了回調(diào)地獄,提高了代碼的可讀性和可維護性。
協(xié)程能大幅度提升IO密集型業(yè)務(wù)的彈性,可以用較少的進程提供更大的吞吐量。
劣勢
但是引入?yún)f(xié)程后開發(fā)者需要時刻注意全局變量污染、資源競爭、第三方庫改造等問題,開發(fā)維護成本增大,心智負擔(dān)明顯增加。
引入?yún)f(xié)程后產(chǎn)生了協(xié)程創(chuàng)建、調(diào)度、銷毀、連接池等額外開銷。通過大量壓測數(shù)據(jù)來看,在充分利用CPU的情況下,引入?yún)f(xié)程后極限性能比阻塞式IO下降約10%-20%。
Context 協(xié)程上下文
Context用于在協(xié)程中存儲和傳遞上下文信息,例如數(shù)據(jù)庫連接、用戶信息等。每個協(xié)程有自己的上下文,不同協(xié)程之間的上下文是隔離的。
案例
context.php
<?php
declare(strict_types=1);
use Workerman\Connection\TcpConnection;
use Workerman\Coroutine;
use Workerman\Coroutine\Context;
use Workerman\Events\Swoole;
use Workerman\Protocols\Http\Request;
use Workerman\Worker;
require_once __DIR__ . '/vendor/autoload.php';
$worker = new Worker('http://0.0.0.0:8201');
$worker->eventLoop = Swoole::class; // Or Swow::class or Fiber::class
$worker->onWorkerStart = function () {
Context::set('user_info_onWorkerStart', ['id' => 1, 'name' => 'onWorkerStart']);
};
$worker->onMessage = function (TcpConnection $connection, Request $request) {
// 協(xié)程間context數(shù)據(jù)是隔離的,所以onMessage協(xié)程里獲取onWorkerStart協(xié)程里的user_info_onWorkerStart是null
var_dump(Context::get('user_info_onWorkerStart'));
// 在當(dāng)前協(xié)程設(shè)置context數(shù)據(jù)
Context::set('user_info', ['id' => 2025, 'name' => 'Tinywan']);
// 新建協(xié)程
Coroutine::create(function () use ($connection) {
// 協(xié)程間context數(shù)據(jù)是隔離的,所以新協(xié)程里獲取的是null
$userInfo = Context::get('user_info');
var_dump($userInfo); // 輸出null
Context::set('user_info_new', ['id' => 1, 'name' => 'New Coroutine']);
});
// 協(xié)程間context數(shù)據(jù)是隔離的,所以獲取新協(xié)程里的數(shù)據(jù)是null
var_dump(Context::get('user_info_new')); // 輸出null
// 獲取當(dāng)前協(xié)程的context數(shù)據(jù)
$userInfo = Context::get('user_info'); // 得到['id' => 2025, 'name' => 'Tinywan']
$connection->send(json_encode($userInfo));
};
Worker::runAll();
啟動服務(wù)
php context.php start
訪問服務(wù)
請求地址http://127.0.0.1:8201,響應(yīng)輸出
{
"id": 2025,
"name": "Tinywan"
}
接口說明
interface ContextInterface
{
/**
* 獲取上下文中的值
*/
public static function get(string $name, mixed $default = null): mixed;
/**
* 設(shè)置上下文中的值
*/
public static function set(string $name, mixed $value): void;
/**
* 檢查上下文中是否存在指定名稱的值
*/
public static function has(string $name): bool;
/**
* 重置當(dāng)前協(xié)程上下文
*/
public static function reset(?ArrayObject $data = null): void;
/**
* 銷毀上下文
*/
public static function destroy(): void;
}