解讀PHP的Yii框架中請求與響應的處理流程

2024-05-04 21:50:52

字體：大中小

來源：轉載

供稿：網友

一、請求（Requests）

請求：一個應用的請求是用 yii/web/Request 對象來表示的，該對象提供了諸如請求參數（譯者注：通常是GET參數或者POST參數）、HTTP頭、cookies等信息。默認情況下，對于一個給定的請求，你可以通過 request application component 應用組件（yii/web/Request 類的實例）獲得訪問相應的請求對象。在本章節，我們將介紹怎樣在你的應用中使用這個組件。

1.請求參數

要獲取請求參數，你可以調用 request 組件的 yii/web/Request::get() 方法和 yii/web/Request::post() 方法。他們分別返回 $_GET 和$_POST 的值。例如，

$request = Yii::$app->request;

$get = $request->get();

// 等價于: $get = $_GET;

$id = $request->get('id');

// 等價于: $id = isset($_GET['id']) ? $_GET['id'] : null;

$id = $request->get('id', 1);

// 等價于: $id = isset($_GET['id']) ? $_GET['id'] : 1;

$post = $request->post();

// 等價于: $post = $_POST;

$name = $request->post('name');

// 等價于: $name = isset($_POST['name']) ? $_POST['name'] : null;

$name = $request->post('name', '');

// 等價于: $name = isset($_POST['name']) ? $_POST['name'] : '';

信息：建議你像上面那樣通過 request 組件來獲取請求參數，而不是直接訪問 $_GET 和 $_POST。這使你更容易編寫測試用例，因為你可以偽造數據來創建一個模擬請求組件。

當實現 RESTful APIs 接口的時候，你經常需要獲取通過PUT， PATCH或者其他的 request methods 請求方法提交上來的參數。你可以通過調用 yii/web/Request::getBodyParam() 方法來獲取這些參數。例如，

$request = Yii::$app->request;

// 返回所有參數

$params = $request->bodyParams;

// 返回參數 "id"

$param = $request->getBodyParam('id');

信息：不同于 GET 參數，POST，PUT，PATCH 等等這些提交上來的參數是在請求體中被發送的。當你通過上面介紹的方法訪問這些參數的時候，request 組件會解析這些參數。你可以通過配置 yii/web/Request::parsers 屬性來自定義怎樣解析這些參數。

2.請求方法

你可以通過 Yii::$app->request->method 表達式來獲取當前請求使用的HTTP方法。這里還提供了一整套布爾屬性用于檢測當前請求是某種類型。例如，

$request = Yii::$app->request;

if ($request->isAjax) { /* 該請求是一個 AJAX 請求 */ }

if ($request->isGet) { /* 請求方法是 GET */ }

if ($request->isPost) { /* 請求方法是 POST */ }

if ($request->isPut) { /* 請求方法是 PUT */ }

3.請求URLs

request 組件提供了許多方式來檢測當前請求的URL。

假設被請求的URL是 http://example.com/admin/index.php/product?id=100，你可以像下面描述的那樣獲取URL的各個部分：

yii/web/Request::url：返回 /admin/index.php/product?id=100, 此URL不包括host info部分。

yii/web/Request::absoluteUrl：返回 http://example.com/admin/index.php/product?id=100, 包含host infode的整個URL。

yii/web/Request::hostInfo：返回 http://example.com, 只有host info部分。

yii/web/Request::pathInfo：返回 /product，這個是入口腳本之后，問號之前（查詢字符串）的部分。

yii/web/Request::queryString：返回 id=100,問號之后的部分。

yii/web/Request::baseUrl：返回 /admin, host info之后，入口腳本之前的部分。

yii/web/Request::scriptUrl：返回 /admin/index.php, 沒有path info和查詢字符串部分。

yii/web/Request::serverName：返回 example.com, URL中的host name。

yii/web/Request::serverPort：返回 80, 這是web服務中使用的端口。

4.HTTP頭

你可以通過 yii/web/Request::headers 屬性返回的 yii/web/HeaderCollection 獲取HTTP頭信息。例如，

// $headers 是一個 yii/web/HeaderCollection 對象

$headers = Yii::$app->request->headers;

// 返回 Accept header 值

$accept = $headers->get('Accept');

if ($headers->has('User-Agent')) { /* 這是一個 User-Agent 頭 */ }

請求組件也提供了支持快速訪問常用頭的方法，包括：

yii/web/Request::userAgent：返回 User-Agent 頭。

yii/web/Request::contentType：返回 Content-Type 頭的值， Content-Type 是請求體中MIME類型數據。

yii/web/Request::acceptableContentTypes：返回用戶可接受的內容MIME類型。返回的類型是按照他們的質量得分來排序的。得分最高的類型將被最先返回。

