解讀PHP的Yii框架中請(qǐng)求與響應(yīng)的處理流程，yii框架

一、請(qǐng)求（Requests）
請(qǐng)求：
一個(gè)應(yīng)用的請(qǐng)求是用 yii\web\Request 對(duì)象來表示的，該對(duì)象提供了諸如 請(qǐng)求參數(shù)（譯者注：通常是GET參數(shù)或者POST參數(shù)）、HTTP頭、cookies等信息。 默認(rèn)情況下，對(duì)于一個(gè)給定的請(qǐng)求，你可以通過 request application component 應(yīng)用組件（yii\web\Request 類的實(shí)例） 獲得訪問相應(yīng)的請(qǐng)求對(duì)象。在本章節(jié)，我們將介紹怎樣在你的應(yīng)用中使用這個(gè)組件。

1.請(qǐng)求參數(shù)

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

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

$get = $request->get(); 
// 等價(jià)于: $get = $_GET;

$id = $request->get('id'); 
// 等價(jià)于: $id = isset($_GET['id']) ? $_GET['id'] : null;

$id = $request->get('id', 1); 
// 等價(jià)于: $id = isset($_GET['id']) ? $_GET['id'] : 1;

$post = $request->post(); 
// 等價(jià)于: $post = $_POST;

$name = $request->post('name'); 
// 等價(jià)于: $name = isset($_POST['name']) ? $_POST['name'] : null;

$name = $request->post('name', ''); 
// 等價(jià)于: $name = isset($_POST['name']) ? $_POST['name'] : '';

信息：建議你像上面那樣通過 request 組件來獲取請(qǐng)求參數(shù)，而不是 直接訪問 $_GET 和 $_POST。 這使你更容易編寫測(cè)試用例，因?yàn)槟憧梢詡卧鞌?shù)據(jù)來創(chuàng)建一個(gè)模擬請(qǐng)求組件。
當(dāng)實(shí)現(xiàn) RESTful APIs 接口的時(shí)候，你經(jīng)常需要獲取通過PUT， PATCH或者其他的 request methods 請(qǐng)求方法提交上來的參數(shù)。你可以通過調(diào)用 yii\web\Request::getBodyParam() 方法來獲取這些參數(shù)。例如，

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

// 返回所有參數(shù)
$params = $request->bodyParams;

// 返回參數(shù) "id"
$param = $request->getBodyParam('id');

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

2.請(qǐng)求方法

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

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

if ($request->isAjax) { /* 該請(qǐng)求是一個(gè) AJAX 請(qǐng)求 */ }
if ($request->isGet) { /* 請(qǐng)求方法是 GET */ }
if ($request->isPost) { /* 請(qǐng)求方法是 POST */ }
if ($request->isPut) { /* 請(qǐng)求方法是 PUT */ }

3.請(qǐng)求URLs

request 組件提供了許多方式來檢測(cè)當(dāng)前請(qǐng)求的URL。

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

• 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的整個(gè)URL。
• yii\web\Request::hostInfo：返回 http://example.com, 只有host info部分。
• yii\web\Request::pathInfo：返回 /product， 這個(gè)是入口腳本之后，問號(hào)之前（查詢字符串）的部分。
• yii\web\Request::queryString：返回 id=100,問號(hào)之后的部分。
• 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服務(wù)中使用的端口。

4.HTTP頭

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

// $headers 是一個(gè) yii\web\HeaderCollection 對(duì)象
$headers = Yii::$app->request->headers;

// 返回 Accept header 值
$accept = $headers->get('Accept');

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

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

• yii\web\Request::userAgent：返回 User-Agent 頭。
• yii\web\Request::contentType：返回 Content-Type 頭的值， Content-Type 是請(qǐng)求體中MIME類型數(shù)據(jù)。
• yii\web\Request::acceptableContentTypes：返回用戶可接受的內(nèi)容MIME類型。 返回的類型是按照他們的質(zhì)量得分來排序的。得分最高的類型將被最先返回。
• yii\web\Request::acceptableLanguages：返回用戶可接受的語言。 返回的語言是按照他們的偏好層次來排序的。第一個(gè)參數(shù)代表最優(yōu)先的語言。

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

