URL 生成

介绍
基础
- 生成 URL
- 访问当前 URL
命名路由的 URL
- 签名 URL
控制器动作的 URL
默认值

介绍

Laravel 提供了几个助手函数来帮助您为应用程序生成 URL。这些助手函数在构建模板和 API 响应中的链接时，或在生成重定向响应到应用程序的其他部分时特别有用。

基础

生成 URL

url 助手可以用来为您的应用程序生成任意 URL。生成的 URL 将自动使用当前请求处理的方案（HTTP 或 HTTPS）和主机：

php

$post = App\Models\Post::find(1);

echo url("/posts/{$post->id}");

// http://example.com/posts/1

访问当前 URL

如果没有为 url 助手提供路径，则返回一个 Illuminate\Routing\UrlGenerator 实例，允许您访问有关当前 URL 的信息：

php

// 获取不带查询字符串的当前 URL...
echo url()->current();

// 获取包含查询字符串的当前 URL...
echo url()->full();

// 获取上一个请求的完整 URL...
echo url()->previous();

这些方法也可以通过 URL facade 访问：

php

use Illuminate\Support\Facades\URL;

echo URL::current();

命名路由的 URL

route 助手可以用来生成命名路由的 URL。命名路由允许您生成 URL 而不与路由上定义的实际 URL 耦合。因此，如果路由的 URL 更改，则无需更改对 route 函数的调用。例如，假设您的应用程序包含如下定义的路由：

php

Route::get('/post/{post}', function (Post $post) {
    // ...
})->name('post.show');

要生成此路由的 URL，您可以像这样使用 route 助手：

php

echo route('post.show', ['post' => 1]);

// http://example.com/post/1

当然，route 助手也可以用来为具有多个参数的路由生成 URL：

php

Route::get('/post/{post}/comment/{comment}', function (Post $post, Comment $comment) {
    // ...
})->name('comment.show');

echo route('comment.show', ['post' => 1, 'comment' => 3]);

// http://example.com/post/1/comment/3

任何不对应于路由定义参数的额外数组元素将被添加到 URL 的查询字符串中：

php

echo route('post.show', ['post' => 1, 'search' => 'rocket']);

// http://example.com/post/1?search=rocket

Eloquent 模型

您通常会使用 Eloquent 模型的路由键（通常是主键）生成 URL。为此，您可以将 Eloquent 模型作为参数值传递。route 助手将自动提取模型的路由键：

php

echo route('post.show', ['post' => $post]);

签名 URL

Laravel 允许您轻松创建指向命名路由的“签名” URL。这些 URL 在查询字符串中附加了一个“签名”哈希，允许 Laravel 验证 URL 自创建以来未被修改。签名 URL 对于需要防止 URL 操作的公开访问路由特别有用。

例如，您可以使用签名 URL 实现一个公共的“取消订阅”链接，并将其通过电子邮件发送给客户。要创建指向命名路由的签名 URL，请使用 URL facade 的 signedRoute 方法：

php

use Illuminate\Support\Facades\URL;

return URL::signedRoute('unsubscribe', ['user' => 1]);

您可以通过提供 absolute 参数来排除签名 URL 哈希中的域：

php

return URL::signedRoute('unsubscribe', ['user' => 1], absolute: false);

如果您想生成一个在指定时间后过期的临时签名路由 URL，可以使用 temporarySignedRoute 方法。当 Laravel 验证临时签名路由 URL 时，它将确保编码到签名 URL 中的过期时间戳未过期：

php

use Illuminate\Support\Facades\URL;

return URL::temporarySignedRoute(
    'unsubscribe', now()->addMinutes(30), ['user' => 1]
);

验证签名路由请求

要验证传入请求是否具有有效签名，您应在传入的 Illuminate\Http\Request 实例上调用 hasValidSignature 方法：

php

use Illuminate\Http\Request;

Route::get('/unsubscribe/{user}', function (Request $request) {
    if (! $request->hasValidSignature()) {
        abort(401);
    }

    // ...
})->name('unsubscribe');