yii/web/Request::acceptableLanguages：返回用戶可接受的語言。返回的語言是按照他們的偏好層次來排序的。第一個參數代表最優先的語言。

假如你的應用支持多語言，并且你想在終端用戶最喜歡的語言中顯示頁面，那么你可以使用語言協商方法 yii/web/Request::getPreferredLanguage()。這個方法通過 yii/web/Request::acceptableLanguages 在你的應用中所支持的語言列表里進行比較篩選，返回最適合的語言。

提示：你也可以使用 yii/filters/ContentNegotiator 過濾器進行動態確定哪些內容類型和語言應該在響應中使用。這個過濾器實現了上面介紹的內容協商的屬性和方法。

5.客戶端信息

你可以通過 yii/web/Request::userHost 和 yii/web/Request::userIP 分別獲取host name和客戶機的IP地址，例如，

$userHost = Yii::$app->request->userHost;

$userIP = Yii::$app->request->userIP;

二、響應（Responses）

響應：當應用完成處理一個請求后, 會生成一個yii/web/Response響應對象并發送給終端用戶響應對象包含的信息有HTTP狀態碼，HTTP頭和主體內容等, 網頁應用開發的最終目的本質上就是根據不同的請求構建這些響應對象。

在大多是情況下主要處理繼承自 yii/web/Response 的 response 應用組件，盡管如此，Yii也允許你創建你自己的響應對象并發送給終端用戶，這方面后續會闡述。

在本節，將會描述如何構建響應和發送給終端用戶。

1.狀態碼

構建響應時，最先應做的是標識請求是否成功處理的狀態，可通過設置 yii/web/Response::statusCode 屬性，該屬性使用一個有效的HTTP 狀態碼。例如，為標識處理已被處理成功，可設置狀態碼為200，如下所示：

Yii::$app->response->statusCode = 200;

盡管如此，大多數情況下不需要明確設置狀態碼，因為 yii/web/Response::statusCode 狀態碼默認為200，如果需要指定請求失敗，可拋出對應的HTTP異常，如下所示：

throw new /yii/web/NotFoundHttpException;

當錯誤處理器捕獲到一個異常，會從異常中提取狀態碼并賦值到響應，對于上述的 yii/web/NotFoundHttpException 對應HTTP 404狀態碼，以下為Yii預定義的HTTP異常：

yii/web/BadRequestHttpException: status code 400.

yii/web/ConflictHttpException: status code 409.

yii/web/ForbiddenHttpException: status code 403.

yii/web/GoneHttpException: status code 410.

yii/web/MethodNotAllowedHttpException: status code 405.

yii/web/NotAcceptableHttpException: status code 406.

yii/web/NotFoundHttpException: status code 404.

yii/web/ServerErrorHttpException: status code 500.

yii/web/TooManyRequestsHttpException: status code 429.

yii/web/UnauthorizedHttpException: status code 401.

yii/web/UnsupportedMediaTypeHttpException: status code 415.

如果想拋出的異常不在如上列表中，可創建一個yii/web/HttpException異常，帶上狀態碼拋出，如下：

throw new /yii/web/HttpException(402);

2.HTTP 頭部

可在 response 組件中操控yii/web/Response::headers來發送HTTP頭部信息，例如：

$headers = Yii::$app->response->headers;

// 增加一個 Pragma 頭，已存在的Pragma 頭不會被覆蓋。

$headers->add('Pragma', 'no-cache');

// 設置一個Pragma 頭. 任何已存在的Pragma 頭都會被丟棄

$headers->set('Pragma', 'no-cache');

// 刪除Pragma 頭并返回刪除的Pragma 頭的值到數組

$values = $headers->remove('Pragma');

補充: 頭名稱是大小寫敏感的，在yii/web/Response::send()方法調用前新注冊的頭信息并不會發送給用戶。

3.響應主體

大多是響應應有一個主體存放你想要顯示給終端用戶的內容。

如果已有格式化好的主體字符串，可賦值到響應的yii/web/Response::content屬性，例如：

Yii::$app->response->content = 'hello world!';

如果在發送給終端用戶之前需要格式化，應設置 yii/web/Response::format 和 yii/web/Response::data 屬性，yii/web/Response::format 屬性指定yii/web/Response::data中數據格式化后的樣式，例如：

$response = Yii::$app->response;

$response->format = /yii/web/Response::FORMAT_JSON;

$response->data = ['message' => 'hello world'];

Yii支持以下可直接使用的格式，每個實現了yii/web/ResponseFormatterInterface 類，可自定義這些格式器或通過配置yii/web/Response::formatters 屬性來增加格式器。

yii/web/Response::FORMAT_HTML: 通過 yii/web/HtmlResponseFormatter 來實現.

yii/web/Response::FORMAT_XML: 通過 yii/web/XmlResponseFormatter來實現.

