URL 生成 – 乌鸦嘴文档中心

简介

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

基础内容

生成 URL

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

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

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

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

要生成带有查询字符串参数的 URL，您可以使用 query 方法：

echo url()->query('/posts', ['search' => 'Laravel']);

// https://example.com/posts?search=Laravel

echo url()->query('/posts?sort=latest', ['search' => 'Laravel']);

// http://example.com/posts?sort=latest&search=Laravel

如果提供的查询字符串参数已经存在于路径中，它们将覆盖其现有值：

echo url()->query('/posts?sort=latest', ['sort' => 'oldest']);

// http://example.com/posts?sort=oldest

也可以将值数组作为查询参数传递。这些值将在生成的 URL 中正确地进行键值编码：

echo $url = url()->query('/posts', ['columns' => ['title', 'body']]);

// http://example.com/posts?columns%5B0%5D=title&columns%5B1%5D=body

echo urldecode($url);

// http://example.com/posts?columns[0]=title&columns[1]=body

访问当前 URL

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

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

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

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

这些方法中的每一个也可以通过 URL 外观进行访问：

use Illuminate\Support\Facades\URL;

echo URL::current();

命名路由的 URL

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

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

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

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

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

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

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 的查询字符串中：

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

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

Eloquent 模型

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

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

签名 URL

Laravel 允许您轻松地为命名路由创建“签名”URL。这些 URL 在查询字符串中附加了一个“签名”哈希值，这使得 Laravel 能够验证该 URL 自创建以来未被修改。签名 URL 对于公众可访问但需要一层防止 URL 操作的保护的路由特别有用。

例如，您可以使用签名 URL 来实现向您的客户发送电子邮件的公共“取消订阅”链接。要为命名路由创建签名 URL，请使用 URL 外观的 signedRoute 方法：

use Illuminate\Support\Facades\URL;

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

您可以通过向 signedRoute 方法提供 absolute 参数来从签名 URL 哈希中排除域名：

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

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

use Illuminate\Support\Facades\URL;

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

验证签名路由请求

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

use Illuminate\Http\Request;

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

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

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

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

您可以将 signed（Illuminate\Routing\Middleware\ValidateSignature）中间件分配给路由，而不是使用传入的请求实例来验证签名 URL。如果传入的请求没有有效的签名，中间件将自动返回 403 HTTP 响应：

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

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

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

对无效签名路由的响应

当有人访问已过期的签名 URL 时，他们将收到针对 403 HTTP 状态码的通用错误页面。然而，您可以通过在应用程序的 bootstrap/app.php 文件中为 InvalidSignatureException 异常定义一个自定义的“渲染”闭包来定制此行为：

use Illuminate\Routing\Exceptions\InvalidSignatureException;

->withExceptions(function (Exceptions $exceptions) {
    $exceptions->render(function (InvalidSignatureException $e) {
        return response()->view('errors.link-expired', status: 403);
    });
})

控制器操作的 URL

action 函数为给定的控制器操作生成一个 URL：

use App\Http\Controllers\HomeController;

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

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

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

默认值

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

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

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

<?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 对隐式模型绑定的处理。因此，您应该为中间件设置优先级，将设置 URL 默认值的中间件设置为在 Laravel 自己的 SubstituteBindings 中间件之前执行。您可以在应用程序的 bootstrap/app.php 文件中使用 priority 中间件方法来实现此目的：

->withMiddleware(function (Middleware $middleware) {
    $middleware->priority([
        \Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests::class,
        \Illuminate\Cookie\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class,
        \Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests::class,
        \Illuminate\Routing\Middleware\ThrottleRequests::class,
        \Illuminate\Routing\Middleware\ThrottleRequestsWithRedis::class,
        \Illuminate\Session\Middleware\AuthenticateSession::class,
        \App\Http\Middleware\SetDefaultLocaleForUrls::class, // [tl! add]
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        \Illuminate\Auth\Middleware\Authorize::class,
    ]);
})

资源打包（Vite）HTTP 会话