說明
workerman從4.x版本開始加強了HTTP服務(wù)的支持。引入了請求類、響應(yīng)類、session類以及SSE。如果你想使用workerman的HTTP服務(wù),強烈推薦使用workerman4.x或者以后的更高版本。
注意以下都是workerman4.x版本的用法,不兼容workerman3.x。
注意
- 除非發(fā)送的是chunk或者SSE響應(yīng),否則不允許在一個請求里多次發(fā)送響應(yīng),也就是在一個請求里不允許多次調(diào)用
$connection->send()
。 - 每個請求最終都需要調(diào)用一次
$connection->send()
發(fā)送響應(yīng),否則客戶端會一直等待
快捷響應(yīng)
當不需要更改HTTP狀態(tài)碼(默認200),或者自定義header、cookie時,可以直接向客戶端發(fā)送字符串完成響應(yīng)。
例子
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)
{
// 直接發(fā)送this is body給客戶端
$connection->send("this is body");
};
// 運行worker
Worker::runAll();
更改狀態(tài)碼
當需要自定義狀態(tài)碼、header、cookie時,需要使用Workerman\Protocols\Http\Response
響應(yīng)類。例如下面例子在訪問路徑為/404
時返回404的狀態(tài)碼,包體內(nèi)容為<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
類已經(jīng)初始化后,想更改狀態(tài)碼使用下面方法。
$response = new Response(200);
$response->withStatus(404);
$connection->send($response);
發(fā)送header
同樣的,發(fā)送header需要使用Workerman\Protocols\Http\Response
響應(yīng)類。
例子
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
類已經(jīng)初始化后,想增加或者更改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)
$worker = new Worker('http://0.0.0.0:8080');
$worker->onMessage = function($connection, $request)
{
$location = '/test_location';
$response = new Response(302, ['Location' => $location]);
$connection->send($response);
};
Worker::runAll();
發(fā)送cookie
同樣的,發(fā)送cookie需要使用Workerman\Protocols\Http\Response
響應(yīng)類。
例子
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();
發(fā)送文件
同樣的,發(fā)送文件需要使用Workerman\Protocols\Http\Response
響應(yīng)類。
發(fā)送文件時用以下方式
$response = (new Response())->withFile($file);
$connection->send($response);
- workerman支持發(fā)送超大文件
- 對于大文件(超過2M),workerman不會將整個文件一次性讀入內(nèi)存,而是在合適的時機分段讀取文件并發(fā)送
- workerman會根據(jù)客戶端接收速度來優(yōu)化文件讀取發(fā)送速度,保證最快速發(fā)送文件的同時將內(nèi)存占用減少到最低
- 數(shù)據(jù)發(fā)送是非阻塞的,不會影響其它請求處理
- 發(fā)送文件時會自動加上
Last-Modified
頭,以便下次請求時服務(wù)端判斷是否發(fā)送304響應(yīng)以節(jié)省文件傳輸提高性能 - 發(fā)送的文件會自動使用合適的
Content-Type
頭發(fā)送給瀏覽器 - 如果文件不存在,會自動轉(zhuǎn)為404響應(yīng)
例子
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頭則發(fā)送文件
$response = (new Response())->withFile($file);
$connection->send($response);
};
// 運行worker
Worker::runAll();
發(fā)送http chunk數(shù)據(jù)
- 必須先發(fā)送一個攜帶
Transfer-Encoding: chunked
頭的Response響應(yīng)給客戶端 - 發(fā)送后續(xù)chunk數(shù)據(jù)使用
Workerman\Protocols\Http\Chunk
類 - 最終必須發(fā)送一個空的chunk來結(jié)束響應(yīng)
例子
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)
{
// 首先發(fā)送一個帶Transfer-Encoding: chunked頭的Response響應(yīng)
$connection->send(new Response(200, array('Transfer-Encoding' => 'chunked'), 'hello'));
// 后續(xù)Chunk數(shù)據(jù)用Workerman\Protocols\Http\Chunk類發(fā)送
$connection->send(new Chunk('第一段數(shù)據(jù)'));
$connection->send(new Chunk('第二段數(shù)據(jù)'));
$connection->send(new Chunk('第三段數(shù)據(jù)'));
// 最后必須發(fā)送一個空的chunk結(jié)束響應(yīng)
$connection->send(new Chunk(''));
};
// 運行worker
Worker::runAll();