Yii 中文社区 · 更新于 2017-10-22 19:00:24

请求

一个应用的请求是用 [[yii\web\Request]] 对象来表示的,该对象提供了诸如请求参数(译者注:通常是 GET 参数或者 POST 参数)、HTTP 头、cookies 等信息。默认情况下,对于一个给定的请求,你可以通过 request application component 应用组件([[yii\web\Request]] 类的实例)获得访问相应的请求对象。在本章节,我们将介绍怎样在你的应用中使用这个组件。

请求参数

要获取请求参数,你可以调用 request 组件的 [[yii\web\Request::get()|get()]] 方法和 [[yii\web\Request::post()|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 参数,POSTPUTPATCH 等等这些提交上来的参数是在请求体中被发送的。当你通过上面介绍的方法访问这些参数的时候,request 组件会解析这些参数。你可以通过配置 [[yii\web\Request::parsers]] 属性来自定义怎样解析这些参数。

请求方法

你可以通过 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 */ }

请求 URLs

request 组件提供了许多方式来检测当前请求的 URL。

假设被请求的 URL 是 http://example.com/admin/index.php/product?id=100,你可以像下面描述的那样获取 URL 的各个部分:

  • [[yii\web\Request::url|url]]:返回 /admin/index.php/product?id=100, 此 URL 不包括 host info 部分。
  • [[yii\web\Request::absoluteUrl|absoluteUrl]]:返回 http://example.com/admin/index.php/product?id=100,包含 host infode 的整个 URL。
  • [[yii\web\Request::hostInfo|hostInfo]]:返回 http://example.com, 只有 host info 部分。
  • [[yii\web\Request::pathInfo|pathInfo]]:返回 /product, 这个是入口脚本之后,问号之前(查询字符串)的部分。
  • [[yii\web\Request::queryString|queryString]]:返回 id=100,问号之后的部分。
  • [[yii\web\Request::baseUrl|baseUrl]]:返回 /admin, host info 之后,入口脚本之前的部分。
  • [[yii\web\Request::scriptUrl|scriptUrl]]:返回 /admin/index.php, 没有 path info 和查询字符串部分。
  • [[yii\web\Request::serverName|serverName]]:返回 example.com, URL 中的 host name。
  • [[yii\web\Request::serverPort|serverPort]]:返回 80, 这是 web 服务中使用的端口。

HTTP 头

你可以通过 [[yii\web\Request::headers]] 属性返回的 [[yii\web\HeaderCollection|header collection]] 获取 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|userAgent]]:返回 User-Agent 头。
  • [[yii\web\Request::contentType|contentType]]:返回 Content-Type 头的值, Content-Type 是请求体中 MIME 类型数据。
  • [[yii\web\Request::acceptableContentTypes|acceptableContentTypes]]:返回用户可接受的内容 MIME 类型。返回的类型是按照他们的质量得分来排序的。得分最高的类型将被最先返回。
  • [[yii\web\Request::acceptableLanguages|acceptableLanguages]]:返回用户可接受的语言。返回的语言是按照他们的偏好层次来排序的。第一个参数代表最优先的语言。

假如你的应用支持多语言,并且你想在终端用户最喜欢的语言中显示页面,那么你可以使用语言协商方法 [[yii\web\Request::getPreferredLanguage()]]。这个方法通过 [[yii\web\Request::acceptableLanguages|acceptableLanguages]] 在你的应用中所支持的语言列表里进行比较筛选,返回最适合的语言。

提示:你也可以使用 [[yii\filters\ContentNegotiator|ContentNegotiator]] 过滤器进行动态确定哪些内容类型和语言应该在响应中使用。这个过滤器实现了上面介绍的内容协商的属性和方法。

客户端信息

你可以通过 [[yii\web\Request::userHost|userHost]] 和 [[yii\web\Request::userIP|userIP]] 分别获取 host name 和客户机的 IP 地址,例如,

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