HTTP 请求

简介

Laravel 的 Illuminate\Http\Request 类提供了一种面向对象的方式来与应用程序正在处理的当前 HTTP 请求进行交互，以及检索随请求提交的输入、cookie 和文件。

与请求交互

访问请求

要通过依赖注入获取当前 HTTP 请求的实例，你应该在路由闭包或控制器方法上类型提示 Illuminate\Http\Request 类。传入的请求实例将由 Laravel 服务容器自动注入：

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 存储新用户。
     */
    public function store(Request $request): RedirectResponse
    {
        $name = $request->input('name');

        // 存储用户...

        return redirect('/users');
    }
}

如前所述，你也可以在路由闭包上类型提示 Illuminate\Http\Request 类。服务容器将在执行闭包时自动将传入的请求注入其中：

use Illuminate\Http\Request;

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

依赖注入与路由参数

如果你的控制器方法还期望从路由参数接收输入，你应该在其他依赖项之后列出路由参数。例如，如果你的路由定义如下：

use App\Http\Controllers\UserController;

Route::put('/user/{id}', [UserController::class, 'update']);

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

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;

class UserController extends Controller
{
    /**
     * 更新指定的用户。
     */
    public function update(Request $request, string $id): RedirectResponse
    {
        // 更新用户...

        return redirect('/users');
    }
}

请求路径、主机和方法

Illuminate\Http\Request 实例提供了多种方法来检查传入的 HTTP 请求，并继承了 Symfony\Component\HttpFoundation\Request 类。我们将在下面讨论一些最重要的方法。

获取请求路径

path 方法返回请求的路径信息。因此，如果传入请求的目标是 http://example.com/foo/bar，path 方法将返回 foo/bar：

$uri = $request->path();

检查请求路径 / 路由

is 方法允许你验证传入请求路径是否与给定模式匹配。使用此方法时，你可以使用 * 字符作为通配符：

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

使用 routeIs 方法，你可以确定传入请求是否匹配了命名路由：

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

获取请求 URL

要获取传入请求的完整 URL，你可以使用 url 或 fullUrl 方法。url 方法将返回不带查询字符串的 URL，而 fullUrl 方法包含查询字符串：

$url = $request->url();

$urlWithQueryString = $request->fullUrl();

如果你想将查询字符串数据追加到当前 URL，可以调用 fullUrlWithQuery 方法。此方法将给定的查询字符串变量数组与当前查询字符串合并：

$request->fullUrlWithQuery(['type' => 'phone']);

如果你想获取不包含给定查询字符串参数的当前 URL，可以使用 fullUrlWithoutQuery 方法：

$request->fullUrlWithoutQuery(['type']);

获取请求主机

你可以通过 host、httpHost 和 schemeAndHttpHost 方法获取传入请求的「主机」：

$request->host();
$request->httpHost();
$request->schemeAndHttpHost();

获取请求方法

method 方法将返回请求的 HTTP 动词。你可以使用 isMethod 方法来验证 HTTP 动词是否与给定字符串匹配：

$method = $request->method();

if ($request->isMethod('post')) {
    // ...
}

请求头

你可以使用 header 方法从 Illuminate\Http\Request 实例中获取请求头。如果请求中不存在该头，将返回 null。但是，header 方法接受一个可选的第二个参数，如果请求中不存在该头，将返回该值：

$value = $request->header('X-Header-Name');

$value = $request->header('X-Header-Name', 'default');

hasHeader 方法可用于确定请求是否包含给定的头：

if ($request->hasHeader('X-Header-Name')) {
    // ...
}

为方便起见，bearerToken 方法可用于从 Authorization 头中获取 bearer 令牌。如果不存在该头，将返回空字符串：

$token = $request->bearerToken();

请求 IP 地址

ip 方法可用于获取向应用程序发出请求的客户端的 IP 地址：

$ipAddress = $request->ip();

如果你想获取一个 IP 地址数组，包括所有由代理转发的客户端 IP 地址，可以使用 ips 方法。「原始」客户端 IP 地址将位于数组的末尾：

$ipAddresses = $request->ips();

通常，IP 地址应被视为不可信的、用户控制的输入，仅用于信息参考目的。

内容协商

Laravel 提供了几种方法，通过 Accept 头检查传入请求所请求的内容类型。首先，getAcceptableContentTypes 方法将返回一个包含请求接受的所有内容类型的数组：

$contentTypes = $request->getAcceptableContentTypes();

accepts 方法接受一个内容类型数组，如果请求接受任何内容类型，则返回 true。否则，将返回 false：

