協程

webman 是基於 workerman 開發的，所以 webman 可以使用 workerman 的協程特性。
協程支持 Swoole Swow 和 Fiber 三種驅動。

前提條件

• PHP >= 8.1
• Workerman >= 5.1.0 (composer require workerman/workerman ~v5.1)
• webman-framework >= 2.1 (composer require workerman/webman-framework ~v2.1)
• 安裝了 swoole 或者 swow 擴展，或者安裝了 composer require revolt/event-loop (Fiber)
• 協程默認是關閉的，需要單獨設置 eventLoop 開啟

開啟方法

webman 支持為不同的進程開啟不同的驅動，所以你可以在 config/process.php 中通過 eventLoop 配置協程驅動：

return [
    'webman' => [
        'handler' => Http::class,
        'listen' => 'http://0.0.0.0:8787',
        'count' => 1,
        'user' => '',
        'group' => '',
        'reusePort' => false,
        'eventLoop' => '', // 默認為空自動選擇 Select 或者 Event，不開啟協程
        'context' => [],
        'constructor' => [
            'requestClass' => Request::class,
            'logger' => Log::channel('default'),
            'appPath' => app_path(),
            'publicPath' => public_path()
        ]
    ],
    'my-coroutine' => [
        'handler' => Http::class,
        'listen' => 'http://0.0.0.0:8686',
        'count' => 1,
        'user' => '',
        'group' => '',
        'reusePort' => false,
        // 開啟協程需要設置為 Workerman\Events\Swoole::class 或者 Workerman\Events\Swow::class 或者 Workerman\Events\Fiber::class
        'eventLoop' => Workerman\Events\Swoole::class,
        'context' => [],
        'constructor' => [
            'requestClass' => Request::class,
            'logger' => Log::channel('default'),
            'appPath' => app_path(),
            'publicPath' => public_path()
        ]
    ]

    // ... 其它配置省略 ...
];

提示
webman 可以為不同的進程設置不同的 eventLoop，這意味著你可以選擇性為特定進程開啟協程。
例如上面配置中 8787 端口的服務沒有開啟協程，8686 端口的服務開啟了協程，配合 nginx 轉發可以實現協程和非協程混合部署。

協程示例

<?php
namespace app\controller;

use support\Response;
use Workerman\Coroutine;
use Workerman\Timer;

class IndexController
{
    public function index(): Response
    {
        Coroutine::create(function(){
            Timer::sleep(1.5);
            echo "hello coroutine\n";
        });
        return response('hello webman');
    }

}

當 eventLoop 為 Swoole Swow Fiber 時，webman 會為每個請求創建一個協程來運行，在處理請求時可以繼續創建新的協程執行業務代碼。

協程限制

• 當使用 Swoole Swow 為驅動時，業務遇到阻塞 IO 協程會自動切換，能實現同步代碼異步執行。
• 當使用 Fiber 驅動時，遇到阻塞 IO 時，協程不會發生切換，進程進入阻塞狀態。
• 使用協程時，不能多個協程同時對同一個資源進行操作，例如數據庫連接，文件操作等，這可能會引起資源競爭，正確的用法是使用連接池或者鎖來保護資源。
• 使用協程時，不能將請求相關的狀態數據存儲在全局變量或者靜態變量中，這可能會引起全局數據污染，正確的用法是使用協程上下文 context 來存取它們。

其它注意事項

Swow 底層會自動 hook php 的阻塞函數，但是因為這種 hook 影響了 PHP 的某些默認行為，所以在你沒有使用 Swow 但卻裝了 Swow 時可能會產生 bug。

所以建議：

• 如果你的項目沒有使用 Swow 時，請不要安裝 Swow 擴展
• 如果你的項目使用了 Swow，請設置 eventLoop 為 Workerman\Events\Swow::class

協程上下文

協程環境禁止將 請求相關 的狀態信息存儲在全局變量或者靜態變量中，因為這可能會導致全局變量污染，例如

<?php