提示：你也可以使用 yii\filters\ContentNegotiator 過濾器進(jìn)行動(dòng)態(tài)確定哪些內(nèi)容類型和語言應(yīng)該在響應(yīng)中使用。 這個(gè)過濾器實(shí)現(xiàn)了上面介紹的內(nèi)容協(xié)商的屬性和方法。

5.客戶端信息

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

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

二、響應(yīng)（Responses）
響應(yīng)：
當(dāng)應(yīng)用完成處理一個(gè)請(qǐng)求后, 會(huì)生成一個(gè)yii\web\Response響應(yīng)對(duì)象并發(fā)送給終端用戶 響應(yīng)對(duì)象包含的信息有HTTP狀態(tài)碼，HTTP頭和主體內(nèi)容等, 網(wǎng)頁應(yīng)用開發(fā)的最終目的本質(zhì)上就是根據(jù)不同的請(qǐng)求構(gòu)建這些響應(yīng)對(duì)象。

在大多是情況下主要處理繼承自 yii\web\Response 的 response 應(yīng)用組件， 盡管如此，Yii也允許你創(chuàng)建你自己的響應(yīng)對(duì)象并發(fā)送給終端用戶，這方面后續(xù)會(huì)闡述。

在本節(jié)，將會(huì)描述如何構(gòu)建響應(yīng)和發(fā)送給終端用戶。

1.狀態(tài)碼

構(gòu)建響應(yīng)時(shí)，最先應(yīng)做的是標(biāo)識(shí)請(qǐng)求是否成功處理的狀態(tài)，可通過設(shè)置 yii\web\Response::statusCode 屬性，該屬性使用一個(gè)有效的HTTP 狀態(tài)碼。例如，為標(biāo)識(shí)處理已被處理成功， 可設(shè)置狀態(tài)碼為200，如下所示：

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

盡管如此，大多數(shù)情況下不需要明確設(shè)置狀態(tài)碼，因?yàn)?yii\web\Response::statusCode 狀態(tài)碼默認(rèn)為200， 如果需要指定請(qǐng)求失敗，可拋出對(duì)應(yīng)的HTTP異常，如下所示：

throw new \yii\web\NotFoundHttpException;

當(dāng)錯(cuò)誤處理器 捕獲到一個(gè)異常，會(huì)從異常中提取狀態(tài)碼并賦值到響應(yīng)， 對(duì)于上述的 yii\web\NotFoundHttpException 對(duì)應(yīng)HTTP 404狀態(tài)碼，以下為Yii預(yù)定義的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.

如果想拋出的異常不在如上列表中，可創(chuàng)建一個(gè)yii\web\HttpException異常，帶上狀態(tài)碼拋出，如下：

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

2.HTTP 頭部

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

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

// 增加一個(gè) Pragma 頭，已存在的Pragma 頭不會(huì)被覆蓋。
$headers->add('Pragma', 'no-cache');

// 設(shè)置一個(gè)Pragma 頭. 任何已存在的Pragma 頭都會(huì)被丟棄
$headers->set('Pragma', 'no-cache');

// 刪除Pragma 頭并返回刪除的Pragma 頭的值到數(shù)組
$values = $headers->remove('Pragma');

補(bǔ)充: 頭名稱是大小寫敏感的，在yii\web\Response::send()方法調(diào)用前新注冊(cè)的頭信息并不會(huì)發(fā)送給用戶。

3.響應(yīng)主體

大多是響應(yīng)應(yīng)有一個(gè)主體存放你想要顯示給終端用戶的內(nèi)容。

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

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

如果在發(fā)送給終端用戶之前需要格式化，應(yīng)設(shè)置 yii\web\Response::format 和 yii\web\Response::data 屬性，yii\web\Response::format 屬性指定yii\web\Response::data中數(shù)據(jù)格式化后的樣式，例如：

$response = Yii::$app->response;
$response->format = \yii\web\Response::FORMAT_JSON;
$response->data = ['message' => 'hello world'];