有时，您可能需要允许应用程序的前端向签名 URL 附加数据，例如在执行客户端分页时。因此，您可以使用 hasValidSignatureWhileIgnoring 方法指定在验证签名 URL 时应忽略的请求查询参数。请记住，忽略参数允许任何人修改请求上的这些参数：

php

if (! $request->hasValidSignatureWhileIgnoring(['page', 'order'])) {
    abort(401);
}

除了使用传入请求实例验证签名 URL 外，您还可以将 Illuminate\Routing\Middleware\ValidateSignature 中间件分配给路由。如果尚未存在，您可以在 HTTP 内核的 $middlewareAliases 数组中为此中间件分配别名：

php

/**
 * 应用程序的中间件别名。
 *
 * 别名可用于方便地将中间件分配给路由和组。
 *
 * @var array<string, class-string|string>
 */
protected $middlewareAliases = [
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
];

注册中间件到内核后，您可以将其附加到路由。如果传入请求没有有效签名，中间件将自动返回 403 HTTP 响应：

php

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed');

如果您的签名 URL 不包含 URL 哈希中的域，则应为中间件提供 relative 参数：

php

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed:relative');

响应无效的签名路由

当有人访问已过期的签名 URL 时，他们将收到 403 HTTP 状态码的通用错误页面。但是，您可以通过在异常处理程序中为 InvalidSignatureException 异常定义自定义“可渲染”闭包来自定义此行为。此闭包应返回 HTTP 响应：

php

use Illuminate\Routing\Exceptions\InvalidSignatureException;

/**
 * 为应用程序注册异常处理回调。
 */
public function register(): void
{
    $this->renderable(function (InvalidSignatureException $e) {
        return response()->view('error.link-expired', [], 403);
    });
}

控制器动作的 URL

action 函数为给定的控制器动作生成 URL：

php

use App\Http\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

如果控制器方法接受路由参数，您可以将路由参数的关联数组作为函数的第二个参数传递：

php

$url = action([UserController::class, 'profile'], ['id' => 1]);

默认值

对于某些应用程序，您可能希望为某些 URL 参数指定请求范围的默认值。例如，假设您的许多路由定义了一个 {locale} 参数：

php

Route::get('/{locale}/posts', function () {
    // ...
})->name('post.index');

每次调用 route 助手时总是传递 locale 是很麻烦的。因此，您可以使用 URL::defaults 方法为此参数定义一个默认值，该值将在当前请求期间始终应用。您可能希望从路由中间件调用此方法，以便您可以访问当前请求：

php

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\URL;
use Symfony\Component\HttpFoundation\Response;

class SetDefaultLocaleForUrls
{
    /**
     * 处理传入请求。
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        URL::defaults(['locale' => $request->user()->locale]);

        return $next($request);
    }
}

一旦为 locale 参数设置了默认值，您在通过 route 助手生成 URL 时不再需要传递其值。

URL 默认值和中间件优先级

设置 URL 默认值可能会干扰 Laravel 对隐式模型绑定的处理。因此，您应该优先执行您的中间件，以便在 Laravel 自己的 SubstituteBindings 中间件之前设置 URL 默认值。您可以通过确保您的中间件在应用程序 HTTP 内核的 $middlewarePriority 属性中的 SubstituteBindings 中间件之前出现来实现这一点。

$middlewarePriority 属性在基类 Illuminate\Foundation\Http\Kernel 中定义。您可以从该类复制其定义并在应用程序的 HTTP 内核中覆盖它以进行修改：

php

/**
 * 中间件的优先级排序列表。
 *
 * 这会强制非全局中间件始终按给定顺序排列。
 *
 * @var array
 */
protected $middlewarePriority = [
    // ...
     \App\Http\Middleware\SetDefaultLocaleForUrls::class,
     \Illuminate\Routing\Middleware\SubstituteBindings::class,
     // ...
];

URL 生成 ​

介绍 ​

基础 ​

生成 URL ​

访问当前 URL ​

命名路由的 URL ​

Eloquent 模型 ​

签名 URL ​

验证签名路由请求 ​

响应无效的签名路由 ​

控制器动作的 URL ​

默认值 ​

URL 默认值和中间件优先级 ​