namespace app\controller;

use support\Request;
use Workerman\Timer;

class TestController
{
    protected static $name = '';

    public function index(Request $request)
    {
        static::$name = $request->get('name');
        Timer::sleep(5);
        return static::$name;
    }
}

注意
協程環境下並非禁止使用全局變量或靜態變量，而是禁止使用全局變量或靜態變量存儲 請求相關的狀態數據。
例如全局配置、數據庫連接、一些類的單例等需要全局共享的對象數據是推薦用全局變量或靜態變量存儲的。

將進程數設置為 1，當我們連續發起兩個請求時
http://127.0.0.1:8787/test?name=lilei
http://127.0.0.1:8787/test?name=hanmeimei
我們期望兩個請求返回的結果分別是 lilei 和 hanmeimei，但實際上返回的都是 hanmeimei。
這是因為第二個請求將靜態變量 $name 覆蓋了，第一個請求睡眠結束時返回時靜態變量 $name 已經變成 hanmeimei。

正確的用法應該是使用 context 存儲請求狀態數據

<?php

namespace app\controller;

use support\Request;
use support\Context;
use Workerman\Timer;

class TestController
{
    public function index(Request $request)
    {
        Context::set('name', $request->get('name'));
        Timer::sleep(5);
        return Context::get('name');
    }
}

support\Context 類用於存儲協程上下文數據，當協程執行完畢後，相應的 context 數據會自動刪除。
協程環境裡，因為每個請求都是單獨的協程，所以當請求完成時 context 數據會自動銷毀。
非協程環境裡，context 會在請求結束時會自動銷毀。

局部變量不會造成數據污染

<?php

namespace app\controller;

use support\Request;
use support\Context;
use Workerman\Timer;

class TestController
{
    public function index(Request $request)
    {
        $name = $request->get('name');
        Timer::sleep(5);
        return $name;
    }
}

因為 $name 是局部變量，協程之間無法互相訪問局部變量，所以使用局部變量是協程安全的。

Locker 鎖

有時候一些組件或者業務沒有考慮到協程環境，可能會出現資源競爭或原子性問題，這時候可以使用 Workerman\Locker 加鎖來實現排隊處理，防止並發問題。

<?php

namespace app\controller;

use Redis;
use support\Response;
use Workerman\Coroutine\Locker;

class IndexController
{
    public function index(): Response
    {
        static $redis;
        if (!$redis) {
            $redis = new Redis();
            $redis->connect('127.0.0.1', 6379);
        }
        // 如果不加鎖，Swoole 下會觸發類似 "Socket#10 has already been bound to another coroutine#10" 錯誤
        // Swow 下可能會觸發 coredump
        // Fiber 下因為 Redis 擴展是同步阻塞 IO，所以不會有問題
        Locker::lock('redis');
        $time = $redis->time();
        Locker::unlock('redis');
        return json($time);
    }

}

Parallel 並發執行

當我們需要並發執行多個任務並獲取結果時，可以使用 Workerman\Parallel 來實現。

<?php

namespace app\controller;

use support\Response;
use Workerman\Coroutine\Parallel;

class IndexController
{
    public function index(): Response
    {
        $parallel = new Parallel();
        for ($i=1; $i<5; $i++) {
            $parallel->add(function () use ($i) {
                // Do something
                return $i;
            });
        }
        $results = $parallel->wait();
        return json($results); // Response: [1,2,3,4]
    }

}

Pool 連接池

多個協程共用同一個連接會導致數據混亂，所以需要使用連接池來管理數據庫、redis 等連接資源。

webman 已經提供了 webman/database webman/redis webman/cache webman/think-orm webman/think-cache 等組件，它們都集成了連接池，支持在協程和非協程環境下使用。

如果你想改造一個沒有連接池的組件，可以使用 Workerman\Pool 來實現，參考如下代碼。

數據庫組件

<?php
namespace app;

use Workerman\Coroutine\Context;
use Workerman\Coroutine;
use Workerman\Coroutine\Pool;

