请求

Laravel 中文文档 / 基础功能

HTTP 请求

获取请求

要通过依赖注入获取当前 HTTP 请求的实例,可以在控制器方法中对 Illuminate\Http\Request 类使用类型提示。传入的请求实例会由 服务容器 自动注入:

namespace App\Http\Controllers;

use Illuminate\Http\Request;

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,如下所示:

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 更新指定用户
     *
     * @param  Request  $request
     * @param  string  $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 请求,并继承了 Symfony\Component\HttpFoundation\Request 类。我们将讨论下面几个最重要的方法。

获取请求路径

path 返回请求的真实路径信息。因此,如果传入的请求是 http://domain.com/foo/barpath 方法将返回 foo/bar

$uri = $request->path();

is 用来验证请求的路径是否和给定的规则相匹配。使用该方法时,可以将 * 作为通配符:

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

获取请求 URL

要获取请求的完整 URL,可以使用 urlfullUrl 方法。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 请求,首先需要安装一些库。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 响应实例后显示。

输入预处理 & 规范化

默认情况下,Laravel 应用的全局中间件栈中包含了 TrimStringsConvertEmptyStringsToNull 中间件。这些中间件在 App\Http\Kernel 类的中间件栈中列出。上述中间件会自动处理请求中的字符传参数,并将空字符串转换为 null。让您不必担心路由和控制器中的这些规范化问题。

如果要禁用该行为,可以在应用的中间件栈中移除这两个中间件,在 App\Http\Kernel 类的 $middleware 属性中将其移除。

获取输入

获取所有输入数据

您可以使用 all 方法来获取所有输入数据的数组:

$input = $request->all();

获取指定输入值

可以使用一些简单的方法,从 Illuminate\Http\Request 实例中获取所有用户输入,而不用担心使用的 HTTP 请求类型。无论使用什么 HTTP 请求类型,input 都可以获取用户输入:

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

可以将默认值作为第二个参数传递给 input 方法。如果请求中不存在请求的输入值,则会返回此值:

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

当表单中包含数组输入时,可以使用「点」来访问数组:

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

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

从查询字符串获取输入

input 会从整个请求负载(包括查询字符串)中获取值,而 query 方法只会从查询字符串中获取值:

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

如果请求的查询字符串数据不存在,将返回该方法的第二个参数值:

$name = $request->query('name', 'Helen');

您还可以不带任何参数调用 query 方法,来获取一个包含所有查询字符串键值的关联数组:

$query = $request->query();

通过动态属性获取输入

您也可以使用 Illuminate\Http\Request 实例的动态属性来获取用户输入。例如,如果一个应用的表单中包含 name 字段,可以像这样访问其值:

$name = $request->name;

当使用动态属性时,Laravel 会先在请求的负载中查找该参数值。如果不存在,Laravel 会在路由参数中查找该值。

获取 JSON 输入值

向应用发送 JSON 请求时,只要 Content-Type 请求头正确设置为 application/json,就可以通过 input 方法获取 JSON 数据。可以使用「点」语法来获取 JSON 数组中的值:

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

获取部分输入数据

如果只需要获取部分输入数据,可以使用 onlyexcept 方法。这两个方法都接收一个数组或动态列表参数:

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

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

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

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

only 方法会返回所请求的所有键/值对;但是,它不会返回请求中不存在的键/值对。

判断输入值是否存在

您应该使用 has 方法来判断请求中是否存在一个值。如果请求中存在该值,has 方法会返回 true

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

当给定一个数组时,has 方法会判断所有指定的值是否存在:

if ($request->has(['name', 'email'])) {
    //
}

如果要判断请求中是否存在一个值并且不为空,可以使用 filled 方法:

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

旧的输入

Laravel 允许在下一次请求前保留本次请求的输入。该功能在检测到错误验证后重新填充表单时特别有用。但是,如果您使用 Laravel 内置的 验证功能,则不太可能需要手动使用这些方法,因为 Laravel 内置的验证工具会自动调用它们。