Yii支持以下可直接使用的格式，每個(gè)實(shí)現(xiàn)了yii\web\ResponseFormatterInterface 類， 可自定義這些格式器或通過配置yii\web\Response::formatters 屬性來增加格式器。

• yii\web\Response::FORMAT_HTML: 通過 yii\web\HtmlResponseFormatter 來實(shí)現(xiàn).
• yii\web\Response::FORMAT_XML: 通過 yii\web\XmlResponseFormatter來實(shí)現(xiàn).
• yii\web\Response::FORMAT_JSON: 通過 yii\web\JsonResponseFormatter來實(shí)現(xiàn).
• yii\web\Response::FORMAT_JSONP: 通過 yii\web\JsonResponseFormatter來實(shí)現(xiàn).

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

public function actionIndex()
{
 return $this->render('index');
}

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

因?yàn)轫憫?yīng)格式默認(rèn)為yii\web\Response::FORMAT_HTML, 只需要在操作方法中返回一個(gè)字符串， 如果想使用其他響應(yīng)格式，應(yīng)在返回?cái)?shù)據(jù)前先設(shè)置格式，例如：

public function actionInfo()
{
 \Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;
 return [
  'message' => 'hello world',
  'code' => 100,
 ];
}

如上所述，觸雷使用默認(rèn)的 response 應(yīng)用組件，也可創(chuàng)建自己的響應(yīng)對(duì)象并發(fā)送給終端用戶，可在操作方法中返回該響應(yīng)對(duì)象，如下所示：

public function actionInfo()
{
 return \Yii::createObject([
  'class' => 'yii\web\Response',
  'format' => \yii\web\Response::FORMAT_JSON,
  'data' => [
   'message' => 'hello world',
   'code' => 100,
  ],
 ]);
}

注意: 如果創(chuàng)建你自己的響應(yīng)對(duì)象，將不能在應(yīng)用配置中設(shè)置 response 組件，盡管如此， 可使用 依賴注入 應(yīng)用通用配置到你新的響應(yīng)對(duì)象。

4.瀏覽器跳轉(zhuǎn)

瀏覽器跳轉(zhuǎn)依賴于發(fā)送一個(gè)Location HTTP 頭，因?yàn)樵摴δ芡ǔ１皇褂?，Yii提供對(duì)它提供了特別的支持。

可調(diào)用yii\web\Response::redirect() 方法將用戶瀏覽器跳轉(zhuǎn)到一個(gè)URL地址，該方法設(shè)置合適的 帶指定URL的 Location 頭并返回它自己為響應(yīng)對(duì)象，在操作的方法中，可調(diào)用縮寫版yii\web\Controller::redirect()，例如：

public function actionOld()
{
 return $this->redirect('http://example.com/new', 301);
}

在如上代碼中，操作的方法返回redirect() 方法的結(jié)果，如前所述，操作的方法返回的響應(yīng)對(duì)象會(huì)被當(dāng)總響應(yīng)發(fā)送給終端用戶。

除了操作方法外，可直接調(diào)用yii\web\Response::redirect() 再調(diào)用 yii\web\Response::send() 方法來確保沒有其他內(nèi)容追加到響應(yīng)中。

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

補(bǔ)充: yii\web\Response::redirect() 方法默認(rèn)會(huì)設(shè)置響應(yīng)狀態(tài)碼為302，該狀態(tài)碼會(huì)告訴瀏覽器請(qǐng)求的資源 臨時(shí) 放在另一個(gè)URI地址上，可傳遞一個(gè)301狀態(tài)碼告知瀏覽器請(qǐng)求的資源已經(jīng) 永久 重定向到新的URId地址。
如果當(dāng)前請(qǐng)求為AJAX 請(qǐng)求，發(fā)送一個(gè) Location 頭不會(huì)自動(dòng)使瀏覽器跳轉(zhuǎn)，為解決這個(gè)問題， yii\web\Response::redirect() 方法設(shè)置一個(gè)值為要跳轉(zhuǎn)的URL的X-Redirect 頭， 在客戶端可編寫JavaScript 代碼讀取該頭部值然后讓瀏覽器跳轉(zhuǎn)對(duì)應(yīng)的URL。

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