if ($request->accepts(['text/html', 'application/json'])) {
    // ...
}

你可以使用 prefers 方法来确定给定内容类型数组中哪种内容类型是请求最偏好的。如果请求不接受任何提供的内容类型，将返回 null：

$preferred = $request->prefers(['text/html', 'application/json']);

由于许多应用程序只提供 HTML 或 JSON，你可以使用 expectsJson 方法快速确定传入请求是否期望 JSON 响应：

if ($request->expectsJson()) {
    // ...
}

如果你需要确定请求是否特别偏好 Markdown 或是否会在其他内容类型中接受 Markdown（例如为 AI 代理或其他消费 Markdown 响应的客户端提供服务时），你可以使用 wantsMarkdown 和 acceptsMarkdown 方法：

if ($request->wantsMarkdown()) {
    // 客户端最偏好的内容类型是 text/markdown...
}

if ($request->acceptsMarkdown()) {
    // 客户端接受 Markdown 响应...
}

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 nyholm/psr7

安装这些库后，你可以通过在路由闭包或控制器方法上类型提示请求接口来获取 PSR-7 请求：

use Psr\Http\Message\ServerRequestInterface;

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

NOTE

如果你从路由或控制器返回 PSR-7 响应实例，它将自动转换回 Laravel 响应实例并由框架显示。

输入

获取输入

获取所有输入数据

你可以使用 all 方法以 array 形式获取传入请求的所有输入数据。无论传入请求来自 HTML 表单还是 XHR 请求，都可以使用此方法：

$input = $request->all();

使用 collect 方法，你可以将传入请求的所有输入数据作为集合获取：

$input = $request->collect();

collect 方法还允许你将传入请求的输入子集作为集合获取：

$request->collect('users')->each(function (string $user) {
    // ...
});

获取输入值

使用几个简单的方法，你可以从 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 方法，以关联数组形式获取所有输入值：

$input = $request->input();

从查询字符串获取输入

input 方法从整个请求载荷（包括查询字符串）中获取值，而 query 方法只从查询字符串中获取值：

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

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

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

你可以不带任何参数调用 query 方法，以关联数组形式获取所有查询字符串值：

$query = $request->query();

获取 JSON 输入值

向应用程序发送 JSON 请求时，只要请求的 Content-Type 头正确设置为 application/json，你就可以通过 input 方法访问 JSON 数据。你甚至可以使用「点」语法来获取嵌套在 JSON 数组/对象中的值：

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

获取 Stringable 输入值

你可以使用 string 方法将请求数据作为 Illuminate\Support\Stringable 的实例获取，而不是作为原始 string 获取请求的输入数据：

$name = $request->string('name')->trim();

获取整数输入值

要将输入值作为整数获取，可以使用 integer 方法。此方法将尝试将输入值转换为整数。如果输入不存在或转换失败，它将返回你指定的默认值。这对于分页或其他数字输入特别有用：

$perPage = $request->integer('per_page');

获取布尔输入值

处理复选框等 HTML 元素时，你的应用程序可能会收到实际上是字符串的「真值」。例如，「true」或「on」。为方便起见，你可以使用 boolean 方法将这些值作为布尔值获取。boolean 方法对 1、「1」、true、「true」、「on」和「yes」返回 true。所有其他值将返回 false：

$archived = $request->boolean('archived');

获取数组输入值

包含数组的输入值可以使用 array 方法获取。此方法将始终将输入值转换为数组。如果请求不包含具有给定名称的输入值，将返回空数组：

$versions = $request->array('versions');

获取日期输入值

为方便起见，包含日期/时间的输入值可以使用 date 方法作为 Carbon 实例获取。如果请求不包含具有给定名称的输入值，将返回 null：

$birthday = $request->date('birthday');

date 方法接受的第二个和第三个参数可分别用于指定日期的格式和时区：

$elapsed = $request->date('elapsed', '!H:i', 'Europe/Madrid');

如果输入值存在但格式无效，将抛出 InvalidArgumentException；因此，建议在调用 date 方法之前验证输入。

获取枚举输入值

对应于 PHP 枚举的输入值也可以从请求中获取。如果请求不包含具有给定名称的输入值，或者枚举没有与输入值匹配的支持值，将返回 null。enum 方法接受输入值的名称和枚举类作为其第一个和第二个参数：

use App\Enums\Status;

$status = $request->enum('status', Status::class);

你也可以提供一个默认值，当值缺失或无效时将返回该值：

$status = $request->enum('status', Status::class, Status::Pending);

如果输入值是对应于 PHP 枚举的值数组，你可以使用 enums 方法将值数组作为枚举实例获取：

