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 的信息：

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

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

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

// 获取上一个请求的路径...
echo url()->previousPath();

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

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 facade 的 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->prependToPriorityList(
        before: \Illuminate\Routing\Middleware\SubstituteBindings::class,
        prepend: \App\Http\Middleware\SetDefaultLocaleForUrls::class,
    );
})