解讀PHP的Yii架構中請求與響應的處理流程_php技巧

一、請求（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,  '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-SendfileLighttpd v1.4: X-LIGHTTPD-send-fileLighttpd v1.5: X-SendfileNginx: X-Accel-RedirectCherokee: X-Sendfile and X-Accel-Redirect

6.發送響應

在yii\web\Response::send() 方法調用前響應中的內容不會發送給使用者，該方法預設在yii\base\Application::run() 結尾自動調用，儘管如此，可以明確調用該方法強制立即發送響應。

yii\web\Response::send() 方法使用以下步驟來發送響應：

• 觸發 yii\web\Response::EVENT_BEFORE_SEND 事件.
• 調用 yii\web\Response::prepare() 來格式化 yii\web\Response::data 為 yii\web\Response::content.
• 觸發 yii\web\Response::EVENT_AFTER_PREPARE 事件.
• 調用 yii\web\Response::sendHeaders() 來發送註冊的HTTP頭
• 調用 yii\web\Response::sendContent() 來發送響應主體內容
• 觸發 yii\web\Response::EVENT_AFTER_SEND 事件.

一旦yii\web\Response::send() 方法被執行後，其他地方調用該方法會被忽略， 這意味著一旦響應發出後，就不能再追加其他內容。

如你所見yii\web\Response::send() 觸發了幾個實用的事件，通過響應這些事件可調整或封裝響應。