yii/web/Response::FORMAT_JSON: 通過 yii/web/JsonResponseFormatter來實現.

yii/web/Response::FORMAT_JSONP: 通過 yii/web/JsonResponseFormatter來實現.

上述響應主體可明確地被設置，但是在大多數情況下是通過操作方法的返回值隱式地設置，常用場景如下所示：

public function actionIndex()

{

return $this->render('index');

}

上述的 index 操作返回 index 視圖渲染結果，返回值會被 response 組件格式化后發送給終端用戶。

因為響應格式默認為yii/web/Response::FORMAT_HTML, 只需要在操作方法中返回一個字符串，如果想使用其他響應格式，應在返回數據前先設置格式，例如：

public function actionInfo()

{

/Yii::$app->response->format = /yii/web/Response::FORMAT_JSON;

return [

'message' => 'hello world',

'code' => 100,

];

}

如上所述，觸雷使用默認的 response 應用組件，也可創建自己的響應對象并發送給終端用戶，可在操作方法中返回該響應對象，如下所示：

public function actionInfo()

{

return /Yii::createObject([

  'class' => 'yii/web/Response',

  'format' => /yii/web/Response::FORMAT_JSON,

//Vevb.com

  'data' => [

   'message' => 'hello world',

   'code' => 100,

  ],

]);

}

注意: 如果創建你自己的響應對象，將不能在應用配置中設置 response 組件，盡管如此，可使用依賴注入應用通用配置到你新的響應對象。

4.瀏覽器跳轉

瀏覽器跳轉依賴于發送一個Location HTTP 頭，因為該功能通常被使用，Yii提供對它提供了特別的支持。

可調用yii/web/Response::redirect() 方法將用戶瀏覽器跳轉到一個URL地址，該方法設置合適的帶指定URL的 Location 頭并返回它自己為響應對象，在操作的方法中，可調用縮寫版yii/web/Controller::redirect()，例如：

public function actionOld()

{

return $this->redirect('http://example.com/new', 301);

}

在如上代碼中，操作的方法返回redirect() 方法的結果，如前所述，操作的方法返回的響應對象會被當總響應發送給終端用戶。

除了操作方法外，可直接調用yii/web/Response::redirect() 再調用 yii/web/Response::send() 方法來確保沒有其他內容追加到響應中。

/Yii::$app->response->redirect('http://example.com/new', 301)->send();

補充: yii/web/Response::redirect() 方法默認會設置響應狀態碼為302，該狀態碼會告訴瀏覽器請求的資源臨時放在另一個URI地址上，可傳遞一個301狀態碼告知瀏覽器請求的資源已經永久重定向到新的URId地址。

如果當前請求為AJAX 請求，發送一個 Location 頭不會自動使瀏覽器跳轉，為解決這個問題， yii/web/Response::redirect() 方法設置一個值為要跳轉的URL的X-Redirect 頭，在客戶端可編寫JavaScript 代碼讀取該頭部值然后讓瀏覽器跳轉對應的URL。

補充: Yii 配備了一個yii.js JavaScript 文件提供常用JavaScript功能，包括基于X-Redirect頭的瀏覽器跳轉，因此，如果你使用該JavaScript 文件(通過yii/web/YiiAsset 資源包注冊)，就不需要編寫AJAX跳轉的代碼。

5.發送文件

和瀏覽器跳轉類似，文件發送是另一個依賴指定HTTP頭的功能，Yii提供方法集合來支持各種文件發送需求，它們對HTTP頭都有內置的支持。

yii/web/Response::sendFile(): 發送一個已存在的文件到客戶端

yii/web/Response::sendContentAsFile(): 發送一個文本字符串作為文件到客戶端

yii/web/Response::sendStreamAsFile(): 發送一個已存在的文件流作為文件到客戶端

這些方法都將響應對象作為返回值，如果要發送的文件非常大，應考慮使用 yii/web/Response::sendStreamAsFile() 因為它更節約內存，以下示例顯示在控制器操作中如何發送文件：

public function actionDownload()

{

return /Yii::$app->response->sendFile('path/to/file.txt');

}

如果不是在操作方法中調用文件發送方法，在后面還應調用 yii/web/Response::send() 沒有其他內容追加到響應中。

/Yii::$app->response->sendFile('path/to/file.txt')->send();

一些瀏覽器提供特殊的名為X-Sendfile的文件發送功能，原理為將請求跳轉到服務器上的文件， Web應用可在服務器發送文件前結束，為使用該功能，可調用yii/web/Response::xSendFile()，如下簡要列出一些常用Web服務器如何啟用X-Sendfile 功能：

Apache: X-Sendfile

Lighttpd v1.4: X-LIGHTTPD-send-file

Lighttpd v1.5: X-Sendfile

Nginx: X-Accel-Redirect

Cherokee: X-Sendfile and X-Accel-Redirect