class Db
{
    private static ?Pool $pool = null;

    public static function __callStatic($name, $arguments)
    {
        if (self::$pool === null) {
            self::initializePool();
        }
        // 從協程上下文中獲取連接，保證同一個協程使用同一個連接
        $pdo = Context::get('pdo');
        if (!$pdo) {
            // 從連接池中獲取連接
            $pdo = self::$pool->get();
            Context::set('pdo', $pdo);
            // 當協程結束時，自動歸還連接
            Coroutine::defer(function () use ($pdo) {
                self::$pool->put($pdo);
            });
        }
        return call_user_func_array([$pdo, $name], $arguments);
    }

    private static function initializePool(): void
    {
        // 創建一個連接池，最大連接數為 10
        self::$pool = new Pool(10);
        // 設置連接創建器(為了簡潔，省略了配置文件讀取)
        self::$pool->setConnectionCreator(function () {
            return new \PDO('mysql:host=127.0.0.1;dbname=your_database', 'your_username', 'your_password');
        });
        // 設置連接關閉器
        self::$pool->setConnectionCloser(function ($pdo) {
            $pdo = null;
        });
        // 設置心跳檢測器
        self::$pool->setHeartbeatChecker(function ($pdo) {
            $pdo->query('SELECT 1');
        });
    }

}

使用

<?php
namespace app\controller;

use support\Response;
use app\Db;

class IndexController
{
    public function index(): Response
    {
        $value = Db::query('SELECT NOW() as now')->fetchAll();
        return json($value); // [{"now":"2025-02-06 23:41:03","0":"2025-02-06 23:41:03"}]
    }

}

更多協程及相關組件介紹

參考 workerman 協程文檔

協程與非協程混合部署

webman 支持協程和非協程混合部署，例如非協程處理普通業務，協程處理慢 IO 業務，通過 nginx 轉發請求到不同的服務上。

例如 config/process.php

return [
    'webman' => [
        'handler' => Http::class,
        'listen' => 'http://0.0.0.0:8787',
        'count' => 1,
        'user' => '',
        'group' => '',
        'reusePort' => false,
        'eventLoop' => '', // 默認為空自動選擇 Select 或者 Event，不開啟協程
        'context' => [],
        'constructor' => [
            'requestClass' => Request::class,
            'logger' => Log::channel('default'),
            'appPath' => app_path(),
            'publicPath' => public_path()
        ]
    ],
    'my-coroutine' => [
        'handler' => Http::class,
        'listen' => 'http://0.0.0.0:8686',
        'count' => 1,
        'user' => '',
        'group' => '',
        'reusePort' => false,
        // 開啟協程需要設置為 Workerman\Events\Swoole::class 或者 Workerman\Events\Swow::class 或者 Workerman\Events\Fiber::class
        'eventLoop' => Workerman\Events\Swoole::class,
        'context' => [],
        'constructor' => [
            'requestClass' => Request::class,
            'logger' => Log::channel('default'),
            'appPath' => app_path(),
            'publicPath' => public_path()
        ]
    ],

    // ... 其它配置省略 ...
];

然後通過 nginx 配置轉發請求到不同的服務上

upstream webman {
    server 127.0.0.1:8787;
    keepalive 10240;
}

# 新增一個 8686 upstream
upstream task {
   server 127.0.0.1:8686;
   keepalive 10240;
}

server {
  server_name webman.com;
  listen 80;
  access_log off;
  root /path/webman/public;

  # 以 /tast 開頭的請求走 8686 端口，請按實際情況將 /tast 更改為你需要的前綴
  location /tast {
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header Host $host;
      proxy_http_version 1.1;
      proxy_set_header Connection "";
      proxy_pass http://task;
  }

  # 其它請求走原 8787 端口
  location / {
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header Host $host;
      proxy_http_version 1.1;
      proxy_set_header Connection "";
      if (!-f $request_filename){
          proxy_pass http://webman;
      }
  }
}