Swoft HTTP Request Response 请求响应

参考资料

PHP-FIG https://www.php-fig.org/psr/psr-7/

<?php
namespace App\Controllers\Admin;

use Swoft\Http\Server\Bean\Annotation\Controller;
use Swoft\Http\Server\Bean\Annotation\RequestMapping;
use Swoft\Http\Server\Bean\Annotation\RequestMethod;
use Swoft\View\Bean\Annotation\View;
use Swoft\Http\Message\Server\Request;
use Swoft\Http\Message\Server\Response;

/**
 * Class LoginController
 * @Controller(prefix="/admin/login")
 * @package App\Controllers
 */
class LoginController{
    /**
     * this is a example action. access uri path: /admin
     * @RequestMapping(route="index", method={RequestMethod::GET, RequestMethod::POST})
     * @View(template="admin/login/index")
     * @param Request $request
     * @return array
     */
    public function index(Request $request):array
    {
        $data = [];
        $data["name"] = "admin:login:index";

        return $data;
    }
}

Swoft中HTTP的请求和响应是什么样的呢？

请求Response与响应Response对象存在于每次HTTP请求中，Swoft的请求和响应实现于PSR7。

请求Swoft\Http\Message\Server\Request

Swoft HTTP服务中的Request，是对\Swoole\Http\Request基于PSR7标准的封装。由于\Swoole\Http\Request对HTTP Request进行了封装，所以不能使用原生PHP的$_POST/$_GET等全局变量，也不推荐这样的使用方式。

响应Swoft\Http\Message\Server\Response

Swoft对HTTP服务的Response做了很好的封装，其中一个设计哲学是：返回的格式类型，不应该由服务端指定，而是应该根据客户端请求时Header头中的Accept决定。所以在Swoft中，当控制器中Action动作方法返回一个数组array或数组化Arrayable的对象时，Response响应对象将根据请求头Request Header中的Accept来返回数据，目前支持View/JSON/Raw。

Swoft的Response支持返回的数据类型包括

基本数据类型：bool、int、float(double)、string
\Swoft\Contract\Arrayable对象
在控制器内抛出的异常将由ExceptionHandler异常处理器捕获并进行处理

另外可通过@View注解或view()帮助函数来使用视图

什么是PSR7呢？

PSR是指PHP推荐标准（PHP Standard Recommendations，PSR），是由PHP框架可互用性小组（Framework Interoperability Group, FIG）组织制定并维护，其目标在于：制定一个协作标准，各个框架遵循统一的编码规范，避免各家自行发展的风格阻碍了PHP的发展，解决这个程序设计师由来已久的困扰。

目前已经通过的规范有：

PSR1 基础编码规范
PSR2 编码风格规范
PSR3 日志接口规范
PSR4 自动加载规范
PSR6 缓存接口规范
PSR7 HTTP消息接口规范

PSR7 HTTP消息接口规范中为请求和响应对象提供的基本方法

根据PSR7对象的不可变性(immutable)，所有的with*方法都是克隆对象然后返回，必须接收新对象来做进一步处理，或使用链式调用。

公共方法

Request和Response中的with...开头的方法会clone $this，而并非修改实体，所以设置Cookie的时候需要$response = $response->withCookie(...)。

withProtocolVersion($version)
withHeader($name, $value)
withAddedHeader($name, $value)
withoutHeader($name)
withBody(StreamInterface $body)

请求方法

withMethod(string $method)
withUri(UriInterface $uri, $preserveHost=false)
withCookieParams(array $cookies)
withQueryParams(array $query)
withUploadedFiles(array $uploadedFiles)
withParseBody($data)
withAttribute($name, $value)
withoutAttribute($name)

响应方法

withStatus($code, $reasonPhrase="")

Response::withStatus方法取决于你的Response::Attribute['responseAttribute']是否有内容，若有的话强制为200，开发者认为其它状态码无需返回内容。

请求