5.發(fā)送文件

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

• yii\web\Response::sendFile(): 發(fā)送一個(gè)已存在的文件到客戶端
• yii\web\Response::sendContentAsFile(): 發(fā)送一個(gè)文本字符串作為文件到客戶端
• yii\web\Response::sendStreamAsFile(): 發(fā)送一個(gè)已存在的文件流作為文件到客戶端

這些方法都將響應(yīng)對(duì)象作為返回值，如果要發(fā)送的文件非常大，應(yīng)考慮使用 yii\web\Response::sendStreamAsFile() 因?yàn)樗?jié)約內(nèi)存，以下示例顯示在控制器操作中如何發(fā)送文件：

public function actionDownload()
{
 return \Yii::$app->response->sendFile('path/to/file.txt');
}

如果不是在操作方法中調(diào)用文件發(fā)送方法，在后面還應(yīng)調(diào)用 yii\web\Response::send() 沒有其他內(nèi)容追加到響應(yīng)中。

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

一些瀏覽器提供特殊的名為X-Sendfile的文件發(fā)送功能，原理為將請(qǐng)求跳轉(zhuǎn)到服務(wù)器上的文件， Web應(yīng)用可在服務(wù)器發(fā)送文件前結(jié)束，為使用該功能，可調(diào)用yii\web\Response::xSendFile()， 如下簡(jiǎn)要列出一些常用Web服務(wù)器如何啟用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

6.發(fā)送響應(yīng)

在yii\web\Response::send() 方法調(diào)用前響應(yīng)中的內(nèi)容不會(huì)發(fā)送給用戶，該方法默認(rèn)在yii\base\Application::run() 結(jié)尾自動(dòng)調(diào)用，盡管如此，可以明確調(diào)用該方法強(qiáng)制立即發(fā)送響應(yīng)。

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

• 觸發(fā) yii\web\Response::EVENT_BEFORE_SEND 事件.
• 調(diào)用 yii\web\Response::prepare() 來格式化 yii\web\Response::data 為 yii\web\Response::content.
• 觸發(fā) yii\web\Response::EVENT_AFTER_PREPARE 事件.
• 調(diào)用 yii\web\Response::sendHeaders() 來發(fā)送注冊(cè)的HTTP頭
• 調(diào)用 yii\web\Response::sendContent() 來發(fā)送響應(yīng)主體內(nèi)容
• 觸發(fā) yii\web\Response::EVENT_AFTER_SEND 事件.

一旦yii\web\Response::send() 方法被執(zhí)行后，其他地方調(diào)用該方法會(huì)被忽略， 這意味著一旦響應(yīng)發(fā)出后，就不能再追加其他內(nèi)容。

如你所見yii\web\Response::send() 觸發(fā)了幾個(gè)實(shí)用的事件，通過響應(yīng)這些事件可調(diào)整或包裝響應(yīng)。

您可能感興趣的文章:

• PHP的Yii框架中行為的定義與綁定方法講解
• 詳解在PHP的Yii框架中使用行為Behaviors的方法
• 深入講解PHP的Yii框架中的屬性（Property）
• PHP的Yii框架中使用數(shù)據(jù)庫的配置和SQL操作實(shí)例教程
• 實(shí)例講解如何在PHP的Yii框架中進(jìn)行錯(cuò)誤和異常處理
• 解析PHP的Yii框架中cookie和session功能的相關(guān)操作
• 簡(jiǎn)要剖析PHP的Yii框架的組件化機(jī)制的基本知識(shí)
• PHP的Yii框架中YiiBase入口類的擴(kuò)展寫法示例
• 詳解PHP的Yii框架的運(yùn)行機(jī)制及其路由功能
• 深入解析PHP的Yii框架中的event事件機(jī)制
• 全面解讀PHP的Yii框架中的日志功能
• PHP的Yii框架中移除組件所綁定的行為的方法