use App\Enums\Product;

$products = $request->enums('products', Product::class);

通过动态属性获取输入

你也可以使用 Illuminate\Http\Request 实例上的动态属性来访问用户输入。例如，如果你的应用程序的某个表单包含 name 字段，你可以像这样访问该字段的值：

$name = $request->name;

使用动态属性时，Laravel 将首先在请求载荷中查找参数的值。如果不存在，Laravel 将在匹配路由的参数中搜索该字段。

获取部分输入数据

如果你需要获取输入数据的子集，可以使用 only 和 except 方法。这两个方法都接受单个 array 或动态参数列表：

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

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

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

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

WARNING

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

输入存在性

你可以使用 has 方法来确定请求中是否存在某个值。如果请求中存在该值，has 方法返回 true：

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

给定数组时，has 方法将确定所有指定的值是否都存在：

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

hasAny 方法在任何指定的值存在时返回 true：

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

whenHas 方法将在请求中存在某个值时执行给定的闭包：

$request->whenHas('name', function (string $input) {
    // ...
});

可以向 whenHas 方法传递第二个闭包，当指定的值不在请求中时将执行该闭包：

$request->whenHas('name', function (string $input) {
    // "name" 值存在...
}, function () {
    // "name" 值不存在...
});

如果你想确定请求中是否存在某个值且不是空字符串，可以使用 filled 方法：

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

如果你想确定某个值是否在请求中缺失或是空字符串，可以使用 isNotFilled 方法：

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

给定数组时，isNotFilled 方法将确定所有指定的值是否都缺失或为空：

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

anyFilled 方法在任何指定的值不是空字符串时返回 true：

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

whenFilled 方法将在请求中存在某个值且不是空字符串时执行给定的闭包：

$request->whenFilled('name', function (string $input) {
    // ...
});

可以向 whenFilled 方法传递第二个闭包，当指定的值不是「已填充」时将执行该闭包：

$request->whenFilled('name', function (string $input) {
    // "name" 值已填充...
}, function () {
    // "name" 值未填充...
});

要确定请求中是否缺少给定键，可以使用 missing 和 whenMissing 方法：

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

$request->whenMissing('name', function () {
    // "name" 值缺失...
}, function () {
    // "name" 值存在...
});

合并额外输入

有时你可能需要手动将额外的输入合并到请求的现有输入数据中。为此，你可以使用 merge 方法。如果请求中已存在给定的输入键，它将被提供给 merge 方法的数据覆盖：

$request->merge(['votes' => 0]);

mergeIfMissing 方法可用于在请求的输入数据中不存在相应键时将输入合并到请求中：

$request->mergeIfMissing(['votes' => 0]);

旧输入

Laravel 允许你在下一次请求期间保留来自上一次请求的输入。此功能对于在检测到验证错误后重新填充表单特别有用。但是，如果你使用 Laravel 包含的验证功能，你可能不需要直接手动使用这些会话输入闪存方法，因为 Laravel 的一些内置验证工具会自动调用它们。

将输入闪存到会话

Illuminate\Http\Request 类上的 flash 方法会将当前输入闪存到会话，以便在用户对应用程序的下一次请求期间可用：

$request->flash();

你也可以使用 flashOnly 和 flashExcept 方法将请求数据的子集闪存到会话。这些方法对于将密码等敏感信息排除在会话之外很有用：

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

$request->flashExcept('password');

闪存输入后重定向

由于你经常需要将输入闪存到会话然后重定向到上一页，你可以使用 withInput 方法轻松地将输入闪存链接到重定向上：

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

return redirect()->route('user.create')->withInput();

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

获取旧输入

要从上一次请求中获取闪存的输入，请在 Illuminate\Http\Request 的实例上调用 old 方法。old 方法将从会话中提取之前闪存的输入数据：

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

Laravel 还提供了一个全局 old 辅助函数。如果你在 Blade 模板中显示旧输入，使用 old 辅助函数来重新填充表单会更方便。如果给定字段不存在旧输入，将返回 null：

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

Cookie

从请求中获取 Cookie

Laravel 框架创建的所有 cookie 都经过加密并使用认证码签名，这意味着如果它们被客户端更改，将被视为无效。要从请求中获取 cookie 值，请在 Illuminate\Http\Request 实例上使用 cookie 方法：

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

输入修剪与规范化

默认情况下，Laravel 在应用程序的全局 middleware 栈中包含 Illuminate\Foundation\Http\Middleware\TrimStrings 和 Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull middleware。这些 middleware 会自动修剪请求中所有传入的字符串字段，并将任何空字符串字段转换为 null。这使你不必在路由和控制器中担心这些规范化问题。

