# 说明
workerman从4.x版本开始加强了HTTP服务的支持。引入了请求类、响应类、session类以及[SSE](SSE.md)。如果你想使用workerman的HTTP服务,强烈推荐使用workerman4.x或者以后的更高版本。
**注意以下都是workerman4.x版本的用法,不兼容workerman3.x。**
# 注意
- 除非发送的是chunk或者SSE响应,否则不允许在一个请求里多次发送响应,也就是在一个请求里不允许多次调用`$connection->send()`。
- 每个请求最终都需要调用一次`$connection->send()`发送响应,否则客户端会一直等待
## 快捷响应
当不需要更改HTTP状态码(默认200),或者自定义header、cookie时,可以直接向客户端发送字符串完成响应。
**例子**
```php
use Workerman\Worker;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8080');
$worker->onMessage = function($connection, $request)
{
// 直接发送this is body给客户端
$connection->send("this is body");
};
// 运行worker
Worker::runAll();
```
## 更改状态码
当需要自定义状态码、header、cookie时,需要使用`Workerman\Protocols\Http\Response`响应类。例如下面例子在访问路径为`/404`时返回404的状态码,包体内容为`<h1>抱歉,文件不存在</h1>`。
**例子**
```php
use Workerman\Worker;
use Workerman\Protocols\Http\Response;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8080');
$worker->onMessage = function($connection, $request)
{
if ($request->path() === '/404') {
$connection->send(new Response(404, [], '<h1>抱歉,文件不存在</h1>'));
} else {
$connection->send('this is body');
}
};
// 运行worker
Worker::runAll();
```
当`Response`类已经初始化后,想更改状态码使用下面方法。
```php
$response = new Response(200);
$response->withStatus(404);
$connection->send($response);
```
## 发送header
同样的,发送header需要使用`Workerman\Protocols\Http\Response`响应类。
**例子**
```php
use Workerman\Worker;
use Workerman\Protocols\Http\Response;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8080');
$worker->onMessage = function($connection, $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使用下面方法。
```php
$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);
```
## 重定向
```php
use Workerman\Worker;
use Workerman\Protocols\Http\Response;
require_once './Workerman/Autoloader.php';
$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();
```
## 发送cookie
同样的,发送cookie需要使用`Workerman\Protocols\Http\Response`响应类。
**例子**
```php
use Workerman\Worker;
use Workerman\Protocols\Http\Response;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8080');
$worker->onMessage = function($connection, $request)
{
$response = new Response(200, [], 'this is body');
$response->cookie('name', 'tom');
$connection->send($response);
};
// 运行worker
Worker::runAll();
```
## 发送文件
同样的,发送文件需要使用`Workerman\Protocols\Http\Response`响应类。
发送文件时用以下方式
```php
$response = (new Response())->withFile($file);
$connection->send($response);
```
- workerman支持发送超大文件。workerman会根据客户端接收速度来优化文件读取发送速度,保证最快速发送文件的同时将内存占用减少到最低。
- 发送文件时会自动加上`Last-Modified`头,以便下次请求时服务端判断是否发送304响应以节省文件传输提高性能。
- 发送的文件会自动使用合适的`Content-Type`头发送给浏览器。
- 如果文件不存在,会自动转为404响应
**例子**
```php
use Workerman\Worker;
use Workerman\Protocols\Http\Response;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8080');
$worker->onMessage = function($connection, $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来结束响应
**例子**
```php
use Workerman\Worker;
use Workerman\Protocols\Http\Response;
use Workerman\Protocols\Http\Chunk;
require_once './Workerman/Autoloader.php';
$worker = new Worker('http://0.0.0.0:8080');
$worker->onMessage = function($connection, $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();
```
- 序言
- 原理
- 开发必读
- 入门指引
- 特性
- 简单的开发示例
- 安装
- 环境要求
- 下载安装
- 启动停止
- 开发流程
- 开发前必读
- 目录结构
- 开发规范
- 基本流程
- 通讯协议
- 通讯协议作用
- 定制通讯协议
- 一些例子
- Worker类
- 构造函数
- 属性
- id
- count
- name
- protocol
- transport
- reusePort
- connections
- stdoutFile
- pidFile
- logFile
- user
- reloadable
- daemonize
- globalEvent
- 回调属性
- onWorkerStart
- onWorkerReload
- onConnect
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- runAll
- stopAll
- listen
- TcpConnection类
- 属性
- id
- protocol
- worker
- maxSendBufferSize
- defaultMaxSendBufferSize
- defaultMaxPackageSize
- 回调属性
- onMessage
- onClose
- onBufferFull
- onBufferDrain
- onError
- 接口
- send
- getRemoteIp
- getRemotePort
- close
- destroy
- pauseRecv
- resumeRecv
- pipe
- AsyncTcpConnection类
- __construct
- connect
- reconnect
- transport
- AsyncUdpConnection类
- __construct
- connect
- send
- close
- Timer定时器类
- add
- del
- 定时器注意事项
- crontab
- Http服务
- 请求
- 响应
- session会话
- session管理
- SSE
- 调试
- 基本调试
- status命令查看运行状态
- 调试busy进程
- 网络抓包
- 跟踪系统调用
- 常用组件
- GlobalData数据共享组件
- GlobalDataServer
- GlobalDataClient
- add
- cas
- increment
- Channel分布式通讯组件
- ChannelServer
- channelClient
- connect
- on
- publish
- unsubsribe
- 例子-集群推送
- 例子-分组发送
- FileMonitor文件监控组件
- MySQL组件
- workerman/mysql
- react/mysql(异步)
- 其它数据库类
- Redis组件
- workerman/redis
- react/redis
- 异步http组件
- workerman/http-client
- react/http-client
- 异步消息队列组件
- workemran/mqtt
- workerman/redis-queue
- workerman/stomp
- workerman/rabbitmq
- react/zmq
- Crontab定时任务
- 异步dns组件
- react/dns
- Memcache
- 常见问题
- 心跳
- 客户端连接失败原因
- 是否支持多线程
- 与其它框架整合
- 运行多个workerman
- 支持哪些协议
- 如何设置进程数
- 查看客户端连接数
- 对象和资源的持久化
- 例子无法工作
- 启动失败
- 停止失败
- 支持多少并发
- 更改代码不生效
- 向指定客户端发送数据
- 如何主动推送消息
- 在其它项目中推送
- 如何实现异步任务
- status里send_fail的原因
- Windows下开发Linux下部署
- 是否支持socket.io
- 终端关闭导致workerman关闭
- 与nginx apache的关系
- 禁用函数检查
- 平滑重启原理
- 为Flash开843端口
- 如何广播数据
- 如何建立udp服务
- 监听ipv6
- 关闭未认证的连接
- 传输加密-ssl/tls
- 创建wss服务
- 创建https服务
- workerman作为客户端
- 作为ws/wss客户端
- 微信小程序
- PHP的几种回调写法
- 透过代理获取客户端真实ip
- 开机启动
- 接收和发送16进制数据
- 接收一定请求后重启
- win下初始化多个worker
- 附录
- 优化Linux内核
- 压力测试
- 安装扩展
- websocket协议
- ws协议
- text协议
- frame协议
- 不支持的函数/特性
- 版权信息