URL 生成

• 介绍
• 基础知识
  • 生成 URL
  • 访问当前 URL
• 命名路由的 URL
  • 签名 URL
• 控制器操作的 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 的信息。

// Get the current URL without the query string...
echo url()->current();
 
// Get the current URL including the query string...
echo url()->full();
 
// Get the full URL for the previous request...
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，请使用 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);
}

除了使用传入的请求实例验证签名 URL 外，你还可以将 signed (Illuminate\Routing\Middleware\ValidateSignature) 中间件 分配给路由。如果传入的请求没有有效的签名，中间件将自动返回 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 异常定义自定义的“render”闭包来定制此行为。

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
{
    /**
     * Handle an incoming request.
     *
     * @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, 
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        \Illuminate\Auth\Middleware\Authorize::class,
    ]);
})