将输入闪存至 Session

Illuminate\Http\Request 类的 flash 方法会将当前输入闪存到 Session,以便当用户的下个请求到达应用时依然可用:

$request->flash();

也可以使用 flashOnlyflashExcept 方法只闪存部分请求数据到 Session 中。这些方法在保护敏感信息(如密码)时非常有用:

$request->flashOnly(['username', 'email']);

$request->flashExcept('password');

闪存输入后重定向

您可能经常需要将输入闪存到 Session,然后重定向到上一页,可以在重定向时链式调用 withInput 方法:

return redirect('form')->withInput();

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

获取旧的输入

要获取上一次请求中闪存的输入,可以在 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 都会被加密并使用认证码进行签名,这意味着如果客户端改变了它们,就会被视为无效的。要从请求中获取 Cookie 值,使用 Illuminate\Http\Request 实例的 cookie 方法:

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

或者,您可以使用 Cookie Facade 来获取 Cookie 的值:

$value = Cookie::get('name');

将 Cookies 添加到响应

可以使用 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 Facade 将多个 Cookies「排队」添加到应用的响应中。queue 方法接收一个要创建的 Cookie 实例。这些 Cookie 将会在发送到浏览器之前添加到响应:

Cookie::queue(Cookie::make('name', 'value', $minutes));

Cookie::queue('name', 'value', $minutes);

生成 Cookie 实例

如果要生成一个 Symfony\Component\HttpFoundation\Cookie 实例,并在稍后将其给到响应实例,那么可以使用全局辅助函数 cookie。只有当响应被发送到客户端时,才会添加该 Cookie 到响应实例:

$cookie = cookie('name', 'value', $minutes);

return response('Hello World')->cookie($cookie);

文件

获取上传文件

可以使用 Illuminate\Http\Request 实例的 file 方法或者动态属性来获取上传文件。file 方法会返回一个 Illuminate\Http\UploadedFile 类的实例,该类继承了 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 方法接收相对于文件系统所配置的根目录的文件存储路径。该路径不包含文件名,因为会自动生成一个唯一 ID 作为文件名。

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');

配置可信代理

当应用运行在 TLS / SSL 证书失效的负载均衡上时,可能会注意到应用有时候不会生成 HTTPS 链接。通常这是因为应用正在从负载均衡的 80 端口转发流量,而不知道应该生成安全链接。

要解决此问题,可以使用 Laravel 应用包含的 App\Http\Middleware\TrustProxies 中间件,它允许您快速定义应用的可信代理。可信代理应该列在该中间件的 $proxies 属性的数组中。除了配置可信代理,还可以配置可信代理的 $headers

namespace App\Http\Middleware;

use Illuminate\Http\Request;
use Fideloper\Proxy\TrustProxies as Middleware;

class TrustProxies extends Middleware
{
    /**
     * 应用的可信代理
     *
     * @var array
     */
    protected $proxies = [
        '192.168.1.1',
        '192.168.1.2',
    ];

    /**
     * 检测代理时使用的请求头
     *
     * @var string
     */
    protected $headers = Request::HEADER_X_FORWARDED_ALL;
}

如果您使用的是 AWS Elastic Load Balancing,$headers 值应该是 Request::HEADER_X_FORWARDED_AWS_ELB。更多使用在 $headers 属性中的常量,请查看 Symfony 的文档 信任代理

信任所有代理

如果使用 Amazon AWS 或其它「云主机」提供的负载均衡,您可能不知道实际负载均衡的真实 IP 地址。这种情况下,可以使用 * 来信任所有代理:

/**
 * 应用的可信代理
 *
 * @var array
 */
protected $proxies = '*';
  上一篇 下一篇  

作者:ilaoniu

牛哥,俗称哞哞。单纯的九零后理工小青年。喜欢折腾,爱玩,爱安卓,爱音乐,爱游戏,爱电影,爱旅游...