[ Laravel 5.3 文档 ] HTTP层 —— 请求

1、访问请求实例

要通过依赖注入获取当前 HTTP 请求实例,需要在控制器的构造函数或方法中对 Illuminate\Http\Request 类进行类型提示,这样当前请求实例会被服务容器自动注入:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Routing\Controller;

class UserController extends Controller
{
    /**
     * 存储新用户
     *
     * @param Request $request
     * @return Response
     */
    public function store(Request $request)
    {
        $name=$request->input('name');

        //
    }
}

依赖注入 & 路由参数

如果你的控制器方法还期望获取路由参数,只需要将路由参数置于其它依赖之后即可,例如,如果你的路由定义如下:

Route::put('user/{id}','UserController@update');

你仍然可以对 Illuminate\Http\Request 进行类型提示并通过如下方式定义控制器方法来访问路由参数 id

<?php

namespace App\Http\Controllers;
use Illuminate\Http\Request;
classUser Controller extends Controller
{
    /**
     * 更新指定用户
     *
     * @param Request $request
     * @param int $id
     * @return Response
     */
    public function update(Request $request,$id)
    {
        //
    }
}

通过路由闭包访问请求

还可以在路由闭包上类型提示 Illuminate\Http\Request 类,在执行的时候服务容器会自动注入输入的请求到闭包:

use Illuminate\Http\Request;

Route::get('/', function (Request $request) {
    //
});

请求路径 & 方法

Illuminate\Http\Request 实例提供了多个方法来检测应用的 HTTP 请求,Laravel 的 Illuminate\Http\Request 继承自  Symfony\Component\HttpFoundation\Request 类,下面演示了该类提供的一些有用方法:

获取请求路径

path 方法将会返回请求的路径信息,因此,如果进入的请求路径是 http://domain.com/foo/bar,则 path 方法将会返回 foo/bar

$uri=$request->path();

is 方法允许你验证进入的请求是否与给定模式匹配。使用该方法时可以使用 * 通配符:

if($request->is('admin/*')){
    //
}

获取请求URL

想要获取完整的 URL,而不仅仅是路径信息,可以使用请求实例提供的 url 或 fullUrl 方法, url 方法将会返回不带查询字符串的URL,而 fullUrl 方法返回结果则包含查询字符串:

//不包含查询字符串
$url=$request->url();

//包含查询字符串
$url = $request->fullUrl();

获取请求方法

method 方法将会返回 HTTP 请求方式。你还可以使用 isMethod 方法来验证 HTTP 请求方式是否匹配给定字符串:

$method=$request->method();
if($request->isMethod('post')){ 
    //
}

PSR-7 请求

PSR-7 标准指定了 HTTP 消息接口,包括请求和响应。如果你想要获取 PSR-7 请求实例,首先需要安装一些库,Laravel 使用 Symfony HTTP Message Bridge 组件将典型的 Laravel 请求和响应转化为 兼容 PSR-7 的实现:

composer require symfony/psr-http-message-bridge
composer require zendframework/zend-diactoros

安装完这些库之后,你只需要在路由或控制器中通过对请求类型进行类型提示就可以获取 PSR-7 请求:

use Psr\Http\Message\ServerRequestInterface;

Route::get('/', function (ServerRequestInterface $request) {
    //
});

注:如果从路由或控制器返回的是 PSR-7 响应实例,则其将会自动转化为 Laravel 响应实例并显示出来。

2、获取请求输入

获取所有输入值

你可以使用 all 方法以数组格式获取所有输入值:

$input = $request->all();

获取单个输入值

使用一些简单的方法,就可以从 Illuminate\Http\Request 实例中访问用户输入。你不需要关心请求所使用的 HTTP 请求方法,因为对所有请求方式的输入都是通过 input 方法获取用户输入:

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

你还可以传递一个默认值作为第二个参数给 input 方法,如果请求输入值在当前请求未出现时该值将会被返回:

$name = $request->input('name', 'Sally');

处理表单数组输入时,可以使用”.”来访问数组输入:

$input = $request->input('products.0.name');
$names = $request->input('products.*.name');

通过动态属性获取输入

此外,你也可以通过使用 Illuminate\Http\Request 实例上的动态属性来访问用户输入。例如,如果你的应用表单包含 name 字段,那么可以像这样访问提交的值:

$name = $request->name;

使用动态属性的时候,Laravel首先会在请求中查找参数的值,如果不存在,还会到路由参数中查找。

获取JSON输入值

发送JSON请求到应用的时候,只要 Content-Type 请求头被设置为 application/json ,都可以通过 input 方法获取JSON数据,还可以通过“.”号解析数组:

$name = $request->input('user.name');

获取输入的部分数据

如果你需要取出输入数据的子集,可以使用 only 或 except 方法,这两个方法都接收一个数组或动态列表作为唯一参数:

$input = $request->only(['username', 'password']);
$input = $request->only('username', 'password');

$input = $request->except(['credit_card']);
$input = $request->except('credit_card');

