說明

workerman從4.x版本開始加強了HTTP服務的支持。引入了請求類、響應類、session類以及SSE。如果你想使用workerman的HTTP服務,強烈推薦使用workerman4.x或者以後的更高版本。

注意以下都是workerman4.x版本的用法,不相容workerman3.x。

注意

  • 除非發送的是chunk或者SSE響應,否則不允許在一個請求裡多次發送響應,也就是在一個請求裡不允許多次調用$connection->send()
  • 每個請求最終都需要調用一次$connection->send()發送響應,否則客戶端會一直等待。

快捷響應

當不需要更改HTTP狀態碼(預設200),或者自定義header、cookie時,可以直接向客戶端發送字符串完成響應。

例子

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    // 直接發送this is body給客戶端
    $connection->send("this is body");
};

// 运行worker
Worker::runAll();

更改狀態碼

當需要自定義狀態碼、header、cookie時,需要使用Workerman\Protocols\Http\Response響應類。例如下面例子在訪問路徑為/404時返回404的狀態碼,包體內容為<h1>抱歉,文件不存在</h1>

例子

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\Response;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    if ($request->path() === '/404') {
        $connection->send(new Response(404, [], '<h1>抱歉,文件不存在</h1>'));
    } else {
        $connection->send('this is body');
    }
};

// 运行worker
Worker::runAll();

Response類已經初始化後,想更改狀態碼使用下面方法。

$response = new Response(200);
$response->withStatus(404);
$connection->send($response);

發送header

同樣的,發送header需要使用Workerman\Protocols\Http\Response響應類。

例子

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\Response;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    $response = new Response(200, [
        'Content-Type' => 'text/html',
        'X-Header-One' => 'Header Value'
    ], 'this is body');
    $connection->send($response);
};

// 运行worker
Worker::runAll();

Response類已經初始化後,想增加或者更改header使用下面方法。

$response = new Response(200);
// 添加或者更改一個header
$response->header('Content-Type', 'text/html');
// 添加或者更改多個header
$response->withHeaders([
    'Content-Type' => 'application/ json',
    'X-Header-One' => 'Header Value'
]);
$connection->send($response);

重定向

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\Response;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    $location = '/test_location';
    $response = new Response(302, ['Location' => $location]);
    $connection->send($response);
};

// 运行worker
Worker::runAll();

發送cookie

同樣的,發送cookie需要使用Workerman\Protocols\Http\Response響應類。

例子

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\Response;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    $response = new Response(200, [], 'this is body');
    $response->cookie('name', 'tom');
    $connection->send($response);
};

// 运行worker
Worker::runAll();

發送檔案

同樣的,發送檔案需要使用Workerman\Protocols\Http\Response響應類。

發送檔案時用以下方式

$response = (new Response())->withFile($file);
$connection->send($response);
  • workerman支持發送超大檔案
  • 對於大檔案(超過2M),workerman不會將整個檔案一次性讀入記憶體,而是在合適的時機分段讀取檔案並發送
  • workerman會根據客戶端接收速度來優化檔案讀取發送速度,保證最快速發送檔案的同時將記憶體佔用減少到最低
  • 資料發送是非阻塞的,不會影響其它請求處理
  • 發送檔案時會自動加上Last-Modified頭,以便下次請求時服務端判斷是否發送304響應以節省檔案傳輸提高效能
  • 發送的檔案會自動使用合適的Content-Type頭發送給瀏覽器
  • 如果檔案不存在,會自動轉為404響應

例子

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\Response;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    $file = '/your/path/of/file';
    // 檢查if-modified-since頭判斷檔案是否修改過
    if (!empty($if_modified_since = $request->header('if-modified-since'))) {
        $modified_time = date('D, d M Y H:i:s',  filemtime($file)) . ' ' . \date_default_timezone_get();
        // 檔案未修改則返回304
        if ($modified_time === $if_modified_since) {
            $connection->send(new Response(304));
            return;
        }
    }
    // 檔案修改過或者沒有if-modified-since頭則發送檔案
    $response = (new Response())->withFile($file);
    $connection->send($response);
};

// 运行worker
Worker::runAll();

發送http chunk資料

  • 必須先發送一個攜帶 Transfer-Encoding: chunked頭的Response響應給客戶端
  • 發送後續chunk資料使用Workerman\Protocols\Http\Chunk
  • 最終必須發送一個空的chunk來結束響應

例子

use Workerman\Worker;
use Workerman\Connection\TcpConnection;
use Workerman\Protocols\Http\Request;
use Workerman\Protocols\Http\Response;
use Workerman\Protocols\Http\Chunk;
require_once __DIR__ . '/vendor/autoload.php';

$worker = new Worker('http://0.0.0.0:8080');

$worker->onMessage = function(TcpConnection $connection, Request $request)
{
    // 首先發送一個帶Transfer-Encoding: chunked頭的Response響應
    $connection->send(new Response(200, array('Transfer-Encoding' => 'chunked'), 'hello'));
    // 後續Chunk資料用Workerman\Protocols\Http\Chunk類發送
    $connection->send(new Chunk('第一段資料'));
    $connection->send(new Chunk('第二段資料'));
    $connection->send(new Chunk('第三段資料'));
   //  最後必須發送一個空的chunk結束響應
    $connection->send(new Chunk(''));
};

// 运行worker
Worker::runAll();