Swoft中的Request位于\Swoole\Http\Request，继承自\Swoft\Http\Message\Base\Request并实现了Psr\Http\Message\ServerRequestInterface接口。ServerRequestInterface是基于PSR7标准的封装，由于\Swoole\Http\Request对Request进行了封装，所以不能使用原生PHP的$_POST/$_GET等全局变量，也不推荐这样的使用方式。

Swoft中HTTP请求对象提供了那些操作方法呢？

\Swoole\Http\Request对外暴露的方法

$request->getServerParams() 获取服务器参数，返回数组。

array(11) {
  ["request_method"]=>string(3) "GET"
  ["request_uri"]=>string(18) "/admin/account/add"
  ["path_info"]=>string(18) "/admin/account/add"
  ["request_time"]=>int(1557990050)
  ["request_time_float"]=>float(1557990051.4853)
  ["server_port"]=>int(80)
  ["remote_port"]=>int(64656)
  ["remote_addr"]=>string(12) "192.168.99.1"
  ["master_time"]=>int(1557990050)
  ["server_protocol"]=>string(8) "HTTP/1.1"
  ["server_software"]=>string(18) "swoole-http-server"
}

$request->getCookieParams() 获取Cookie参数信息

 array(1) {
  ["SWOFT_SESSION_ID"]=>string(40) "G0cd8YuphSeQWIGa14hiS0qy0bzfcuFXoJbR7kBs"
}

$request->getQueryParams()
$request->getUploadedFiles()
$request->getParseBody() 获取POST数据，类似$_POST。
$request->getBodyParams()
$request->getAttributes()
$request->getAttribute($name, $default = null)
$request->url() 获取当前控制器对应的URL，如http://192.168.99.100:80/admin/account/add。
$request->fullUrl() 获取当前控制器对应的完整URL地址，如http://192.168.99.100:80/admin/account/add。
$request->isAjax() 判断是否AJAX方式提交，返回布尔值。
$request->isXmlHttpRequest()
$request->getSwooleRequest() 获取Swoole的Request对象

\Swoft\Http\Message\Base\Request对外暴露的接口

$request->getRequestTarget() 获取请求目标，返回控制器所对应的URI，例如/admin/account/add。
$request->getMethod() 获取请求方法，如GET、POST...
$request->getUri()

其它方法

$request->server("key", "default value") 获取服务器信息，并指定默认值。

$request->server("request_time_float") // 1557990051.4853

$request->getHeaders() 获取全部请求头信息

array(9) {
  ["host"]=>array(1) {[0]=>string(14) "192.168.99.100"}
  ["user-agent"]=>array(1) {[0]=>string(110) "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36"}
  ["accept"]=>array(1) {[0]=>string(85) "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8"}
  ["accept-encoding"]=>array(1) {[0]=>string(13) "gzip, deflate"}
  ["accept-language"]=>array(1) {[0]=>string(35) "zh-CN,zh;q=0.9,en;q=0.8,zh-TW;q=0.7"}
  ["proxy-connection"]=>array(1) {[0]=>string(10) "keep-alive"}
  ["referer"]=>array(1) {[0]=>string(41) "http://192.168.99.100/admin/account/index"}
  ["upgrade-insecure-requests"]=>array(1) {[0]=>string(1) "1"}
  ["x-lantern-version"]=>array(1) {[0]=>string(5) "5.3.6"}
}

$request->getHeader() 获取指定的请求头信息，返回数组。

$referer = current($request->getHeader("referer"));
// string(41) "http://192.168.99.100/admin/account/index"

$request->getHeaderLine() 获取指定请求头信息，返回字符串。
$request->getContentType() 获取请求的内容类型
$request->get() 获取GET请求数据
$request->get("key", "default value") 获取GET请求数组并指定默认值
$request->post() 获取POST请求数据
$request->post("key", "default value") 获取POST请求数据并指定默认值
$request->json() 当请求的内容类型为application/json时获取JSON中的值
$request->json("key", "default value")当请求的内容类型为application/json时获取JSON中的值并指定默认值
$request->raw() 获取请求中详细RAW数据

响应

Swoft中HTTP响应对象提供了那些操作方法呢？

$response->getSwooleResponse()
获取Swoole的Response响应对象