禁用输入规范化

如果你想为所有请求禁用此行为，可以通过在应用程序的 bootstrap/app.php 文件中调用 $middleware->remove 方法从应用程序的 middleware 栈中移除这两个 middleware：

use Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull;
use Illuminate\Foundation\Http\Middleware\TrimStrings;

->withMiddleware(function (Middleware $middleware): void {
    $middleware->remove([
        ConvertEmptyStringsToNull::class,
        TrimStrings::class,
    ]);
})

如果你想为应用程序的请求子集禁用字符串修剪和空字符串转换，可以在应用程序的 bootstrap/app.php 文件中使用 trimStrings 和 convertEmptyStringsToNull middleware 方法。两个方法都接受一个闭包数组，这些闭包应返回 true 或 false 以指示是否应跳过输入规范化：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->convertEmptyStringsToNull(except: [
        fn (Request $request) => $request->is('admin/*'),
    ]);

    $middleware->trimStrings(except: [
        fn (Request $request) => $request->is('admin/*'),
    ]);
})

文件

获取上传的文件

你可以使用 file 方法或动态属性从 Illuminate\Http\Request 实例中获取上传的文件。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 方法接受文件应存储的相对于文件系统配置的根目录的路径。此路径不应包含文件名，因为将自动生成唯一 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');

NOTE

有关 Laravel 中文件存储的更多信息，请查看完整的文件存储文档。

配置受信任的代理

在终止 TLS / SSL 证书的负载均衡器后面运行应用程序时，你可能会注意到应用程序在使用 url 辅助函数时有时不会生成 HTTPS 链接。通常，这是因为你的应用程序正在从端口 80 上的负载均衡器转发流量，并且不知道它应该生成安全链接。

要解决此问题，你可以启用 Laravel 应用程序中包含的 Illuminate\Http\Middleware\TrustProxies middleware，它允许你快速自定义应用程序应信任的负载均衡器或代理。你的受信任代理应在应用程序的 bootstrap/app.php 文件中使用 trustProxies middleware 方法指定：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustProxies(at: [
        '192.168.1.1',
        '10.0.0.0/8',
    ]);
})

除了配置受信任的代理之外，你还可以配置应该信任的代理头：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustProxies(headers: Request::HEADER_X_FORWARDED_FOR |
        Request::HEADER_X_FORWARDED_HOST |
        Request::HEADER_X_FORWARDED_PORT |
        Request::HEADER_X_FORWARDED_PROTO |
        Request::HEADER_X_FORWARDED_AWS_ELB
    );
})

NOTE

如果你使用 AWS Elastic Load Balancing，headers 值应为 Request::HEADER_X_FORWARDED_AWS_ELB。如果你的负载均衡器使用 RFC 7239 中的标准 Forwarded 头，headers 值应为 Request::HEADER_FORWARDED。有关可用于 headers 值的常量的更多信息，请查看 Symfony 关于信任代理的文档。

信任所有代理

如果你使用 Amazon AWS 或其他「云」负载均衡器提供商，你可能不知道实际均衡器的 IP 地址。在这种情况下，你可以使用 * 来信任所有代理：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustProxies(at: '*');
})

配置受信任的主机

默认情况下，Laravel 将响应它收到的所有请求，而不管 HTTP 请求的 Host 头的内容如何。此外，在 Web 请求期间生成到应用程序的绝对 URL 时，将使用 Host 头的值。

通常，你应该配置 Web 服务器（如 Nginx 或 Apache），使其只将与给定主机名匹配的请求发送到你的应用程序。但是，如果你无法直接自定义 Web 服务器，并且需要指示 Laravel 仅响应某些主机名，你可以通过为应用程序启用 Illuminate\Http\Middleware\TrustHosts middleware 来实现。

要启用 TrustHosts middleware，你应该在应用程序的 bootstrap/app.php 文件中调用 trustHosts middleware 方法。使用此方法的 at 参数，你可以指定应用程序应响应的主机名。主机名字符串被视为正则表达式。带有其他 Host 头的传入请求将被拒绝：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustHosts(at: ['^laravel\.test$']);
})

默认情况下，来自应用程序 URL 子域的请求也会自动被信任。如果你想禁用此行为，可以使用 subdomains 参数：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustHosts(at: ['^laravel\.test$'], subdomains: false);
})

如果你需要访问应用程序的配置文件或数据库来确定受信任的主机，可以向 at 参数提供闭包：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->trustHosts(at: fn () => config('app.trusted_hosts'));
})