判断输入值是否出现

判断值是否在请求中出现,可以使用 has 方法,如果值出现过了且不为空,has 方法返回 true

if ($request->has('name')) {
    //
}

上一次请求输入

Laravel 允许你在两次请求之间保存输入数据,这个特性在检测校验数据失败后需要重新填充表单数据时很有用,但如果你使用的是 Laravel 内置的验证服务,则不需要手动使用这些方法,因为一些 Laravel 内置的校验设置会自动调用它们。

将输入存储到一次性 Session

Illuminate\Http\Request 实例的 flash 方法会将当前输入存放到一次性 Session(所谓的一次性指的是从 Session 中取出数据中,对应数据会从 Session 中销毁)中,这样在下一次请求时数据依然有效:

$request->flash();

你还可以使用 flashOnly 和 flashExcept 方法将输入数据子集存放到 Session 中,这些方法在session之外保存敏感信息时很有用:

$request->flashOnly('username', 'email');
$request->flashExcept('password');

将输入存储到一次性 Session 然后重定向

如果你经常需要一次性存储输入并重定向到前一页,可以简单使用 withInput 方法来将输入数据链接到 redirect 后面:

return redirect('form')->withInput();
return redirect('form')->withInput($request->except('password'));

取出上次请求数据

要从 Session 中取出上次请求的输入数据,可以使用 Request 实例的 old 方法。old 方法提供了便利的方式从 Session 中取出一次性数据:

$username = $request->old('username');

Laravel 还提供了一个全局的辅助函数 old,如果你是在 Blade 模板中显示上次输入数据,使用辅助函数 old 更方便,如果给定参数没有对应输入,返回 null:

<input type="text" name="username" value="{{ old('username') }}">

Cookies

从请求中取出Cookies

Laravel 框架创建的所有 cookies 都经过加密并使用一个认证码进行签名,这意味着如果客户端修改了它们则需要对其进行有效性验证。我们使用  Illuminate\Http\Request 实例的 cookie 方法从请求中获取 cookie 的值:

$value = $request->cookie('name');

新增Cookie到响应

你可以使用 cookie 方法将一个cookie附加到输出的 Illuminate\Http\Response 实例,你需要传递名称、值、以及cookie有效期(分钟)到这个方法:

return response('Hello World')->cookie(
    'name', 'value', $minutes
);

cookie 方法可以接收一些使用频率较低的参数,一般来说,这些参数和PHP原生函数setcookie作用和意义一致:

return response('Hello World')->cookie(
    'name', 'value', $minutes, $path, $domain, $secure, $httpOnly
);

生成Cookie实例

如果你想要生成一个 Symfony\Component\HttpFoundation\Cookie 实例以便后续附加到响应实例,可以使用一个全局的辅助函数cookie,这个cookie只有在附加到响应实例上才会发送到客户端:

$cookie = cookie('name', 'value', $minutes);
return response('Hello World')->cookie($cookie);

3、文件上传

获取上传的文件

可以使用 Illuminate\Http\Request 实例提供的 file 方法或者动态属性来访问上传文件, file 方法返回 Illuminate\Http\UploadedFile 类的一个实例,该类继承自 PHP 标准库中提供与文件交互方法的 SplFileInfo 类:

$file = $request->file('photo');
$file = $request->photo;

你可以使用 hasFile 方法判断文件在请求中是否存在:

if ($request->hasFile('photo')) {
    //
}

验证文件是否上传成功

使用 isValid 方法判断文件在上传过程中是否出错:

if ($request->file('photo')->isValid()){
    //
}

文件路径 & 扩展名

UploadedFile 类还提供了访问上传文件绝对路径和扩展名的方法。 extension 方法可以基于文件内容判断文件扩展名,该扩展名可能会和客户端提供的扩展名不一致:

$path = $request->photo->path();
$extension = $request->photo->extension();

其他文件方法

UploadedFile 实例上还有很多其他可用方法,查看该类的API文档了解更多信息。

保存上传的文件

要保存上传的文件,通常需要使用你所配置的其中一个文件系统, UploadedFile 类有一个 store 方法,该方法会将上传文件移动到相应的磁盘路径上,该路径可以是本地文件系统的某个位置,也可以是云存储(如Amazon S3)上的路径。

store 方法接收一个文件保存的相对路径(相对于文件系统配置的根目录 ),该路径不应该包含文件名,因为文件名会通过对文件内容进行md5自动生成。

store 方法还接收一个可选的参数——用于存储文件的磁盘名称作为第二个参数,该方法会方返回相对于根目录的文件路径:

$path = $request->photo->store('images');
$path = $request->photo->store('images', 's3');

如果你不想自动生成文件名,可以使用 storeAs 方法,该方法接收保存路径、文件名和磁盘名作为参数:

$path = $request->photo->storeAs('images', 'filename.jpg');
$path = $request->photo->storeAs('images', 'filename.jpg', 's3');

学院君

学院君 has written 548 articles

资深PHP工程师,Laravel学院院长