Request 對象

接收客戶端的 HTTP 請求對象

生命周期

Request 對象在系統中以單例模式存在，自收到客戶端 HTTP 請求時自動創建，直至請求結束自動銷毀。Request 對象完全符合 PSR-7 中的所有規范。

核心方法

getRequestParam()

用于獲取用戶通過 POST 或者 GET 提交的參數（注意：若 POST 與 GET 存在同鍵名參數，則以POST 為準）。

示例：

// 在控制器中 可以通過 $this->request() 獲取到 Request 對象
// $request = $this->request()；

// 獲取 `POST` 或者 `GET` 提交的所有參數
$data = $request->getRequestParam();
var_dump($data);

// 獲取 `POST` 或者 `GET` 提交的單個參數
$orderId = $request->getRequestParam('orderId');
var_dump($orderId);

// 獲取 `POST` 或者 `GET` 提交的多個參數
$mixData = $request->getRequestParam("orderId","type");
var_dump($mixData);

getSwooleRequest()

獲取當前的 swoole_http_request 對象。

getCookieParams()

獲取 HTTP 請求中的 cookie 信息

// 獲取所有 `cookie` 信息
$all = $request->getCookieParams();
var_dump($all);

// 獲取單個 `cookie` 信息
$who = $request->getCookieParams('who');
var_dump($who);

getUploadedFiles()

獲取客戶端上傳的全部文件信息。

// 獲取一個上傳文件，返回的是一個 \EasySwoole\Http\Message\UploadFile 的對象
$img_file = $request->getUploadedFile('img');

// 獲取全部上傳文件返回包含 \EasySwoole\Http\Message\UploadFile 對象的數組
$data = $request->getUploadedFiles();
var_dump($data);

點擊查看 UploadFile對象

getBody()

獲取以非 form-data 或 x-www-form-urlenceded 編碼格式 POST 提交的原始數據，相當于PHP中的 $HTTP_RAW_POST_DATA。

獲得 get 內容

$get = $request->getQueryParams();

獲得 post 內容

$post = $request->getParsedBody();

獲得 raw 內容

例如在常用的 post 請求中，Content-Type 為 application/json 時就可用如下方法獲取 json 請求體內容。

$content = $request->getBody()->__toString();
$raw_array = json_decode($content, true);

獲得頭部

$header = $request->getHeaders();

獲得 server

$server = $request->getServerParams();

獲得 cookie

$cookie = $request->getCookieParams();

將數據掛載到當前請求對象 $request 上

將某個需要的數據掛載到當前請求對象 $request 上，方便在本次請求生命周期內的后續其他方法中調用這個數據。

支持鏈式調用。

$this->request()->withAttribute($key, $value);

// 鏈式調用
$this->request()->withAttribute($key1, $value1)->withAttribute($key2, $value2);

注意：掛載的數據只對每次請求當前請求生命周期有效。

獲取當前請求對象 $request 上的掛載數據

// 獲取單個數據
$this->request()->getAttribute($key);

// 獲取所有 返回數組
$this->request()->getAttributes(); // array

注意：掛載的數據只對每次請求當前請求生命周期有效。

丟棄掛載到當前請求對象 $request 上的某個數據

$this->request()->withoutAttribute($uselessKey);

使用示例：

<?php

namespace App\HttpController;

use EasySwoole\Http\AbstractInterface\Controller;

class Index extends Controller
{
    public function onRequest(?string $action): ?bool
    {
        // 掛載數據 到 $request 對象上
        $this->request()->withAttribute('name', 'easyswoole')
            ->withAttribute('age', 18);

        return parent::onRequest($action); // TODO: Change the autogenerated stub
    }

    public function index()
    {
        // 獲取掛載的單個數據
        $ret = $this->request()->getAttribute('name'); // 'easyswoole'

        // 獲取掛載的全部數據
        $rets = $this->request()->getAttributes();

        // 刪除某個掛載數據
        $this->request()->withoutAttribute('name');

        // 再次獲取掛載的全部數據
        $rets1 = $this->request()->getAttributes();

        var_dump($ret, $rets, $rets1);

        // 運行結果：
        /*
        string(10) "easyswoole"
        array(2) {
          ["name"]=>
          string(10) "easyswoole"
          ["age"]=>
          int(18)
        }
        array(1) {
          ["age"]=>
          int(18)
        }
        */
    }
}